User API Errors

Status

Error Type

Description

400

Bad Request

The request is malformed or incomplete or the extension provided is invalid.

400

Generic Error

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

400

Invalid Input

One of the parameters provided as part of the user input is invalid or not recognized (for example, the mode for a mobile agent or the state for a user)

400

Invalid State

The requested state change is not allowed (for example, a user in LOGOUT state requests a state change to LOGOUT or a supervisor tries to change an agent's state to something other than READY or LOGOUT).

400

Parameter Missing

The extension, state, or requestedAction is not provided.

If signing in a mobile agent, the mode or dialNumber is 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.

401

Invalid State

A user tried to change to a state that is not supported in the scenario.

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

User Not Found

The user ID provided is invalid or is not recongnized. No such user exists in CTI.

500

Internal Server Error

Any runtime exception is caught and responded with this error.

503

Service Unavailable

A dependent service is down (for example, the Cisco Finesse Notification Service or Cisco Finesse Database). Finesse is OUT_OF_SERVICE.