Skip to main content

Update conference participant

POST 
/conferences/:id/actions/update

Update conference participant supervisor_role

Request​

Path Parameters

    id stringrequired

    Uniquely identifies the conference by id or name

Body

required

Update Conference request object

    call_control_id stringrequired

    Unique identifier and token for controlling the call

    command_id string

    Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same command_id as one that has already been executed.

    supervisor_role stringrequired

    Possible values: [barge, monitor, none, whisper]

    Sets the participant as a supervisor for the conference. A conference can have multiple supervisors. "barge" means the supervisor enters the conference as a normal participant. This is the same as "none". "monitor" means the supervisor is muted but can hear all participants. "whisper" means that only the specified "whisper_call_control_ids" can hear the supervisor. Defaults to "none".

    whisper_call_control_ids string[]

    Array of unique call_control_ids the supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only.

Responses​

200: Successful response upon making a conference command.

Schema

    data

    object

    result stringrequired

401: Unauthorized

422: Unprocessable entity

Request samples

curl -L 'https://api.telnyx.com/v2/conferences/:id/actions/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "supervisor_role": "whisper",
  "whisper_call_control_ids": [
    "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
    "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
  ]
}'

Response samples

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