Skip to main content

Hold conference participants

POST 
/conferences/:id/actions/hold

Hold a list of participants in a conference call

Request ​

Path Parameters

    id stringrequired

    Uniquely identifies the conference by id or name

Body

required

    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.

    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.

Responses ​

200: Successful response upon making a conference command.

Schema

    data

    object

    result stringrequired

401: Unauthorized

404: Conference does not exist

422: Unprocessable entity

Request samples

curl -L 'https://api.telnyx.com/v2/conferences/:id/actions/hold' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "call_control_ids": [
    "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"
  ],
  "audio_url": "http://example.com/message.wav"
}'

Response samples

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