Media and Dialogs/Media Asynchronous Error Notification

If an operations performed on a Media or nonvoice Dialog results in an asynchronous error, the error notifications include the error type, error code, and error constant. The ErrorMedia parameter indicates the Media Routing Domain to which the error applies.

Format:

XML

Node:

/finesse/api/User/{id}/Media

/finesse/api/User/{id}/Dialogs/Media

Source:

/finesse/api/User/{id}/Media/{mrdId}

/finesse/api/User/{id}/ Media/{mrdId}/Dialogs (when a Dialog is added or removed from the Dialog collection for the user, for example offered or closed.)

/finesse/api/Dialog/{id} (when a Dialog within the Dialogs collection for the user is modified, for example accepted, started, paused, or wrapped up.)

Data:

Media

Dialog

Payload:

Code Snippet
Copy
<Update>
  <data>
    <apiErrors>
      <apiError>
        <errorData>[Error Code]</errorData>
        <errorMedia>5001</errorMedia>
        <errorMessage>[Error Constant]</errorMessage>
        <errorType>[Error Type]</errorType>
      </apiError>
    </apiErrors>
  </data>
  <event>PUT</event>
  <requestId>xxx-xxxx</requestId>
  <source>/finesse/api/User/{id}/Media/{mrdId}</source>
</Update>

Sample Notification Payload:

Code Snippet
Copy
<Update>
  <data>
    <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>
  </data>
  <event>PUT</event>
  <requestId>xxx-xxxx</requestId>
  <source>/finesse/api/User/1001001/Media/5001</source>
</Update>

Notification Triggers:

The notification system returns this error if an operation on a Media or nonvoice Dialog results in an asynchronous error.