McDewey

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

Page 185

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

202: Successfully Accepted The requestId is included in the response header if provided. This response only indicates successful completion of the request. The request is processed and the actual response is sent as part of a media notification. Note 400: Bad Request (for example, malformed or incomplete request) 400: Parameter Missing 401: Unauthorized (for example, the user is not authenticated in the Web Session) 404: Not Found (for example, the user ID or mrdId is not known) 503: Service Unavailable (for example, the Notification Service is not running) HTTP Response: <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 State or Sign Out This API allows a user to change state in or sign out of an individual nonvoice Media Routing Domain. See Agent States for Nonvoice Media, on page 178 for information about the agent states you can set with this API. Users can sign out with active tasks. The user's tasks are either automatically transferred or closed, depending on the way the MRD was configured when the user signed in through the Media - Sign In API. To transfer tasks, Finesse resubmits the tasks into the system as new tasks. https://<FQDN>/finesse/api/User/<id>/Media/<mrdId> URI: https://finesse1.xyz.com/finesse/api/User/1234/Media/5001 Example URI: Agents and supervisors can use this API. Users can only act on their own Media objects. Security Constraints: PUT HTTP Method: Application/XML Content Type: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 169 Cisco Finesse Desktop APIs Media—Change State or Sign Out