Dial-out stopped

Emitted when the session with the remote party ends: the initiator stopped it via stopDialOut() or the REST API, the remote party hung up, or the callee never answered. With the default "signalwire" provider an unanswered dial-out (busy, declined, unreachable) ends with this event and the payload carries the callee’s SIP status; with "daily" the same outcome is reported as dialout.error instead. See unanswered dial-outs by provider.

Common fields

string

Represents the version of the event. Uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.

string

Represents the type of the event described in the payload.

string

An identifier representing this specific event.

object

An object representing the event, whose fields are described below.

number

Documenting when the webhook itself was sent. This timestamp is different than the time of the event the webhook describes.

Payload

integer

The Unix epoch time in seconds representing when this event occurred.

string

The sessionId of the dial-out session.

string

The userId of the dial-out session (if supplied during the API call).

string

ID of the domain for which the dial-out stopped.

string

The name of the room where the dial-out stopped.

string

The phone number or SIP URI that was dialed.

string

The originating phone number or SIP URI.

string

The display name of the dial-out participant.

string

The callerId passed when starting the dial-out, if one was supplied: the ID of a purchased phone number.

string

The SIP provider handling the dial-out: "signalwire" or "daily". See SIP providers.

string

The call ID of the dial-out call leg, if available. On the Daily SIP provider this is the SIP Call-ID; on SignalWire it is SignalWire’s SID for the SIP leg between Daily and SignalWire.

integer

"signalwire" provider only. The SIP status code with which the callee ended the call before answering, e.g. 486 (busy), 603 (declined), 404 (not found). Absent when the callee answered and later hung up, when the session was stopped through the API, and after a call transfer. Best-effort: it can also be absent for an unanswered call when SignalWire’s call record is not available in time, so a missing code does not mean the callee answered.

string

The standard reason phrase for sip_status_code (RFC 3261), e.g. "Busy Here". It is derived from the code, not the phrase the callee sent. Present only with sip_status_code.

PhoneNumber Dialout Payload

{
  "version": "1.0.0",
  "type": "dialout.stopped",
  "id": "2868-dial-out-stop-7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
  "payload": {
    "domain_id": "04b89420-cf8b-4ea5-a428-02c40b0e2a59",
    "room": "my-dialout-room",
    "timestamp": "1728023426",
    "session_id": "7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
    "destination": "+12098888888",
    "origin": "+13977888822",
    "caller_id": "34b0eb2b-4f6d-41e2-8189-c836e830ffbb",
    "provider": "signalwire",
    "sip_call_id": "96645cdc-208c-4362-a1bd-966030fa8c6f"
  },
  "event_ts": 1728023426.552
}

SipUri Dialout Payload

{
  "version": "1.0.0",
  "type": "dialout.stopped",
  "id": "2868-dial-out-stop-7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
  "payload": {
    "domain_id": "04b89420-cf8b-4ea5-a428-02c40b0e2a59",
    "room": "my-dialout-room",
    "timestamp": "1728023426",
    "session_id": "7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
    "destination": "sip:abc@efg.dummy.com",
    "origin": "sip:myroom.0@daily-2358023-app.dapp.signalwire.com",
    "provider": "signalwire",
    "sip_call_id": "908d6596-431d-4b17-95fb-cecede9272b3"
  },
  "event_ts": 1728023426.552
}

Unanswered Dialout Payload (SignalWire)

{
  "version": "1.0.0",
  "type": "dialout.stopped",
  "id": "2868-dial-out-stop-7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
  "payload": {
    "domain_id": "04b89420-cf8b-4ea5-a428-02c40b0e2a59",
    "room": "my-dialout-room",
    "timestamp": "1728023426",
    "session_id": "7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
    "destination": "+12098888888",
    "origin": "+13977888822",
    "caller_id": "34b0eb2b-4f6d-41e2-8189-c836e830ffbb",
    "provider": "signalwire",
    "sip_call_id": "fe14b7b0-357b-4f42-972b-d1c58e3051b5",
    "sip_status_code": 486,
    "sip_reason_phrase": "Busy Here"
  },
  "event_ts": 1728023426.552
}