From Bright Pattern Documentation
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 63: Line 63:
  
 
== CallSetScenarioVariable ==
 
== 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|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. For related scenario functions, see [[Scenario-builder-reference-guide/VariablesandExpressions/Built-inFunctions|Built-In Functions]].
+
''CallSetScenarioVariable'' sets a variable identified by ''name'' for the scenario associated with the call identified by ''callId'' to the value specified in ''value''.
  
 
=== Syntax ===
 
=== Syntax ===
Line 69: Line 69:
  
  
== CallSStepTransfer ==
+
== CallSingleStepTransfer ==
''CallSStepTransfer'' initiates a single-step (i.e., blind) transfer of the specified call; it is invoked in instances where over-the-phone credit card payments are processed and should be used after [[#CallSetScenarioVariable|CallSetScenarioVariable]]. For related scenario functions, see [[Scenario-builder-reference-guide/VariablesandExpressions/Built-inFunctions|Built-In Functions]].
+
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 ===
 
=== Syntax ===
UInt64 CallSStepTransfer(string _callId, string _dest);
+
UInt64 CallSingleStepTransfer(string _callId, string _dest, Dictionary<string, string> _vars);
  
  

Latest revision as of 22:30, 11 January 2021

• 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 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);


< Previous | Next >