Dialog CTI Error Notification

Call operations performed on a dialog (such as MAKE_CALL, HOLD, RETRIEVE, ANSWER, END, TRANSFER, CONSULT, and CONFERENCE) may result in CTI errors. The notification system sends these errors as asynchronous updates. Error notifications include the error type and the CTI error code and error constant. The error type is "Call Operation Failure".

Format:

XML

Node:

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

Source:

/finesse/api/Dialog/{id}

Data:

apiErrors

Payload:

Code Snippet
Copy<Update>
    <data>
        <apiErrors>
            <apiError>
                <errorData>[CTI Error Code]</errorData>
                <errorMessage>[CTI Error Constant]</errorMessage>
                <errorType>Call Operation Failure</errorType>
            </apiError>
        </apiErrors>
    </data>
    <event>PUT</event>
    <requestId></requestId>
    <source>/finesse/api/Dialog/[ID]</source>
</Update>

Sample Notification Payload

Code Snippet
Copy<Update>
   <data>
      <apiErrors>
          <apiError>
              <errorData>34</errorData>
              <errorMessage>CF_RESOURCE_OUT_OF_SERVICE</errorMessage>
              <errorType>Call Operation Failure</errorType>
          </apiError>
      </apiErrors>
   </data>
   <event>PUT</event>
   <requestId></requestId>
   <source>/finesse/api/Dialog/12345</source>
</Update>

Notification Triggers:

The notification system delivers this error notification if call operations on a Dialog (such as MAKE_CALL, HOLD, RETRIEVE, ANSWER, END, TRANSFER, CONSULT, and CONFERENCE) result in a CTI error

Asynchronous Errors

Note

When accessing the Finesse REST API through the Finesse JavaScript library, asynchronous errors have a status code of 400. When receiving the asynchronous error directly through XMPP, the error message has the format described in the description above for Dialog CTI Error Notification.

ErrorType Reason Deployment Type

Call Operation Failure

Attempt to exceed maximum allowed conference participants.

Unified CCE