Dial-out error

Emitted when the dial-out session encounters an error when connecting to a call.

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 dial-out has error.

string

The name of the room where dial-out has error.

string

message describing the error

string

The SIP/PSTN provider handling the dial-out (e.g. "daily").

string

The SIP Call-ID of the dial-out call leg, if available.

object

The custom X- SIP headers returned by the remote SIP endpoint when it rejected the dial-out, useful for debugging and error interpretation. Only present when the rejection response carried such headers.

{
  "version": "1.0.0",
  "type": "dialout.error",
  "id": "2868-dial-out-err-22b32b65-cd65-42b2-9665-db05ef3e1255",
  "payload": {
    "domain_id": "04b89420-cf8b-4ea5-a428-02c40b0e2a59",
    "room": "my-dialout-room",
    "timestamp": "1728025068",
    "session_id": "22b32b65-cd65-42b2-9665-db05ef3e1255",
    "user_id": null,
    "error_msg": "DialOut failed with error: process error, Channel closed).",
    "provider": "daily",
    "sip_headers": { "X-Reason": "user busy" }
  },
  "event_ts": 1728025068.748
}

​Common fields

​Payload

Common fields

Payload