Feature | Version | |
---|---|---|
web-chat | 2 |
Feature | Version | |
---|---|---|
web-chat | 2 |
Required
The name of the participant joining the chat.
A destination email address to send a transcript of the chat session to. Omit if a transcript is not required.
Required
A destination user, workgroup or station name to route the chat to.
Required
Indicates the type of queue specified in the targetName
property. Can be Workgroup
, User
, Station
or System
.
Indicates the language of the client performing the request.
Criteria to be used for interaction routing.
For information about the standard attributes defined by the Interaction Center System, see the "Interaction Attributes Technical Reference"
in the Interaction Center Documentation Library. This document describes the attributes and the format of their values.
Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.The notes to associate with the chat interaction.
Chat history associated with a previous interaction.
Required
The UTC timestamp representing when the event occurred.Required
Chat history item sender.Required
Participant type. Possible examples may include WebUser, Agent, or System.Required
Chat history item message content.Webhook endpoint for event notifications.
Feature | Version | |
---|---|---|
web-chat | 5 |
The chat was created successfully.
The response will include information that the client needs to interact with the chat. This includes information such as the participant ID, the chat ID and the date and time formats to be used client side.
Required
The JSON type representing this option.Required
The suggested interval (in milliseconds) at which the client should make polling requests about the chat session.
Required
The participant ID which was generated on behalf of the client making the request. This should be stored by the client and used for subsequent requests to endpoints that require a participant ID.
Required
The ID of the chat session that was created. This should be stored by the client and used if a reconnect needs to occur.
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.