Latest revision as of 04:02, 29 May 2024

General Information About the Embedded Agent Desktop API

The Embedded Agent Desktop API is used for requesting for information about agent states and interactions, as well as controlling agent and supervisor login, status, call flow, call recordings, transfers, and outbound dialing.

The methods and events of the API are specified in the Embedded Agent Desktop API Specification.

Supported Methods

The Embedded Agent Desktop API supports the following types of methods: agent state, dialing and transfer, completing and terminating an interaction, and call recordings control.

Agent State methods are used to request an agent's state and interaction information, as well as to change an agent's state.

Dialing and Transfer methods are used for dialing phone numbers and transferring calls.

Completing and Terminating an Interaction methods are used for completing and terminating interactions.

Call Recordings Control methods are used for controlling call recordings and getting the status of call recordings.

Supported Events

The Embedded Agent Desktop API supports the following types of events: agent login, agent status, and call flow.

Agent Login events are used for showing whether an agent is logged in or out of Agent Desktop.

onAgentLogin(callback)

Agent Status events are used for retrieving an agent's state and reason.

onStatusChange(callback)

Call Flow events are used for getting information about active interactions and completed interactions.

@@ Line 1: / Line 1: @@
-<translate>
-= General Information =
-The syntax for all the methods and events in this specification includes the object ''window.bpspat.api''.
-This object is created when the script file is included in an external webpage as shown:
- <script type="text/javascript" src="https://YOUR_AGENT_DESKTOP_WEB_SERVER/agentdesktop/app/lib/servicepattern-sdk-v1.js"></script>
+= General Information About the Embedded Agent Desktop API =
+The Embedded Agent Desktop API is used for requesting for information about agent states and interactions, as well as controlling agent and supervisor login, status, call flow, call recordings, transfers, and outbound dialing.
+The methods and events of the API are specified in the [[Embedded-agent-desktop-api-specification/Purpose |  Embedded Agent Desktop API Specification]].
-Note that in the script source, you replace ''YOUR_AGENT_DESKTOP_WEB_SERVER'' with your actual web server.
+== Supported Methods ==
+The Embedded Agent Desktop API supports the following types of methods: agent state, dialing and transfer, completing and terminating an interaction, and call recordings control.
+'''Agent State''' methods are used to request an agent's state and interaction information, as well as to change an agent's state.
+* [[Embedded-agent-desktop-api-specification/Methods/getState | getState]]
+* [[Embedded-agent-desktop-api-specification/Methods/setStatus | setStatus]]
+'''Dialing and Transfer''' methods are used for dialing phone numbers and transferring calls.
+* [[Embedded-agent-desktop-api-specification/Methods/dialNumber | dialNumber]]
+* [[Embedded-agent-desktop-api-specification/Methods/selectService | selectService]]
+* [[Embedded-agent-desktop-api-specification/Methods/singleStepTransfer | singleStepTransfer]]
+* [[Embedded-agent-desktop-api-specification/Methods/singleStepConference | singleStepConference]]
-</translate>
+'''Completing and Terminating an Interaction''' methods are used for completing and terminating interactions.
+* [[Embedded-agent-desktop-api-specification/Methods/setDisposition |  setDisposition]]
+* [[Embedded-agent-desktop-api-specification/Methods/terminateInteraction |  terminateInteraction]]
+* [[Embedded-agent-desktop-api-specification/Methods/completeInteraction |  completeInteraction]]
+* [[Embedded-agent-desktop-api-specification/Methods/completeInteractionWithDisp |  completeInteractionWithDisp]]
+'''Call Recordings Control''' methods are used for controlling call recordings and getting the status of call recordings.
+* [[Embedded-agent-desktop-api-specification/Methods/muteCallRecordings |  muteCallRecordings()]]
+* [[Embedded-agent-desktop-api-specification/Methods/unmuteCallRecordings |  unmuteCallRecordings()]]
+* [[Embedded-agent-desktop-api-specification/Methods/getCallRecordingStatusCallback |  getCallRecordingStatus(callback)]]
+* [[Embedded-agent-desktop-api-specification/Methods/startCallRecordingCallback |  startCallRecording(callback)]]
+* [[Embedded-agent-desktop-api-specification/Methods/stopCallRecordingCallback |  stopCallRecording(callback)]]
+* [[Embedded-agent-desktop-api-specification/Methods/muteCallRecordingCallback |  muteCallRecording(callback)]]
+* [[Embedded-agent-desktop-api-specification/Methods/unmuteCallRecordingCallback |  unmuteCallRecording(callback)]]
+== Supported Events ==
+The Embedded Agent Desktop API supports the following types of events: agent login, agent status, and call flow.
+'''Agent Login''' events are used for showing whether an agent is logged in or out of Agent Desktop.
+* [[Embedded-agent-desktop-api-specification/Events/onAgentLoginCallback| onAgentLogin(callback)]]
+'''Agent Status''' events are used for retrieving an agent's state and reason.
+* [[Embedded-agent-desktop-api-specification/Events/onStatusChangeCallback| onStatusChange(callback)]]
+'''Call Flow''' events are used for getting information about active interactions and completed interactions.
+* [[Embedded-agent-desktop-api-specification/Events/AddInteractionRenderedHandlerCallback |  addInteractionRenderedHandler(callback)]]
+* [[Embedded-agent-desktop-api-specification/Events/AddInteractionCompletedHandlerCallback |  addInteractionCompletedHandler(callback)]]