Conference Commands

Leave a conference

Removes a call leg from a conference and moves it back to parked state.

Expected Webhooks:

  • conference.participant.left
post/conferences/{id}/actions/leave

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/conferences/{id}/actions/leave
  • Auth: HTTP bearer

Path parameters

idstring required

Uniquely identifies the conference by id or name

Request body

call_control_idstring required

Unique identifier and token for controlling the call

command_idstring

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.

beep_enabled'always' | 'never' | 'on_enter' | 'on_exit'

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

region'Australia' | 'Europe' | 'Middle East' | 'US'

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

Example request

{
  "call_control_id": "c46e06d7-b78f-4b13-96b6-c576af9640ff",
  "beep_enabled": "never"
}

Response

Successful response upon making a conference command.

Example response

{
  "data": {
    "result": "ok"
  }
}

Changes

No operation changes recorded.