Generic API

Generic CTI Methods

Cti.getList(objectType)

Request a list of configuration objects, objectType can be :

  • queue

  • agent

  • queuemember

Triggers handlers QUEUELIST, AGENTLIST, QUEUEMEMBERLIST. Subscribes to configuration modification changes, handlers QUEUECONFIG, AGENTCONFIG, QUEUEMEMBER can also be called

Generic CTI Events

Error

  • Cti.MessageType.ERROR

Is triggered whenever service answered abnormally to the request.

LoggedOn

  • Cti.MessageType.LOGGEDON

Is triggered once a user is properly authenticated and logged in.

LoggedOnError

  • Cti.MessageType.LOGGEDONERROR

Is triggered when the CTI session establishment fails after a WebSocket connection. The WebSocket connection is closed immediately after this message is sent.

Two error codes are possible:

loggedOnFailed

Triggered when the CTI session establishment fails abnormally.

{
  "msgType": "LoggedOnError",
  "ctiMessage": {
    "Error": "loggedOnFailed"
  }
}

loggedOnTimeout

Triggered when the CTI session is not established within the configured delay after the WebSocket connection. The default timeout is 10 seconds, configurable via the XUC_CTI_LOGGED_ON_TIMEOUT environment variable (config key: xivocti.loggedOnTimeout).

{
  "msgType": "LoggedOnError",
  "ctiMessage": {
    "Error": "loggedOnTimeout"
  }
}