From Bright Pattern Documentation
Jump to: navigation, search
 
 
Line 78: Line 78:
  
  
<center>[[simplified-desktop-net-api-specification/APIProperties|< Previous]] </center>
+
 
 
</translate>
 
</translate>

Latest revision as of 18:03, 19 June 2019

• 5.2 • 5.3 • 5.8

Auxiliary Classes

DesktopControlAPI.BaseEventArgs

Base event arguments class

Members

  • reqId – Request ID returned by a call that caused the error


DesktopControlAPI.Call

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

Class for call attributes used in all call-related events

Members

  • callId – Call ID; string
  • equestId – 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 to which the event responds


DesktopControlAPI.ErrorEventArgs

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

Arguments of events related to screen recording

Members

  • sessionId – Screen recording session ID (starting from Bright Pattern Contact Center version 3.9, all agent activities, including interaction handling, are recorded via a single screen recording session; that is, this parameter has no purpose other than backward compatibility)
  • requestId - Optional request ID of the method to which the event responds


< Previous