Conference Webhooks

Conference Created Webhook

FIELD VALUE
call_control_id call id used to issue commands via call control API
call_leg_id ID that is unique to the call and can be used to correlate webhook events
call_session_id ID that is unique to the call session and can be used to correlate webhook events
client_state State received from a command
conference_id Conference ID that the participant left
connection_id Telnyx connection id used in the call
occurred_at ISO-8601 datetime of when the event occurred

Example

Copy
Copied
{
  "record_type": "event",
  "id": "f68d2ddf-75cd-4ed2-9b8b-68bff01727fc",
  "event_type": "conference_created",
  "created_at": "2019-11-08T13:39:52.523674Z",
  "payload": {
    "call_control_id": "AgDIxmoRX6QMuaIj_uXRXnPAXP0QlNfXczRrZvZakpWxBlpw48KyZQ==",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "conference_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "occurred_at": "2018-08-16T19:40:42.120274Z"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

Participant Join Webhook

FIELD VALUE
call_control_id call id used to issue commands via call control API
call_leg_id ID that is unique to the call and can be used to correlate webhook events
call_session_id ID that is unique to the call session and can be used to correlate webhook events
client_state State received from a command
conference_id Conference ID that the participant joined
connection_id Telnyx connection id used in the call
occurred_at ISO-8601 datetime of when the event occurred

Example

Copy
Copied
{
  "record_type": "event",
  "id": "76440f31-0301-4e21-b64b-afbc45e96b47",
  "event_type": "conference_join",
  "created_at": "2018-08-16T19:40:37.161465Z",
  "payload": {
    "call_control_id": "AgDIxmoRX6QMuaIj_uXRXnPAXP0QlNfXczRrZvZakpWxBlpw48KyZQ==",
    "call_leg_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1",
    "call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "occurred_at": "2018-08-16T19:40:36.840275Z"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

Participant Leave Webhook

FIELD VALUE
call_control_id call id used to issue commands via call control API
call_leg_id ID that is unique to the call and can be used to correlate webhook events
call_session_id ID that is unique to the call session and can be used to correlate webhook events
client_state State received from a command
conference_id Conference ID that the participant left
connection_id Telnyx connection id used in the call
occurred_at ISO-8601 datetime of when the event occurred

Example

Copy
Copied
{
  "record_type": "event",
  "id": "f45f34ff-36a8-499b-9ce3-511c5078160b",
  "event_type": "conference_leave",
  "created_at": "2018-08-16T19:40:42.706958Z",
  "payload": {
    "call_control_id": "AgDIxmoRX6QMuaIj_uXRXnPAXP0QlNfXczRrZvZakpWxBlpw48KyZQ==",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "conference_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "occurred_at": "2018-08-16T19:40:42.120274Z"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added

Conference Ended Webhook

FIELD VALUE
call_control_id call id used to issue commands via call control API
call_leg_id ID that is unique to the call and can be used to correlate webhook events
call_session_id ID that is unique to the call session and can be used to correlate webhook events
client_state State received from a command
conference_id Conference ID that the participant left
connection_id Telnyx connection id used in the call
occurred_at ISO-8601 datetime of when the event occurred
reason Reason the conference ended. Can be either "all_left", "host_left" or "time_exceeded".

Example

Copy
Copied
{
  "record_type": "event",
  "id": "f68d2ddf-75cd-4ed2-9b8b-68bff01727fc",
  "event_type": "conference_ended",
  "created_at": "2019-11-08T13:39:52.523674Z",
  "payload": {
    "call_control_id": "AgDIxmoRX6QMuaIj_uXRXnPAXP0QlNfXczRrZvZakpWxBlpw48KyZQ==",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "conference_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "occurred_at": "2018-08-16T19:40:42.120274Z",
    "reason": "all_left"
  }
}

Note: After pasting the above content, Kindly check and remove any new line added