Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Conference Commands

Create conference

Create a conference from an existing call leg using a call_control_id 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.

Expected Webhooks:

  • conference.created
  • conference.participant.joined
  • conference.participant.left
  • conference.ended
  • conference.recording.saved
  • conference.floor.changed
post/conferences

Request body

beep_enabled'always' | 'never' | 'on_enter' | 'on_exit'

Whether a beep sound should be played when participants join and/or leave the conference.

call_control_idstring required

Unique identifier and token for controlling the call

client_statestring

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. The client_state will be updated for the creator call leg and will be used for all webhooks related to the created conference.

comfort_noiseboolean

Toggle background comfort noise.

command_idstring

Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same command_id as one that has already been executed.

duration_minutesinteger

Time length (minutes) after which the conference will end.

hold_audio_urlstring

The URL of a file to be played to participants joining the conference. The URL can point to either a WAV or MP3 file. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when "start_conference_on_create" is set to "false".

hold_media_namestring

The media_name of a file to be played to participants joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when "start_conference_on_create" is set to "false".

max_participantsinteger

The maximum number of active conference participants to allow. Must be between 2 and 800. Defaults to 250

namestring required

Name of the conference

region'Australia' | 'Europe' | 'Middle East' | 'US'

Sets the region where the conference data will be hosted. Defaults to the region defined in user's data locality settings (Europe or US).

start_conference_on_createboolean

Whether the conference should be started on creation. If the conference isn't started all participants that join are automatically put on hold. Defaults to "true".

Example request

{
  "beep_enabled": "always",
  "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "duration_minutes": 5,
  "hold_audio_url": "http://www.example.com/audio.wav",
  "max_participants": 250,
  "name": "Business",
  "start_conference_on_create": false
}

Response

Successful response with details about a conference.

Example response

{
  "data": {
    "connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6",
    "created_at": "2019-01-23T18:10:02.574Z",
    "end_reason": "all_left",
    "ended_by": {
      "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
      "call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
    },
    "expires_at": "2019-01-23T18:10:02.574Z",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "All hands meeting",
    "record_type": "conference",
    "region": "sv1",
    "status": "completed",
    "updated_at": "2019-01-23T18:10:02.574Z"
  }
}