(Updated via BpDeleteTranslateTags script) |
|||
| (8 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = API Methods= | |
== InitAPI == | == InitAPI == | ||
''InitAPI'' initializes the API. | ''InitAPI'' initializes the API. | ||
| − | This request initializes the TCP connection procedure. Once connection is established, the evtApiUp event is sent to the .NET application. | + | This request initializes the TCP connection procedure. Once the connection is established, the evtApiUp event is sent to the .NET application. |
=== Syntax === | === Syntax === | ||
| Line 62: | Line 62: | ||
| − | + | == CallSetScenarioVariable == | |
| − | < | + | ''CallSetScenarioVariable'' sets a variable identified by ''name'' for the scenario associated with the call identified by ''callId'' to the value specified in ''value''. |
| + | |||
| + | === Syntax === | ||
| + | UInt64 CallSetScenarioVariable(string _callId, string _name, string _value); | ||
| + | |||
| + | |||
| + | == CallSingleStepTransfer == | ||
| + | This method initiates a [[Agent-guide/Tutorials/Calls/HowtoPlaceaCallinaServiceQueue|single-step (blind) transfer]] of the call identified by ''callId'' to the number specified in ''dest''. Optionally, it also allows a collection of variables to be set and transferred to the call-processing scenario within the same request. | ||
| + | |||
| + | === Syntax === | ||
| + | UInt64 CallSingleStepTransfer(string _callId, string _dest, Dictionary<string, string> _vars); | ||
Latest revision as of 04:03, 29 May 2024
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 sets a variable identified by name for the scenario associated with the call identified by callId to the value specified in value.
Syntax
UInt64 CallSetScenarioVariable(string _callId, string _name, string _value);
CallSingleStepTransfer
This method initiates a single-step (blind) transfer of the call identified by callId to the number specified in dest. Optionally, it also allows a collection of variables to be set and transferred to the call-processing scenario within the same request.
Syntax
UInt64 CallSingleStepTransfer(string _callId, string _dest, Dictionary<string, string> _vars);