Skip to main content

Leave a conference

POST 
/conferences/:id/actions/leave

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

  • conference.participant.left

Request ​

Path Parameters

    id stringrequired

    Uniquely identifies the conference by id or name

Body

required

Leave Conference request object

    call_control_id stringrequired

    Unique identifier and token for controlling the call

    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.

    beep_enabled string

    Possible values: [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.

Responses ​

200: Successful response upon making a conference command.

Schema

    data

    object

    result stringrequired

401: Unauthorized

422: Unprocessable entity

Callbacks ​

Request samples

curl -L 'https://api.telnyx.com/v2/conferences/:id/actions/leave' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "call_control_id": "c46e06d7-b78f-4b13-96b6-c576af9640ff",
  "beep_enabled": "never"
}'

Response samples

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