Initiate Call

Initiate an outbound notification call.

The call will be made asynchronously. If callback_url is provided,
results will be POSTed there when the call completes.

Calls are queued and processed sequentially to prevent overwhelming the SIP system.

Note: callback_url is required when using choice collection.

Simple notification example:

{
    "message": "Hello, this is a reminder about your appointment.",
    "extension": "1001"
}

Choice collection example (requires callback_url):

{
    "message": "Hello, this is a reminder about your appointment tomorrow at 2pm.",
    "extension": "1001",
    "callback_url": "https://example.com/webhook",
    "choice": {
        "prompt": "Say yes to confirm or no to cancel.",
        "options": [
            {"value": "confirmed", "synonyms": ["yes", "yeah", "yep", "confirm"]},
            {"value": "cancelled", "synonyms": ["no", "nope", "cancel"]}
        ],
        "timeout_seconds": 15
    }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to initiate an outbound notification call.

string
required

Message to speak to the recipient

string
required

SIP extension or phone number to call

Webhook URL to POST results to (required if choice is specified)

integer
Defaults to 30

Seconds to wait for call to be answered

ChoicePrompt | null

Optional choice prompt for collecting response

Optional caller-provided ID for tracking

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json