From Bright Pattern Documentation
Auxiliary Classes
DesktopControlAPI.BaseEventArgs
Description
|
Base event arguments class.
|
Members
|
- reqId – request ID returned by a call that caused the error
|
DesktopControlAPI.Call
Description
|
Describes a single phone call.
|
Members
|
- m_id – call ID; string
- m_direction – call direction; enum; (DesktopControlAPI.CallDirection.Inbound for incoming calls; DesktopControlAPI.CallDirection.Outbound for outgoing calls)
- m_ANI – caller ID number for incoming calls or Agent’s phone number for outgoing calls; string
- m_DNIS – number dialed by the calling party for incoming calls or number dialed by the Agent for outgoing calls; string
- m_callerName – caller ID text name for incoming calls or Agent’s display name for outgoing calls; string
- m_serviceName – name of the service associated with this call; string
- m_agentId – agent’s username; string
- m_agentPhone – agent’s phone number; string
|
DesktopControlAPI.CallArgs
Description
|
Class for call attributes used in all call-related events.
|
Members
|
- callId – call ID; string
- requestId – identifier of the request related to this event; string
- ANI – caller ID number for incoming calls or Agent’s phone number for outgoing calls; string
- DNIS – number dialed by the calling party for incoming calls or number dialed by the Agent for outgoing calls
- callerName – caller ID text name for incoming calls or Agent’s display name for outgoing calls
- serviceName – name of the service associated with this call
- attachedData – key-value list of the data attached to this call by the scenario that processed it. Scenario should use the Attached Data block for this purpose.
- requestId - Optional request ID of the method which the event responds to
- globalInteractionId - global interaction identifier; string
|
DesktopControlAPI.ErrorEventArgs
Description
|
Error event arguments class.
|
Members
|
- reqId – request ID of the method that caused the error
- callId – call ID; string
- code - error code
- description - error description
|
DesktopControlAPI.ScreenRecordingArgs
Description
|
Arguments of events related to screen recording.
|
Members
|
- sessionId – screen recording session ID (starting from version 3.9, all agent activities, including interaction handling, are recorded via a single screen recording session; i.e., this parameter has no purpose other than backward compatibility)
- requestId - optional request ID of the method which the event responds to
|
< Previous < Previous