Skip to main content
POST
/
conferences
JavaScript
import Telnyx from 'telnyx';

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

const conference = await client.conferences.create({
  call_control_id: 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
  name: 'Business',
});

console.log(conference.data);
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Create a conference

​
call_control_id
string
required

Unique identifier and token for controlling the call

Example:

"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ=="

​
name
string
required

Name of the conference

Example:

"Business"

​
beep_enabled
enum<string>
default:never

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

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

"on_exit"

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

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

​
comfort_noise
boolean
default:true

Toggle background comfort noise.

Example:

false

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

​
duration_minutes
integer

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

Example:

5

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

Example:

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

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

Example:

"my_media_uploaded_to_media_storage_api"

​
max_participants
integer

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

Example:

3

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

Example:

false

​
region
enum<string>

Sets the region where the conference data will be hosted. 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 with details about a conference.

​
data
Conference · object
Example:
{
  "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"
}