From Bright Pattern Documentation
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

API Methods

InitAPI

Syntax bool InitAPI();
Description Initializes the API. This request initializes the TCP connection procedure. Once connection is established the evtApiUp event is sent to the .NET application.


ShutdownAPI

Syntax void ShutdownAPI();
Description Terminates the TCP connection between API and the Agent Desktop.


CallDial

Syntax UInt64 CallDial(string destination, string giid);
Description Initiates a call to the number specified in destination. Specification of giid (global interaction identifier) is optional. Returns request ID.


MuteCallRecording

Syntax UInt64 MuteCallRecording(string callId);
Description 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.


UnmuteCallRecording

Syntax UInt64 UnmuteCallRecording(string callId);
Description Resumes previously muted audio recording for the call identified by callId on the given desktop.


MuteScreenRecordings

Syntax UInt64 MuteScreenRecordings();
Description Mutes screen recording on this 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 in the Agent Desktop Helper Application.


UnmuteScreenRecordings

Syntax UInt64 UnmuteScreenRecordings();
Description Unmutes previously muted screen recording on this desktop.

This request is processed in the Agent Desktop Helper Application.


< Previous | Next >
< Previous | Next >