Switch supervisor role

Switch the supervisor role for a bridged call. This allows switching between different supervisor modes during an active call

POST /calls/{call_control_id}/actions/switch_supervisor_role

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.calls.actions.switchSupervisorRole('call_control_id', {
  role: 'barge',
});

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

call_control_id · string · required

Unique identifier and token for controlling the call

Body

application/json

Switch supervisor role request

role · enum<string> · required

The supervisor role to switch to. 'barge' allows speaking to both parties, 'whisper' allows speaking to caller only, 'monitor' allows listening only.

Available options: barge, whisper, monitor

Example:

"barge"

Response

200

application/json

Successful response upon making a call control command.

data · Call Control Command Result · object

Show child attributes

Example:

{ "result": "ok" }