Configuring error messages
Configure the display of a message on the CSR desktop when an error occurs in a desktop request from the Call Control Panel to the Computer Telephony Integration (CTI) server.
Every error object has the following properties:
- errCode
- A CTI server-specific error code for the received error.
- errMessage
- A brief description of the error.
When the CTI server returns an error message, you can map the error code to the message rule that you create in the Pega Platform layer so that you can the efficiently locate the error.
Pega Call maps the error code with the translated error message, and then sends the message to the desktop.
If the translation does not exist, Pega Call displays the text that you passed in the errMessage property in the error object.
The following table describes the default Pega Call error messages.
Pega Call default error messages
Error code | Error message |
OPENCTI_AGENT_LOGGED_IN | An agent is logged in from another device. |
OPENCTI_AGENT_NOT_LOGGED_IN | An agent is not logged in from any device. |
OPENCTI_CALL_REJECTED | A call request is rejected. |
OPENCTI_CF_GENERIC_OPERATION | An operation error occurred. |
OPENCTI_CF_INVALID_DESTINATION | The request specified an invalid destination. |
OPENCTI_CF_INVALID_OBJECT_STATE | The object is not in the correct state to serve the request. |
OPENCTI_CONF_ALREADY_PRESENT | The party in the request is already in conference. |
OPENCTI_DEST_BUSY | The call attempted is to a busy destination. |
OPENCTI_HTTP_ERROR_401 | Authentication failed or not provided or server refused to respond. |
OPENCTI_HTTP_ERROR_404 | The requested resource not found. |
OPENCTI_HTTP_ERROR_405 | The method not supported. |
OPENCTI_HTTP_ERROR_408 | The server timed out. Waiting for request. |
OPENCTI_HTTP_ERROR_500 | Internal server error. |
OPENCTI_HTTP_ERROR_502 | Bad gateway. Gateway received invalid response from the server. |
OPENCTI_HTTP_ERROR_503 | The server is out of service. |
OPENCTI_HTTP_ERROR_504 | The gateway timed out. |
OPENCTI_IN_SAME_STATE | The agent is already in the requested state. |
OPENCTI_INV_ACTIVE_STATE | The call is no longer in an active state. |
OPENCTI_INV_AGENT_ID | AgentID is invalid. |
OPENCTI_INV_AGENT_STATE | The agent is in invalid state for the requested operation. |
OPENCTI_INV_AGENTID_OR_PASSWORD | The request specified has an invalid AgentID or an invalid agent password or both. |
OPENCTI_INV_CALL_DN | The device number (DN) in the request is invalid. |
OPENCTI_INV_CALL_STATE | The party in the request call state is invalid. |
OPENCTI_INV_DEST_DN | The destination device number (DN) in the request is invalid. |
OPENCTI_INV_DN_TYPE | The DN type is invalid. |
OPENCTI_INV_LOGIN_REQ | Agent cannot log in at this time. |
OPENCTI_INV_LOGON_DEVICE | The login device that is specified in the request is invalid. |
OPENCTI_INV_LOGOUT_REQ | The agent cannot log out at this time. |
OPENCTI_INV_NOTREADY_REQ | The agent cannot change to the NotReady state. |
OPENCTI_INV_NUMBER | The requested number is invalid. |
OPENCTI_INV_PASSWORD | Invalid password. |
OPENCTI_INV_READY_REQ | The agent cannot change to the Ready state. |
OPENCTI_INV_REASON_CODE | The reason code that is specified in the request does not exist. |
OPENCTI_LINK_UNAVAILABLE | The link is in the Unavailable state. |
OPENCTI_OUTSTANDING_REQ | A similar request still in progress. |
OPENCTI_PARTY_NOT_ON_CALL | The party is not currently on call. |
OPENCTI_REASON_CODE_REQUIRED | The state change requires a valid reason code. |
OPENCTI_UNKNOWN_ERROR | Unspecified error in client's request. |
- Create a new JavaScript object instance of pega.cti.desktopApi.errorObject.
- Map the error message to the JavaScript object properties.
- Forward the error object to the failure callback function of the request function.
Previous topic PartyInfo event schema Next topic CTI functions