For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
The Project ID that uniquely identifies the Account.
Request
TostringRequired
The address that received the call. Can be a phone number in E.164 format, a SIP URI, or a client identifier.
FromstringRequired
The address that initiated the call. Must be a phone number in E.164 format for PSTN calls.
UrlstringOptionalformat: "uri"
The URL to handle the call. Required if `ApplicationSid` and `Laml`/`Twiml` are not used.
ApplicationSidstringOptionalformat: "uuid"
The unique identifier of the application used to handle the call. Required if `Url` and `Laml`/`Twiml` are not used.
MethodenumOptionalDefaults to POST
Whether the request to `Url` is a `GET` or a `POST`. Default is `POST`.
Allowed values:
FallbackUrlstringOptionalformat: "uri"
The URL SignalWire will request if errors occur when fetching the `Url`.
FallbackMethodenumOptionalDefaults to POST
Whether the request to `FallbackUrl` is a `GET` or a `POST`. Default is `POST`.
Allowed values:
StatusCallbackstringOptionalformat: "uri"
The URL SignalWire will send webhooks to on every requested `StatusCallbackEvent` event. See the [Voice status callback](/docs/compatibility-api/rest/calls/webhooks/voice-status-callback) webhook for the payload your URL will receive.
StatusCallbackMethodenumOptionalDefaults to POST
Whether the request to `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
Allowed values:
StatusCallbackEventlist of stringsOptionalDefaults to ["completed"]
The status events that trigger a SignalWire webhook. Valid values: initiated, ringing, answered, completed, ringing_forwarded, ringing_queued. Defaults to `completed`.
CallerIdstringOptional
The number, in E.164 format, or identifier of the caller. Used to override the From for caller ID purposes.
The URL to request when recording is available. See the [Recording status callback](/docs/compatibility-api/rest/recordings/webhooks/recording-status-callback) webhook for the payload your URL will receive.
RecordingStatusCallbackMethodenumOptionalDefaults to POST
Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
Allowed values:
RecordingStatusCallbackEventstringOptionalDefaults to completed
The recording status events that trigger a webhook. Space-separated list. Valid values: completed, in-progress, absent. Default is `completed`.
TrimenumOptionalDefaults to trim-silence
Whether leading and trailing silence is trimmed from a recording. Default is `trim-silence`.
Allowed values:
SipAuthUsernamestringOptional
The username to authenticate the caller when making an outbound SIP call.
SipAuthPasswordstringOptional
The password to authenticate the caller when making an outbound SIP call.
SignalWire Docs