Swml Service

1
from signalwire_agents.core.swml_service import SWMLService
2
3
class SWMLService:
4
    """Base class for creating and serving SWML documents."""

1
SWMLService(
2
    name: str,                              # Service name (required)
3
    route: str = "/",                       # HTTP route path
4
    host: str = "0.0.0.0",                  # Host to bind
5
    port: int = 3000,                       # Port to bind
6
    basic_auth: Optional[Tuple[str, str]] = None,  # (username, password)
7
    schema_path: Optional[str] = None,      # SWML schema path
8
    config_file: Optional[str] = None       # Config file path
9
)

1
def reset_document(self) -> None

1
def add_verb(
2
    self,
3
    verb_name: str,           # Verb name (e.g., "ai", "play")
4
    params: Dict[str, Any]    # Verb parameters
5
) -> 'SWMLService'

1
def get_document(self) -> Dict[str, Any]

1
def render(self) -> str

1
## These methods are auto-generated from schema
2
service.ai(...)          # AI verb
3
service.play(...)        # Play audio
4
service.record(...)      # Record audio
5
service.connect(...)     # Connect call
6
service.transfer(...)    # Transfer call
7
service.hangup(...)      # End call
8
service.sleep(...)       # Pause execution
9
## ... many more

1
def run(
2
    self,
3
    host: str = None,  # Override host
4
    port: int = None   # Override port
5
) -> None

1
def get_app(self) -> FastAPI

1
def get_basic_auth_credentials(self) -> Tuple[str, str]

1
def _build_full_url(
2
    self,
3
    endpoint: str = "",           # Endpoint path
4
    include_auth: bool = False    # Include credentials
5
) -> str

1
def _build_webhook_url(
2
    self,
3
    endpoint: str,                    # Endpoint path
4
    query_params: Dict[str, str] = None  # Query parameters
5
) -> str

1
def register_routing_callback(
2
    self,
3
    callback: Callable,   # Routing callback
4
    path: str = "/"       # Path to register
5
) -> None

1
## Access schema utilities
2
service.schema_utils.validate(document)
3
service.schema_utils.get_all_verb_names()
4
service.schema_utils.get_verb_schema("ai")

1
## Access verb registry
2
service.verb_registry.register_handler("custom_verb", handler)
3
service.verb_registry.get_handler("ai")

1
from signalwire_agents.core.swml_service import SWMLService
2
3
4
## Create a basic SWML service
5
service = SWMLService(
6
    name="my-service",
7
    route="/swml",
8
    port=8080
9
)
10
11
## Add verbs to build a document
12
service.reset_document()
13
service.play(url="https://example.com/welcome.mp3")
14
service.ai(
15
    prompt={"text": "You are a helpful assistant"},
16
    SWAIG={"functions": []}
17
)
18
19
## Get the rendered SWML
20
swml_json = service.render()
21
print(swml_json)