From Bright Pattern Documentation
Jump to: navigation, search
• 5.2 • 5.3 • 5.8

API Methods

InitAPI

InitAPI initializes the API.

This request initializes the TCP connection procedure. Once the connection is established, the evtApiUp event is sent to the .NET application.

Syntax

bool InitAPI();


ShutdownAPI

ShutdownAPI terminates the TCP connection between the API and the Agent Desktop.

Syntax

void ShutdownAPI();


CallDial

CallDial initiates a call to the number specified in destination.

Specification of the global interaction identifier (GIID) is optional. This returns request ID.

Syntax

UInt64 CallDial(string destination, string giid);


MuteCallRecording

MuteCallRecording mutes audio recording of the call identified by callId on the given desktop.

The recording will continue, but any voice signal will be replaced with silence.

Syntax

UInt64 MuteCallRecording(string callId);


UnmuteCallRecording

UnmuteCallRecording resumes previously muted audio recording for the call identified by callId on the given desktop.

Syntax

UInt64 UnmuteCallRecording(string callId);


MuteScreenRecordings

MuteScreenRecordings mutes screen recording on the given desktop.

For the period when screen recording is muted, the recording will contain a static snapshot of the desktop at the moment when mute was applied.

This request is processed by the Agent Desktop Helper Application.

Syntax

UInt64 MuteScreenRecordings();


UnmuteScreenRecordings

UnmuteScreenRecordings unmutes previously muted screen recording on the given desktop.

This request is processed by the Agent Desktop Helper Application.

Syntax

UInt64 UnmuteScreenRecordings();


CallSetScenarioVariable

CallSetScenarioVariable adds a scenario variable for a scenario associated with the specified call; it is invoked in instances where over-the-phone credit card payments are processed. Note that this method must be used before calling the method CallSStepTransfer as it is used to pass collected transaction-related data to the scenario. This method should be called separately for each variable to be set.

Syntax

UInt64 CallSetScenarioVariable(string _callId, string _name, string _value);


CallSStepTransfer

CallSStepTransfer initiates single step (blind) transfer of specified call; it is invoked in instances where over-the-phone credit card payments are processed and should be used after CallSetScenarioVariable

Syntax

UInt64 CallSStepTransfer(string _callId, string _dest);


< Previous | Next >