Dial-in error

Emitted when the dial-in session encounters an error.

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-in session.

string

ID of the domain corresponding to this dial-in event.

string

The name of the room where dial-in error occurred.

string

string describing the error.

integer

The status code of the rejected SIP request (the REGISTER for dial-in). Only present when the failure was a SIP rejection. A 408 or 503 may be generated locally on a timeout or transport failure rather than sent by the far end.

string

The reason phrase that accompanied sip_status_code, e.g. "Forbidden". Only present when the failure was a SIP rejection.

{
  "version": "1.0.0",
  "type": "dialin.error",
  "id": "2868-dial-in-err-ff1e7130-7752-4304-9cf4-08d2583a41dc",
  "payload": {
    "domain_id": "04b89420-cf8b-4ea5-a428-02c40b0e2a59",
    "room": "my-dialin-room",
    "timestamp": "1728036639",
    "session_id": "ff1e7130-7752-4304-9cf4-08d2583a41dc",
    "error_msg": "Dialin failed with error: SIP registration failed. status code: 403 Forbidden.",
    "sip_status_code": 403,
    "sip_reason_phrase": "Forbidden"
  },
  "event_ts": 1728036639.433
}

​Common fields

​Payload

Common fields

Payload