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

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.conferences.actions.stop('id');

console.log(response.data);

200

Example

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

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.

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

200

application/json

Successful response upon making a conference command.

data · Conference Command Result · object

Show child attributes

Example:

{ "result": "ok" }