From Bright Pattern Documentation
Jump to: navigation, search
(Created new topic from branched topic Documentation:ServicePattern:simplified-desktop-net-api-specification:APIMethods:5.1)
 
 
Line 7: Line 7:
  
 
=== Syntax ===  
 
=== Syntax ===  
bool InitAPI();
+
bool InitAPI();
  
  
Line 14: Line 14:
  
 
=== Syntax ===
 
=== Syntax ===
void ShutdownAPI();
+
void ShutdownAPI();
  
  
Line 23: Line 23:
  
 
=== Syntax ===  
 
=== Syntax ===  
UInt64 CallDial(string destination, string giid);
+
UInt64 CallDial(string destination, string giid);
  
  
Line 32: Line 32:
  
 
=== Syntax ===
 
=== Syntax ===
UInt64 MuteCallRecording(string callId);
+
UInt64 MuteCallRecording(string callId);
  
  
Line 39: Line 39:
  
 
=== Syntax ===
 
=== Syntax ===
UInt64 UnmuteCallRecording(string callId);
+
UInt64 UnmuteCallRecording(string callId);
  
  
Line 50: Line 50:
  
 
=== Syntax ===
 
=== Syntax ===
UInt64 MuteScreenRecordings();
+
UInt64 MuteScreenRecordings();
  
  
Line 59: Line 59:
  
 
=== Syntax ===
 
=== Syntax ===
UInt64 UnmuteScreenRecordings();
+
UInt64 UnmuteScreenRecordings();
 +
 
  
  
<center>[[simplified-desktop-net-api-specification/APIInstantiationandInitialization|< Previous]]  |  [[simplified-desktop-net-api-specification/APIEvents|Next >]]</center>
 
 
</translate>
 
</translate>

Latest revision as of 23:56, 25 January 2019

• 5.2 • 5.3 • 5.8

API Methods

InitAPI

InitAPI initializes the API.

This request initializes the TCP connection procedure. Once 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();


< Previous | Next >