Get SWML Application

GET 
/resources/swml_applications/:id

Returns a SWML Application by ID.

Request

Path Parameters

id uuidrequired

The ID of the SWML Application

Responses

200

A SWML Application

application/json

Schema

Schema

id uuid
Example: 993ed018-9e79-4e50-b97b-984bd5534095
project_id uuid
Example: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
display_name string
Example: Reception
type string
Example: swml_application
created_at date-time
Example: 2024-01-02T00:00:00Z
updated_at date-time
Example: 2024-01-02T00:00:00Z

swml_application

object

id uuid

A unique identifier for the SWML Application

name string

Example: My SWML Application

handle_calls_using string

Possible values: [external_url, script]

Example: external_url

call_handler_url uri

Example: https://example.com/call_handler

call_handler_method string

Possible values: [GET, POST]

Example: POST

call_handler_fallback_url uri

Example: https://example.com/call_handler

call_handler_fallback_method string

Possible values: [GET, POST]

Example: POST

call_status_callback_url uri

Example: https://example.com/call_handler

call_status_callback_method string

Possible values: [GET, POST]

Example: POST

call_handler_script string

Example: {"version":"1.0.0","sections":{"main":[{"play":"say:Hello from SignalWire!"}]}}

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "swml_application",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "swml_application": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "My SWML Application",
    "handle_calls_using": "external_url",
    "call_handler_url": "https://example.com/call_handler",
    "call_handler_method": "POST",
    "call_handler_fallback_url": "https://example.com/call_handler",
    "call_handler_fallback_method": "POST",
    "call_status_callback_url": "https://example.com/call_handler",
    "call_status_callback_method": "POST",
    "call_handler_script": {
      "version": "1.0.0",
      "sections": {
        "main": [
          {
            "play": "say:Hello from SignalWire!"
          }
        ]
      }
    }
  }
}