Skip to main content

Stop audio being played on the conference

POST 
/conferences/:id/actions/stop

Stop audio being played to all or some participants on a conference call.

Request ​

Path Parameters

    id stringrequired

    Uniquely identifies the conference by id or name

Body

required

    call_control_ids string[]

    List of call control ids identifying participants the audio file should stop be played to. If not given, the audio will be stoped to the entire conference.

Responses ​

200: Successful response upon making a conference command.

Schema

    data

    object

    result stringrequired

401: Unauthorized

404: Conference does not exist

422: Unprocessable entity

Callbacks ​

Request samples

curl -L 'https://api.telnyx.com/v2/conferences/:id/actions/stop' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "call_control_ids": [
    "string"
  ]
}'

Response samples

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