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

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

const response = await client.conferences.actions.leave('id', {
  call_control_id: 'c46e06d7-b78f-4b13-96b6-c576af9640ff',
});

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

Leave Conference request object

​
call_control_id
string
required

Unique identifier and token for controlling the call

Example:

"f91269aa-61d1-417f-97b3-10e020e8bc47"

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

​
beep_enabled
enum<string>

Whether a beep sound should be played when the participant 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
Conference Command Result · object
Example:
{ "result": "ok" }