Skip to main content

Hold a conference participant

POST 

/conferences/:id/actions/hold

Hold a list of participants in a conference call

Request

Path Parameters

    id stringrequired

    Unique identifier of the conference

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 the file to be played back on the call. The URL can point to either a WAV or MP3 file.

Responses

200: Successful response

Schema

    result stringrequired

401: Unauthorized

404: Conference does not exist

422: Unprocessable entity. Can be caused by improper use of filters or nodes.

Loading...