Request

InitConnection

This request is needed only for clients that cannot send websocket headers. It can include the authentication and the clientProperties information. Please refrain from submitting any other requests until a response to this one is received, as any requests will be rejected.

Request ID generated by the client. It should be unique per WebSocket session in order to identify the request. This ID will be reflected by the server in the response to the request.

Contains one of the APIs request type names

headers

UpdateConversationField

Request ID generated by the client. It should be unique per WebSocket session in order to identify the request. This ID will be reflected by the server in the response to the request.

Contains one of the APIs request type names

body

Updates conversation metadata like: state, CSAT, TimeToRespond police etc... Consumer and agent might have different permissions.

conversationField

StateChange

CsatChange

Consumer satisfaction information. The data that was submitted by the consumer after the conversation was closed.

JSON Output

valid

JSON Schema

You can find the json schema definition of this message here: assets/schema/ws/consumerRequests.json

Response

root

General response message with string description.

Defines that the message is a response

The ID of the request that originated this response

Contains one of the APIs response type names

Response code according to the HTTP status codes standard

Optional text description for the response

JSON Output

valid

JSON Schema

You can find the json schema definition of this message here: assets/schema/infra/stringResp.json