Conference Commands

Stop audio being played on the conference

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

post/conferences/{id}/actions/stop

Request

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

Path parameters

idstring required

Uniquely identifies the conference by id or name

Request body

call_control_idsstring[]

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.

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

{
  "region": "US"
}

Response

Successful response upon making a conference command.

Example response

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

Changes

No operation changes recorded.