Hold conference participants

Hold a list of participants in a conference call

POST /conferences/{id}/actions/hold

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.hold('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 unique identifiers and tokens for controlling the call. When empty all participants will be placed on hold.

audio_url · string

The URL of a file to be played to the participants when they are put on hold. media_name and audio_url cannot be used together in one request.

Example:

"http://example.com/message.wav"

media_name · string

The media_name of a file to be played to the participants when they are put on hold. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.

Example:

"my_media_uploaded_to_media_storage_api"

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