<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
Telnyx Voice Conferencing - Ruby
Installation
Setup
ruby
require "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)
All examples below assume
is already initialized as shown above.
Error Handling
All API calls can fail with network errors, rate limits (429), validation errors (422),
or authentication errors (401). Always handle errors in production code:
ruby
begin
result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
puts "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
# 429: rate limited — wait and retry with exponential backoff
sleep(1) # Check Retry-After header for actual delay
rescue Telnyx::Errors::APIStatusError => e
puts "API error #{e.status}: #{e.message}"
if e.status == 422
puts "Validation error — check required fields and formats"
end
end
Common error codes:
invalid API key,
insufficient permissions,
resource not found,
validation error (check field formats),
rate limited (retry with exponential backoff).
Important Notes
- Pagination: Use for automatic iteration:
page.auto_paging_each { |item| puts item.id }
Enqueue call
Put the call in a queue.
POST /calls/{call_control_id}/actions/enqueue
— Required:
Optional:
(string),
(string),
(boolean),
(integer),
(integer)
ruby
response = client.calls.actions.enqueue("call_control_id", queue_name: "support")
puts(response)
Remove call from a queue
Removes the call from a queue.
POST /calls/{call_control_id}/actions/leave_queue
Optional:
(string),
(string)
ruby
response = client.calls.actions.leave_queue("v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ")
puts(response)
List conferences
Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by
.
ruby
page = client.conferences.list
puts(page)
Returns:
(string),
(string),
(enum: all_left, ended_via_api, host_left, time_exceeded),
(object),
(string),
(string),
(string),
(enum: conference),
(string),
(enum: init, in_progress, completed),
(string)
Create conference
Create a conference from an existing call leg using a
and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.
Optional:
(enum: always, never, on_enter, on_exit),
(string),
(boolean),
(string),
(integer),
(string),
(string),
(integer),
(enum: Australia, Europe, Middle East, US),
start_conference_on_create
(boolean)
ruby
conference = client.conferences.create(
call_control_id: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
name: "Business"
)
puts(conference)
Returns:
(string),
(string),
(enum: all_left, ended_via_api, host_left, time_exceeded),
(object),
(string),
(string),
(string),
(enum: conference),
(string),
(enum: init, in_progress, completed),
(string)
List conference participants
Lists conference participants
GET /conferences/{conference_id}/participants
ruby
page = client.conferences.list_participants("550e8400-e29b-41d4-a716-446655440000")
puts(page)
Returns:
(string),
(string),
(object),
(string),
(boolean),
(string),
(boolean),
(boolean),
(enum: participant),
soft_end_conference_on_exit
(boolean),
(enum: joining, joined, left),
(string),
(array[string])
Retrieve a conference
Retrieve an existing conference
ruby
conference = client.conferences.retrieve("550e8400-e29b-41d4-a716-446655440000")
puts(conference)
Returns:
(string),
(string),
(enum: all_left, ended_via_api, host_left, time_exceeded),
(object),
(string),
(string),
(string),
(enum: conference),
(string),
(enum: init, in_progress, completed),
(string)
End a conference
End a conference and terminate all active participants.
POST /conferences/{id}/actions/end
ruby
response = client.conferences.actions.end_conference("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
puts(response)
Gather DTMF using audio prompt in a conference
Play an audio file to a specific conference participant and gather DTMF input.
POST /conferences/{id}/actions/gather_using_audio
— Required:
Optional:
(string),
(string),
(string),
(integer),
inter_digit_timeout_millis
(integer),
(string),
(string),
(integer),
(integer),
(string),
(integer),
(boolean),
(string),
(integer),
(string)
ruby
response = client.conferences.actions.gather_dtmf_audio(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
call_control_id: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
)
puts(response)
Hold conference participants
Hold a list of participants in a conference call
POST /conferences/{id}/actions/hold
Optional:
(string),
(array[string]),
(string),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.hold("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Join a conference
Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the
of the leg you wish to join to the conference as an attribute. The conference can have up to a certain amount of active participants, as set by the
parameter in conference creation request.
POST /conferences/{id}/actions/join
— Required:
Optional:
(enum: always, never, on_enter, on_exit),
(string),
(string),
(boolean),
(boolean),
(string),
(string),
(boolean),
(enum: Australia, Europe, Middle East, US),
soft_end_conference_on_exit
(boolean),
start_conference_on_enter
(boolean),
(enum: barge, monitor, none, whisper),
(array[string])
ruby
response = client.conferences.actions.join(
"id",
call_control_id: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
)
puts(response)
Leave a conference
Removes a call leg from a conference and moves it back to parked state. Expected Webhooks:
conference.participant.left
POST /conferences/{id}/actions/leave
— Required:
Optional:
(enum: always, never, on_enter, on_exit),
(string),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.leave("id", call_control_id: "c46e06d7-b78f-4b13-96b6-c576af9640ff")
puts(response)
Mute conference participants
Mute a list of participants in a conference call
POST /conferences/{id}/actions/mute
Optional:
(array[string]),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.mute("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Play audio to conference participants
Play audio to all or some participants on a conference call.
POST /conferences/{id}/actions/play
Optional:
(string),
(array[string]),
(string),
(string),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.play("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Conference recording pause
Pause conference recording.
POST /conferences/{id}/actions/record_pause
Optional:
(string),
(string),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.record_pause("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Conference recording resume
Resume conference recording.
POST /conferences/{id}/actions/record_resume
Optional:
(string),
(string),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.record_resume("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Conference recording start
Start recording the conference. Recording will stop on conference end, or via the Stop Recording command. Expected Webhooks:
conference.recording.saved
POST /conferences/{id}/actions/record_start
— Required:
Optional:
(enum: single, dual),
(string),
(string),
(boolean),
(enum: Australia, Europe, Middle East, US),
(enum: trim-silence)
ruby
response = client.conferences.actions.record_start("id", format_: :wav)
puts(response)
Conference recording stop
Stop recording the conference. Expected Webhooks:
conference.recording.saved
POST /conferences/{id}/actions/record_stop
Optional:
(string),
(string),
(uuid),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.record_stop("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Send DTMF to conference participants
Send DTMF tones to one or more conference participants.
POST /conferences/{id}/actions/send_dtmf
— Required:
Optional:
(array[string]),
(string),
(integer)
ruby
response = client.conferences.actions.send_dtmf("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", digits: "1234#")
puts(response)
Speak text to conference participants
Convert text to speech and play it to all or some participants.
POST /conferences/{id}/actions/speak
— Required:
,
Optional:
(array[string]),
(string),
(enum: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, is-IS, it-IT, ja-JP, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR),
(enum: text, ssml),
(enum: Australia, Europe, Middle East, US),
(object)
ruby
response = client.conferences.actions.speak("id", payload: "Say this to participants", voice: "female")
puts(response)
Stop audio being played on the conference
Stop audio being played to all or some participants on a conference call.
POST /conferences/{id}/actions/stop
Optional:
(array[string]),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.stop("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Unhold conference participants
Unhold a list of participants in a conference call
POST /conferences/{id}/actions/unhold
— Required:
Optional:
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.unhold(
"id",
call_control_ids: ["v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"]
)
puts(response)
Unmute conference participants
Unmute a list of participants in a conference call
POST /conferences/{id}/actions/unmute
Optional:
(array[string]),
(enum: Australia, Europe, Middle East, US)
ruby
response = client.conferences.actions.unmute("550e8400-e29b-41d4-a716-446655440000")
puts(response)
Update conference participant
Update conference participant supervisor_role
POST /conferences/{id}/actions/update
— Required:
,
Optional:
(string),
(enum: Australia, Europe, Middle East, US),
(array[string])
ruby
action = client.conferences.actions.update(
"id",
call_control_id: "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
supervisor_role: :whisper
)
puts(action)
Retrieve a conference participant
Retrieve details of a specific conference participant by their ID or label.
GET /conferences/{id}/participants/{participant_id}
ruby
response = client.conferences.retrieve_participant("participant_id", id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
puts(response)
Returns:
(string),
(string),
(string),
(date-time),
(boolean),
(string),
(string),
(boolean),
(boolean),
soft_end_conference_on_exit
(boolean),
(enum: joining, joined, left),
(date-time),
(array[string])
Update a conference participant
Update properties of a conference participant.
PATCH /conferences/{id}/participants/{participant_id}
Optional:
(enum: always, never, on_enter, on_exit),
(boolean),
soft_end_conference_on_exit
(boolean)
ruby
response = client.conferences.update_participant("participant_id", id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
puts(response)
Returns:
(string),
(string),
(string),
(date-time),
(boolean),
(string),
(string),
(boolean),
(boolean),
soft_end_conference_on_exit
(boolean),
(enum: joining, joined, left),
(date-time),
(array[string])
List queues
List all queues for the authenticated user.
ruby
page = client.queues.list
puts(page)
Returns:
(integer),
(string),
(integer),
(string),
(integer),
(string),
(enum: queue),
(string)
Create a queue
Create a new call queue.
ruby
queue = client.queues.create(queue_name: "tier_1_support")
puts(queue)
Returns:
(integer),
(string),
(integer),
(string),
(integer),
(string),
(enum: queue),
(string)
Retrieve a call queue
Retrieve an existing call queue
ruby
queue = client.queues.retrieve("queue_name")
puts(queue)
Returns:
(integer),
(string),
(integer),
(string),
(integer),
(string),
(enum: queue),
(string)
Update a queue
Update properties of an existing call queue.
POST /queues/{queue_name}
— Required:
ruby
queue = client.queues.update("queue_name", max_size: 200)
puts(queue)
Returns:
(integer),
(string),
(integer),
(string),
(integer),
(string),
(enum: queue),
(string)
Delete a queue
Delete an existing call queue.
DELETE /queues/{queue_name}
ruby
result = client.queues.delete("queue_name")
puts(result)
Retrieve calls from a queue
Retrieve the list of calls in an existing queue
GET /queues/{queue_name}/calls
ruby
page = client.queues.calls.list("queue_name")
puts(page)
Returns:
(string),
(string),
(string),
(string),
(string),
(string),
(boolean),
(string),
(integer),
(enum: queue_call),
(string),
(integer)
Retrieve a call from a queue
Retrieve an existing call from an existing queue
GET /queues/{queue_name}/calls/{call_control_id}
ruby
call = client.queues.calls.retrieve("call_control_id", queue_name: "my-queue")
puts(call)
Returns:
(string),
(string),
(string),
(string),
(string),
(string),
(boolean),
(string),
(integer),
(enum: queue_call),
(string),
(integer)
Update queued call
Update queued call's keep_after_hangup flag
PATCH /queues/{queue_name}/calls/{call_control_id}
ruby
result = client.queues.calls.update("call_control_id", queue_name: "my-queue")
puts(result)
Force remove a call from a queue
Removes an inactive call from a queue. If the call is no longer active, use this command to remove it from the queue.
DELETE /queues/{queue_name}/calls/{call_control_id}
ruby
result = client.queues.calls.remove("call_control_id", queue_name: "my-queue")
puts(result)
Webhooks
Webhook Verification
Telnyx signs webhooks with Ed25519. Each request includes
and
headers. Always verify signatures in production:
ruby
# In your webhook handler (e.g., Sinatra — use raw body):
post "/webhooks" do
payload = request.body.read
headers = {
"telnyx-signature-ed25519" => request.env["HTTP_TELNYX_SIGNATURE_ED25519"],
"telnyx-timestamp" => request.env["HTTP_TELNYX_TIMESTAMP"],
}
begin
event = client.webhooks.unwrap(payload, headers)
rescue => e
halt 400, "Invalid signature: #{e.message}"
end
# Signature valid — event is the parsed webhook payload
puts "Received event: #{event.data.event_type}"
status 200
end
The following webhook events are sent to your configured webhook URL.
All webhooks include
and
headers for Ed25519 signature verification. Use
to verify.
| Event | Description |
|---|
| Call Enqueued |
| Call Left Queue |
| Conference Created |
| Conference Ended |
| Conference Floor Changed |
conferenceParticipantJoined
| Conference Participant Joined |
conferenceParticipantLeft
| Conference Participant Left |
conferenceParticipantPlaybackEnded
| Conference Participant Playback Ended |
conferenceParticipantPlaybackStarted
| Conference Participant Playback Started |
conferenceParticipantSpeakEnded
| Conference Participant Speak Ended |
conferenceParticipantSpeakStarted
| Conference Participant Speak Started |
| Conference Playback Ended |
conferencePlaybackStarted
| Conference Playback Started |
| Conference Recording Saved |
| Conference Speak Ended |
| Conference Speak Started |
Webhook payload fields
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: call.enqueued | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id
| string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
| string | The name of the queue |
data.payload.current_position
| integer | Current position of the call in the queue. |
data.payload.queue_avg_wait_time_secs
| integer | Average time call spends in the queue in seconds. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: call.dequeued | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id
| string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
| string | The name of the queue |
data.payload.queue_position
| integer | Last position of the call in the queue. |
| enum: bridged, bridging-in-process, hangup, leave, timeout | The reason for leaving the queue |
data.payload.wait_time_secs
| integer | Time call spent in the queue in seconds. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.created | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.conference_id
| string | Conference ID that the participant joined. |
| date-time | ISO 8601 datetime of when the event occurred. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.ended | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.conference_id
| string | Conference ID that the participant joined. |
| date-time | ISO 8601 datetime of when the event occurred. |
| enum: all_left, host_left, time_exceeded | Reason the conference ended. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.floor.changed | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| string | Call Control ID of the new speaker. |
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | Call Leg ID of the new speaker. |
| string | Call Session ID of the new speaker. |
| string | State received from a command. |
| string | Conference ID that had a speaker change event. |
| date-time | ISO 8601 datetime of when the event occurred. |
conferenceParticipantJoined
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.participant.joined | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id
| string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.conference_id
| string | Conference ID that the participant joined. |
conferenceParticipantLeft
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.participant.left | The type of event being delivered. |
| uuid | Identifies the type of resource. |
| date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id
| string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.conference_id
| string | Conference ID that the participant joined. |
conferenceParticipantPlaybackEnded
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.participant.playback.ended | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Participant's call ID used to issue commands via Call Control API. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| string | The audio URL being played back, if audio_url has been used to start. |
| string | The name of the audio media file being played back, if media_name has been used to start. |
| date-time | ISO 8601 datetime of when the event occurred. |
conferenceParticipantPlaybackStarted
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.participant.playback.started | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Participant's call ID used to issue commands via Call Control API. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| string | The audio URL being played back, if audio_url has been used to start. |
| string | The name of the audio media file being played back, if media_name has been used to start. |
| date-time | ISO 8601 datetime of when the event occurred. |
conferenceParticipantSpeakEnded
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.participant.speak.ended | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Participant's call ID used to issue commands via Call Control API. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| date-time | ISO 8601 datetime of when the event occurred. |
conferenceParticipantSpeakStarted
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.participant.speak.started | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Participant's call ID used to issue commands via Call Control API. |
| string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| date-time | ISO 8601 datetime of when the event occurred. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.playback.ended | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| string | The audio URL being played back, if audio_url has been used to start. |
| string | The name of the audio media file being played back, if media_name has been used to start. |
| date-time | ISO 8601 datetime of when the event occurred. |
conferencePlaybackStarted
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.playback.started | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| string | The audio URL being played back, if audio_url has been used to start. |
| string | The name of the audio media file being played back, if media_name has been used to start. |
| date-time | ISO 8601 datetime of when the event occurred. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.recording.saved | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.call_control_id
| string | Participant's call ID used to issue commands via Call Control API. |
data.payload.call_session_id
| string | ID that is unique to the call session and can be used to correlate webhook events. |
data.payload.client_state
| string | State received from a command. |
| enum: single, dual | Whether recording was recorded in or channel. |
data.payload.conference_id
| uuid | ID of the conference that is being recorded. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
| enum: wav, mp3 | The audio file format used when storing the call recording. |
data.payload.recording_ended_at
| date-time | ISO 8601 datetime of when recording ended. |
data.payload.recording_id
| uuid | ID of the conference recording. |
data.payload.recording_started_at
| date-time | ISO 8601 datetime of when recording started. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.speak.ended | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| date-time | ISO 8601 datetime of when the event occurred. |
| Field | Type | Description |
|---|
| enum: event | Identifies the type of the resource. |
| enum: conference.speak.started | The type of event being delivered. |
| uuid | Identifies the type of resource. |
data.payload.connection_id
| string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.creator_call_session_id
| string | ID that is unique to the call session that started the conference. |
data.payload.conference_id
| string | ID of the conference the text was spoken in. |
| date-time | ISO 8601 datetime of when the event occurred. |