ECC and Call Variable Error Handling

When a client makes an invalid update request for a ECC or call variable, that request is sent to Finesse and then to the CTI server. The CTI server logs certain errors but does not return events for them. In these cases, Finesse does not return an error. Clients must be aware of this behavior and follow the appropriate Unified CCE/Unified CCX documentation.

A client can also send an update request for an ECC or call variable that contains both valid and invalid data (that is, some of the ECC or call variable updates in the request payload are valid while others are invalid). See the following table to determine the response from Finesse in these error scenarios.

Error Scenario

CTI Server Response

Finesse Response

  1. A request was sent that generates an error from the CTI server to Finesse.
  2. The request payload contained no valid ECC or call variables.

The CTI server sends an error to Finesse.

Finesse forwards the error to the client.

  1. A request was sent that generates an error from the CTI server to Finesse.
  2. The request payload contained a mix of valid and invalid ECC or call variables.
  1. The CTI server sends an error to Finesse.
  2. The CTI server does not send an UPDATE_CALL_DATA event to Finesse (that is, the CTI server fails the entire request).
  1. Finesse forwards the error to the client.
  2. The client does not receive an UPDATE_CALL_DATA event.
  1. A request was sent that does not generate an error from the CTI server to Finesse.
  2. The request payload contained no valid ECC or call variables.

The CTI server does not respond.

Finesse does not respond.

  1. A request was sent that does not generate an error from the CTI serverto Finesse.
  2. The request payload contained a mix of valid and invalid ECC or call variables.
  1. The CTI server does not send an error to Finesse.
  2. The CTI server sends an UPDATE_CALL_DATA event to Finesse for the valid ECC and call variables.
  1. Finesse does not forward an error to the client.
  2. Finesse forwards the UPDATE_CALL_DATA event to the client.
Note

When the size of the value of an ECC variable name exceeds its maximum length, the CTI server silently truncates the value and updates the variable. As a result, Finesse does not receive a maximum length error.

Users of this API must ensure that the variables they are trying to update exist. Users must follow the exact format of each variable and ensure that the maximum size is not exceeded.