Class CoachCall

Switches a supervisor (already joined via MonitorCall) into coach (whisper) mode for the specified agent on the task's conference. The supervisor becomes audible to that agent only — the customer does not hear the supervisor.

Param: taskSid

The SID of the task

Param: options

Optional configuration for the coach call

Returns

A promise that resolves when the coach call is established

Throws

FlexSdkError with the following error code(s):

Example

import { createClient } from "@twilio/flex-sdk";
import { CoachCall } from "@twilio/flex-sdk/actions/Voice";

async function example() {
  const client = await createClient("SDK_TOKEN");
  const coachCall = new CoachCall("WTXXXXXXXXXXXXXXXXXXXXXXXXX", { targetWorkerSid: "WRXXXXXXXXXXXXXXXXXXXXXXXXX" });
  const call = await client.execute(coachCall);
}

Implements

Action<Promise<void>>

Index

Constructors

constructor

Methods

run

Constructors

constructor

new CoachCall(taskSid: string, options?: CoachCallOptions): CoachCall
Creates an instance of CoachCall.
Parameters
- taskSid: string
  The SID of the task
- Optionaloptions: CoachCallOptions
  Optional configuration for the coach call
Returns CoachCall

Methods

run

run(ctx: {}): Promise<void>
Parameters
- ctx: {}
Returns Promise<void>
Implementation of Action.run

Class CoachCall

Param: taskSid

Param: options

Returns

Throws

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CoachCall

Methods

run

Parameters

Returns Promise<void>

Settings

On This Page