McDewey

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

Page 189

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

<Media> <routable>true</routable> </Media> HTTP Request: id (required): The ID of the user mrdId (required): The ID of the MRD routable(required): Indicates whether CCE can route tasks to the user in the MRD. 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, invalid input for parameters) 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) 500: Internal Server Error HTTP Response: <ApiErrors> <ApiError> <ErrorData>1</ErrorData> <ErrorMedia>5001</ErrorMedia> <ErrorMessage>E_ARM_STAT_ALREADY_IN_REQUESTED_AGENT_MODE</ErrorMessage> <ErrorType>Agent already in requested mode</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 from Work State to Active This API allows a user to change the agent state from WORK state to active (READY or NOT_READY), which is automatically computed by Unified CCE. Users can only use this API when an agent state is WORK. Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 173 Cisco Finesse Desktop APIs Media—Change Agent from Work State to Active