Media - Get List

This API allows a user to get a list of Media objects for all nonvoice Media Routing Domains (MRDs) configured on CCE.

If the agent belongs to a skill group in the MRD, the media object includes the agent's state information for that MRD.

URI:

http://<FQDN>/finesse/api/User/<id>/Media

Example URI:

http://finesse1.xyz.com/finesse/api/User/1234/Media

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

—

Request Parameters:

id (required): The ID of the user

HTTP Response:

200: Success

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 is not known)

Example HTTP Response

 
<MediaList>
    <Media>
         ...Full Media Object ...
    </Media>
    <Media>
         ...Full Media Object ...
    </Media>
</MediaList>

Example Failure Response: 

<ApiErrors>
   <ApiError>
       <ErrorData>1002001</ErrorData>
       <ErrorMessage>The user specified in the authentication 
        credentials and the uri don&apos;t match</ErrorMessage>
       <ErrorType>Invalid Authorization User Specified</ErrorType>
   </ApiError>
</ApiErrors>