Dialog API Errors

Status

Error Type

Description

400

20700 (conference resource limit violation)

The barge call will cause the total number of parties on the conference call to exceed the allowed resource limit for the conference bridge.

400

20999 (Barge via a non-conference-controller)

The agent specified in the toAddress is not the controller of the conference call or the agent already has an outstanding conference call.

400

Generic Error

An unaccounted for error occurred. The root cause could not be determined.

400

Invalid Destination

The toAddress and fromAddress are the same (if users attempt to call their own extension).

For the Dialog—Drop Participant from Conference API, this error occurs if the targetMediaAddress is not one of the parties on the call or is not an agent extension.

For the Dialog—Make a Barge Call API, this error occurs if the supervisor tries to barge in on an agent call when the agent's extension is in HELD state.

400

Invalid Input

One of the parameters provided as part of the user input is invalid or not recognized (for example, the fromAddress, toAddress, targetMediaAddress, requestedAction).

For the Dialog—Update Call Variable Data API, the call variable name or action is invalid or not recognized, or there are duplicate call variable names.

This error is also returned if a user attempts to set any of the following Outbound Option variables: BACampaign, BAAccountNumber, BAResponse, BAStatus, BADialedListID, BATimeZone, BABuddyName, BACustomerNumber (Unified CCX only).

400

Invalid State

A supervisor who is already on an active call (in TALKING or HOLD state) makes a silent monitor request.

400

Parameter Missing

A required parameter was not provided in the request.

For example, if creating a dialog, the fromAddess or toAddress was not provided.

401

Authorization Failure

Unauthorized (for example, the user is not yet authenticated in the Web Session).

The user is not authorized to use the API (for example, an agent tries to use an API that only a supervisor or administrator is authorized to use).

401

Invalid Authorization User Specified

The authenticated user tried to make a request for another user.

The authenticated user tried to use a fromAddress that does not belong to that user.

401

Invalid State

The targetMediaAddress in a Dialog—Start Recording request specifies an extension of a participant in HELD state.

401

Invalid Supervisor

A supervisor tried to change the state of an agent who does not belong to that supervisor's team.

404

Not Found

The resource specified is invalid or does not exist.

404

Dialog Not Found

The dialogId provided is invalid or no such dialog exists.

500

Internal Server Error

Any runtime exception is caught and responded with this error.

501

Not Implemented

A user attempted to use the API in a deployment where it is not supported.

For example, a recording attempt was made in a Unified CCE deployment.

503

Service Unavailable

The required service is unavailable. For example, the Notification Service is not running.