Telnyx Voice Conferencing – Python

Installation

pip install telnyx

Setup

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)

All examples below assume client is already initialized as shown above.

Enqueue call

Put the call in a queue.

POST /calls/{call_control_id}/actions/enqueue — Required: queue_name

Optional: client_state (string), command_id (string), keep_after_hangup (boolean), max_size (integer), max_wait_time_secs (integer)

response = client.calls.actions.enqueue(
    call_control_id="call_control_id",
    queue_name="support",
)
print(response.data)

Remove call from a queue

Removes the call from a queue.

POST /calls/{call_control_id}/actions/leave_queue

Optional: client_state (string), command_id (string)

response = client.calls.actions.leave_queue(
    call_control_id="call_control_id",
)
print(response.data)

List conferences

Lists conferences.

GET /conferences

page = client.conferences.list()
page = page.data[0]
print(page.id)

Create conference

Create a conference from an existing call leg using a call_control_id and a conference name.

POST /conferences — Required: call_control_id, name

Optional: beep_enabled (enum), client_state (string), comfort_noise (boolean), command_id (string), duration_minutes (integer), hold_audio_url (string), hold_media_name (string), max_participants (integer), region (enum), start_conference_on_create (boolean)

conference = client.conferences.create(
    call_control_id="v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    name="Business",
)
print(conference.data)

Retrieve a conference

Retrieve an existing conference

GET /conferences/{id}

conference = client.conferences.retrieve(
    id="id",
)
print(conference.data)

Hold conference participants

Hold a list of participants in a conference call

POST /conferences/{id}/actions/hold

Optional: audio_url (string), call_control_ids (array[string]), media_name (string), region (enum)

response = client.conferences.actions.hold(
    id="id",
)
print(response.data)

Join a conference

Join an existing call leg to a conference.

POST /conferences/{id}/actions/join — Required: call_control_id

Optional: beep_enabled (enum), client_state (string), command_id (string), end_conference_on_exit (boolean), hold (boolean), hold_audio_url (string), hold_media_name (string), mute (boolean), region (enum), soft_end_conference_on_exit (boolean), start_conference_on_enter (boolean), supervisor_role (enum), whisper_call_control_ids (array[string])

response = client.conferences.actions.join(
    id="id",
    call_control_id="v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
)
print(response.data)

Leave a conference

Removes a call leg from a conference and moves it back to parked state.

POST /conferences/{id}/actions/leave — Required: call_control_id

Optional: beep_enabled (enum), command_id (string), region (enum)

response = client.conferences.actions.leave(
    id="id",
    call_control_id="c46e06d7-b78f-4b13-96b6-c576af9640ff",
)
print(response.data)

Mute conference participants

Mute a list of participants in a conference call

POST /conferences/{id}/actions/mute

Optional: call_control_ids (array[string]), region (enum)

response = client.conferences.actions.mute(
    id="id",
)
print(response.data)

Play audio to conference participants

Play audio to all or some participants on a conference call.

POST /conferences/{id}/actions/play

Optional: audio_url (string), call_control_ids (array[string]), loop (object), media_name (string), region (enum)

response = client.conferences.actions.play(
    id="id",
)
print(response.data)

Conference recording pause

Pause conference recording.

POST /conferences/{id}/actions/record_pause

Optional: command_id (string), recording_id (string), region (enum)

response = client.conferences.actions.record_pause(
    id="id",
)
print(response.data)

Conference recording resume

Resume conference recording.

POST /conferences/{id}/actions/record_resume

Optional: command_id (string), recording_id (string), region (enum)

response = client.conferences.actions.record_resume(
    id="id",
)
print(response.data)

Conference recording start

Start recording the conference.

POST /conferences/{id}/actions/record_start — Required: format

Optional: command_id (string), custom_file_name (string), play_beep (boolean), region (enum), trim (enum)

response = client.conferences.actions.record_start(
    id="id",
    format="wav",
)
print(response.data)

Conference recording stop

Stop recording the conference.

POST /conferences/{id}/actions/record_stop

Optional: client_state (string), command_id (string), recording_id (uuid), region (enum)

response = client.conferences.actions.record_stop(
    id="id",
)
print(response.data)

Speak text to conference participants

Convert text to speech and play it to all or some participants.

POST /conferences/{id}/actions/speak — Required: payload, voice

Optional: call_control_ids (array[string]), command_id (string), language (enum), payload_type (enum), region (enum), voice_settings (object)

response = client.conferences.actions.speak(
    id="id",
    payload="Say this to participants",
    voice="female",
)
print(response.data)

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: call_control_ids (array[string]), region (enum)

response = client.conferences.actions.stop(
    id="id",
)
print(response.data)

Unhold conference participants

Unhold a list of participants in a conference call

POST /conferences/{id}/actions/unhold — Required: call_control_ids

Optional: region (enum)

response = client.conferences.actions.unhold(
    id="id",
    call_control_ids=["v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"],
)
print(response.data)

Unmute conference participants

Unmute a list of participants in a conference call

POST /conferences/{id}/actions/unmute

Optional: call_control_ids (array[string]), region (enum)

response = client.conferences.actions.unmute(
    id="id",
)
print(response.data)

Update conference participant

Update conference participant supervisor_role

POST /conferences/{id}/actions/update — Required: call_control_id, supervisor_role

Optional: command_id (string), region (enum), whisper_call_control_ids (array[string])

action = client.conferences.actions.update(
    id="id",
    call_control_id="v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    supervisor_role="whisper",
)
print(action.data)

End a conference

End a conference and terminate all active participants.

POST /conferences/{id}/actions/end

Optional: command_id (string)

response = client.conferences.actions.end_conference(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.data)

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: call_control_id

Optional: audio_url (string), client_state (string), gather_id (string), initial_timeout_millis (integer), inter_digit_timeout_millis (integer), invalid_audio_url (string), invalid_media_name (string), maximum_digits (integer), maximum_tries (integer), media_name (string), minimum_digits (integer), stop_playback_on_dtmf (boolean), terminating_digit (string), timeout_millis (integer), valid_digits (string)

response = client.conferences.actions.gather_dtmf_audio(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    call_control_id="v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
)
print(response.data)

Send DTMF to conference participants

Send DTMF tones to one or more conference participants.

POST /conferences/{id}/actions/send_dtmf — Required: digits

Optional: call_control_ids (array[string]), client_state (string), duration_millis (integer)

response = client.conferences.actions.send_dtmf(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    digits="1234#",
)
print(response.data)

List conference participants

Lists conference participants

GET /conferences/{conference_id}/participants

page = client.conferences.list_participants(
    conference_id="conference_id",
)
page = page.data[0]
print(page.id)

Webhooks

The following webhook events are sent to your configured webhook URL. All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for verification (Standard Webhooks compatible).

Webhook payload fields

callEnqueued

callLeftQueue

conferenceCreated

conferenceEnded

conferenceFloorChanged

conferenceParticipantJoined

conferenceParticipantLeft

conferenceParticipantPlaybackEnded

conferenceParticipantPlaybackStarted

conferenceParticipantSpeakEnded

conferenceParticipantSpeakStarted

conferencePlaybackEnded

conferencePlaybackStarted

conferenceRecordingSaved

conferenceSpeakEnded

conferenceSpeakStarted