v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Conference Commands

Hold conference participants

Hold a list of participants in a conference call

post/conferences/{id}/actions/hold

Path parameters

idstring required

Uniquely identifies the conference by id or name

Request body

audio_urlstring

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.

call_control_idsstring[]

List of unique identifiers and tokens for controlling the call. When empty all participants will be placed on hold.

media_namestring

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.

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

{
  "audio_url": "http://example.com/message.wav",
  "call_control_ids": [
    "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
  ]
}

Response

Successful response upon making a conference command.

Example response

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