McDewey

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

Page 187

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

Media—Change Agent State with Reason Code This API allows a user to change the agent state in an individual non-voice Media Routing Domain, and pass along the code value of a corresponding reason code. Users can use this API only when changing state to NOT_READY or LOGOUT. 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: XML Input/Output Format: <Media> <state>NOT_READY</state> <reasonCodeId>1001</reaasonCodeId> </Media> HTTP Request: id (required): The ID of the user mrdId (required): The ID of the Media Routing Domain reasonCodeId (required if reason codes are configured for the given state): The database ID for the reason code state (required): The new state that the user wants to be in (NOT_READY or LOGOUT) Request Parameters: requestId: A user provided unique string used to correlate originating request with the resulting HTTP response or asynchronous error. This parameter is not part of the resulting event/events. Header Parameters: 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: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 171 Cisco Finesse Desktop APIs Media—Change Agent State with Reason Code