Skip to main content
POST
/
conferences
/
{id}
/
actions
/
join
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.conferences.actions.join('id', {
  call_control_id: 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
});

console.log(response.data);
{
  "data": {
    "result": "ok"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Uniquely identifies the conference by id or name

Body

application/json

Join Conference request object

​
call_control_id
string
required

Unique identifier and token for controlling the call

Example:

"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ=="

​
client_state
string

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. Please note that the client_state will be updated for the participient call leg and the change will not affect conferencing webhooks unless the participient is the owner of the conference.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

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

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

​
end_conference_on_exit
boolean

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

Example:

true

​
soft_end_conference_on_exit
boolean

Whether the conference should end after the participant leaves the conference. NOTE this doesn't hang up the other participants. Defaults to "false".

Example:

true

​
hold
boolean

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

Example:

true

​
hold_audio_url
string

The URL of a file to be played to the participant when they are put on hold after joining the conference. 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". This property takes effect only if "hold" is set to "true".

Example:

"http://example.com/message.wav"

​
hold_media_name
string

The media_name of a file to be played to the participant when they are put on hold after 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". This property takes effect only if "hold" is set to "true".

Example:

"my_media_uploaded_to_media_storage_api"

​
mute
boolean

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

Example:

true

​
start_conference_on_enter
boolean

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

Example:

true

​
supervisor_role
enum<string>

Sets the joining participant as a supervisor for the conference. A conference can have multiple supervisors. "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".

Available options:
barge,
monitor,
none,
whisper
Example:

"whisper"

​
whisper_call_control_ids
string[]

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

Example:
[
  "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
  "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
]
​
beep_enabled
enum<string>

Whether a beep sound should be played when the participant joins and/or leaves the conference. Can be used to override the conference-level setting.

Available options:
always,
never,
on_enter,
on_exit
Example:

"on_exit"

​
region
enum<string>

Region where the conference data is located. Defaults to the region defined in user's data locality settings (Europe or US).

Available options:
Australia,
Europe,
Middle East,
US
Example:

"US"

Response

Successful response upon making a conference command.

​
data
object
Example:
{ "result": "ok" }