McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 188

↗ View in doc context
page
188
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::172

<ApiErrors> <ApiError> <ErrorData>1</ErrorData> <ErrorMedia>5001</ErrorMedia> <ErrorMessage>E_ARM_STAT_AGENT_ALREADY_LOGGED_IN</ErrorMessage> <ErrorType>Agent already logged into MRD</ErrorType> </ApiError> </ApiErrors> Example Failure Response: Media notification Notifications Triggered: Asynchronous Errors If an error occurs after the initial validation is complete, an error notification is sent over XMPP to the Media notification. The requestId is included in the response XML. The ErrorMedia parameter in the ApiError information indicates the Media Routing Domain to which the error applies. Media—Change Agent to Routable/Not Routable The Media—Change Agent to Routable/Not Routable API allows a user to set an agent's routable mode in a Media Routing Domain. Routable mode determines whether CCE can route tasks to an agent in a Media Routing Domain. When the routable parameter is set to true, the agent is routable. CCE can assign task to the agent in that MRD. When the routable parameter is set to false, the agent is not routable. CCE cannot assign tasks to the agent in that MRD. Make the agent not routable to stop sending tasks to the agent without changing the agent's state to NOT_READY. If an agent changes to NOT_READY state while still working on tasks, those tasks appear ended in CCE reports; time spent working on the tasks after going Not Ready is not counted. You may want to make the agent not routable near the end of the agent's shift, to allow the agent to finish final tasks without being assigned more tasks and to report accurately on those final tasks. In a RONA situation, in which a task is resubmitted because an agent does not accept a task within the MRD's Start Timeout threshold, Finesse automatically makes the agent not routable. If a user sets the agent's mode to not routable when an agent has pending incoming tasks or has not started an accepted task, the agent's mode does not change until the agent has started these tasks. The agent's mode is set to routable automatically when the agent signs in, and when the agent changes to READY state. https://<FQDN>/finesse/api/User/<id>/Media/<mrdId> URI: https://finesse1.xyz.com/finesse/api/User/1234/Media/5001 Example URI: Users can only act on their own Media objects. Security Constraints: PUT HTTP Method: Application/XML Content Type: XML Input/Output Format: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 172 Cisco Finesse Desktop APIs Media—Change Agent to Routable/Not Routable