Skip to main content

Join a conference

POST 
/conferences/:id/actions/join

Joins an existing call_leg to a conference. Issue the Join Conference command with the conference ID in the path and the call_control_id of the leg you wish to join to the conference as an attribute.

Request ​

Path Parameters

    id stringrequired

    Unique identifier of the conference

Body

required

    call_control_id stringrequired

    Unique identifier and token for controlling the call

    client_state string

    Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

    command_id string

    Use this field to avoid duplicate commands. Telnyx will ignore commands with the same "command_id".

    end_conference_on_exit boolean

    Whether the conference should end and all remaining participant be hung up after the participant leaves the conference. Defaults to "false".

    hold boolean

    Whether the participant should be put on hold immediately after joining the conference. Defaults to "false".

    hold_audio_url string

    The URL of an audio file to be played to the participant when they are put on hold after joining the conference. This property takes effect only if "hold" is set to "true".

    mute boolean

    Whether the participant should be muted immediately after joining the conference. Defaults to "false".

    start_conference_on_enter boolean

    Whether the conference should be started after the participant joins the conference. Defaults to "false".

    supervisor_role string

    Possible values: [whisper, barge, monitor, none]

    "barge" means the supervisor enters the conference as a normal participant. This is the same as "none". "monitor" means the supervisor is muted but can hear all participants. "whisper" means that only the specified "whisper_call_control_ids" can hear the supervisor. Defaults to "none"."

    whisper_call_control_ids string[]

    Array of unique call_control_ids that for which the joining supervisor role can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only.

Responses ​

200: Successful response

Schema

    result stringrequired

401: Unauthorized

422: Unprocessable entity. Can be caused by improper use of filters or nodes.

Request samples

curl -L 'https://api.telnyx.com/conferences/:id/actions/join' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "call_control_id": "AgDIxmoRX6QMuaIj_uXRXnPAXP0QlNfXczRrZvZakpWxBlpw48KyZQ==",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "end_conference_on_exit": true,
  "hold": true,
  "hold_audio_url": "http://www.example.com/audio.wav",
  "mute": true,
  "start_conference_on_enter": true,
  "supervisor_role": "whisper",
  "whisper_call_control_ids": [
    "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
    "v2:Sg1xyxQ_U3ixyxyXT_VDNI3xyxazZdg6Vxyxs4-GNYxyxVaJPOhFMRQ"
  ]
}'

Response samples

{
  "result": "ok"
}