Skip to main content

Create conference

POST 
/conferences

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

Request​

Body

required

Create a conference

    call_control_id stringrequired

    Unique identifier and token for controlling the call

    name stringrequired

    Name of the conference

    beep_enabled string

    Possible values: [always, never, on_enter, on_exit]

    Default value: never

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

    client_state string

    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_noise boolean

    Default value: true

    Toggle background comfort noise.

    command_id string

    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_minutes integer

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

    hold_audio_url string

    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_name string

    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_participants integer

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

    start_conference_on_create boolean

    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".

Responses​

200: Successful response with details about a conference.

Schema

    data

    object

    record_type stringrequired

    Possible values: [conference]

    id stringrequired

    Uniquely identifies the conference

    name stringrequired

    Name of the conference

    created_at stringrequired

    ISO 8601 formatted date of when the conference was created

    expires_at stringrequired

    ISO 8601 formatted date of when the conference will expire

    updated_at string

    ISO 8601 formatted date of when the conference was last updated

    region string

    Region where the conference is hosted

    status string

    Possible values: [init, in_progress, completed]

    Status of the conference

    end_reason string

    Possible values: [all_left, ended_via_api, host_left, time_exceeded]

    Reason why the conference ended

    ended_by

    object

    IDs related to who ended the conference. It is expected for them to all be there or all be null

    call_control_id string

    Call Control ID which ended the conference

    call_session_id string

    Call Session ID which ended the conference

    IDs related to who ended the conference. It is expected for them to all be there or all be null

    connection_id string

    Identifies the connection associated with the conference

401: Unauthorized

422: Unprocessable entity

Callbacks​

Request samples

curl -L 'https://api.telnyx.com/v2/conferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "name": "Business",
  "beep_enabled": "always",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "duration_minutes": 5,
  "hold_audio_url": "http://www.example.com/audio.wav",
  "start_conference_on_create": false,
  "max_participants": 250
}'

Response samples

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