Media - Get Media

This API allows a user to get a copy of a Media object for a specified agent. This API can be used to return only nonvoice Media objects.

URI:

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

Example URI:

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

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

—

Request Parameters:

id (required): The ID of the user

mrdId (required): The ID of the Media Routing Domain

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

Example HTTP Response

Response if the agent is assigned to skill groups in the Media Routing Domain: 

<Media>
    <uri>/finesse/api/User/1001004/Media/5000</uri>
    <description>Chat MRD</description>
    <dialogLogoutAction>CLOSE</dialogLogoutAction>
    <id>5000</id>
    <interruptible>false</interruptible>
    <maxDialogLimit>10</maxDialogLimit>
    <name>Cisco_Chat_MRD</name>
    <ReasonCode>
        <category>NOT_READY</category>
        <code>10</code>
        <forAll>true</forAll/>
        <id>16</id>
        <label>Team Meeting</label>
        <uri>/finesse/api/ReasonCode/16</uri>
    </ReasonCode>
    <reasonCodeId>16</reasonCodeId>
    <routable>true</routable>
    <state>NOT_READY</state>
    <stateChangeTime>2015-09-11T06:55:14.782Z</stateChangeTime>
    <interruptAction>IGNORE</interruptAction>
</Media>

Response if the agent is not assigned to skill groups in the Media Routing Domain: 

<Media>
 <uri>/finesse/api/User/1001004/Media/5002</uri>
   <description>Chat MRD</description>
   <id>5002</id>
   <interruptible>false</interruptible>
   <name>Cisco_Chat_MRD2</name>
</Media>

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>