For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Use StatusCallbackEvent to receive every call progress event — not just the final status —
along with current call state and all parameters below.
Status callbacks are advisory, best-effort notifications — delivery can be delayed or fail silently, so don’t gate time-critical actions on receiving one. See Status callback reliability.
Payload
The payload of this webhook request is an object.
AccountSidstringRequired
The unique ID of the project this call is associated with.
ApiVersionstringRequired
The version of the SignalWire API. Incoming calls use the API version placed on the number called. Outgoing calls use the version of the REST API request.
CallbackSourcestringRequired
The source of the status callback.
CallSidstringRequired
A unique identifier for the call.
CallStatusenumRequired
The status of the call.
Status
Description
initiated
The initial dial has begun.
ringing
The call is ringing.
in-progress
The call was answered and is in progress.
queued
The call is ready and in line to initiate.
failed
The call could not be completed. Usually occurs when the phone number does not exist. SignalWire also stops a call created through the REST API before dialing it when its caller ID is on the Do Not Originate registry, a spam rule blocks it, it exceeds the outbound call rate limit (ErrorCode20429), no endpoint is registered to receive it, or a temporary platform error interrupts it. Retrying usually succeeds after a temporary error.
busy
The caller encountered a busy signal.
no-answer
The call ended without an answer.
completed
The call was answered and ended normally.
canceled
The REST API canceled the call while it was ringing or queued.
DirectionenumRequired
The direction of the call.
outbound-dial: calls launched through the Dial verb.
outbound-api: calls launched through the REST API.
inbound: inbound calls.
Allowed values:
FromstringRequired
The phone number that sent this call, in E.164 format.
SequenceNumberintegerRequired
The order in which events occur, starting at 0. Although events are fired in order, they each take time and may not appear in the order you expect.
TimestampstringRequired
The timestamp, in RFC 2822 format, of when the event occurred.
TostringRequired
The phone number of the call recipient, in E.164 format.
AudioInAveragePtimeintegerOptional
The average time between packets for the inbound stream.
AudioInDtmfPacketCountintegerOptional
The number of DTMF packets in the inbound media stream.
AudioInFlushPacketCountintegerOptional
The number of incoming packets removed from the jitter buffer due to buffer overflow or underflow, causing these packets to be discarded or lost.
AudioInJitterMaxVarianceintegerOptional
The maximum variance of jitter for incoming audio RTP packets.
AudioInJitterMinVarianceintegerOptional
The minimum variance of jitter for incoming audio RTP packets.
AudioInLargestJbSizeintegerOptional
The largest jitter buffer size recorded for incoming audio RTP packets during the session.
AudioInMosstringOptional
A mean opinion score on a scale of 1–5 that helps determine audio quality.
AudioInMediaPacketCountintegerOptional
The number of audio packets received in the inbound media stream.
AudioInSkipPacketCountintegerOptional
Increased with every packet not received at a given ptime. Increases with every lost packet from the inbound stream.
AudioOutDtmfPacketCountintegerOptional
The total number of DTMF packets generated in the outbound media stream.
AudioOutMediaPacketCountintegerOptional
The number of audio packets sent in the outbound media stream.
CallDurationintegerOptional
The duration, in seconds, of the finished call. Only present on the completed event.
CallerNamestringOptional
The name of the caller. Only available if Caller ID lookup is enabled.
ErrorCodestringOptional
The code for why the call failed, when SignalWire has one. 20429 means the call exceeded the outbound call rate limit. See Error codes.
ErrorMessagestringOptional
The description of ErrorCode.
ForwardedFromstringOptional
The number this call was forwarded from.
ParentCallSidstringOptional
A unique identifier for the call that created this call.
RecordingDurationintegerOptional
The duration, in seconds, of the recording.
RecordingSidstringOptional
The unique identifier for the audio recording.
RecordingUrlstringOptional
The URL of the recorded audio call.
SipInviteResultPhrasestringOptional
A textual description of the result of the SIP INVITE request, indicating success or failure with additional details.
SipResultCodestringOptional
The numeric SIP response code received for the INVITE request, indicating the outcome of the call attempt. See the list of SIP response codes for possible values.
