/icws/web-chat/start

Feature Version
web-chat 2

POST

/icws/web-chat/start

Starts a chat.
Feature Version
web-chat 2

Request

This request has no parameters.
Representations
startChatRequest
An object representing a request to initiate a chat.
Property
Value
Comments
participantName
String

Required

The name of the participant joining the chat.

transcriptEmailAddress
String

A destination email address to send a transcript of the chat session to. Omit if a transcript is not required.

targetName
String

Required

A destination user, workgroup or station name to route the chat to.

targetType
String

Required

Indicates the type of queue specified in the targetName property. Can be Workgroup, User, Station or System.

language
String

Indicates the language of the client performing the request.

context
String
Routing context.
category
Int
Routing context category.
[key]
String

Required

The key identifying this pair.
[value]
String

Required

The value of this pair.
notes
String

The notes to associate with the chat interaction.

timestamp
String

Required

The UTC timestamp representing when the event occurred.
displayName
String

Required

Chat history item sender.
participantType
String

Required

Participant type. Possible examples may include WebUser, Agent, or System.
message
String

Required

Chat history item message content.
webhook
String

Webhook endpoint for event notifications.

Feature Version
web-chat 5

Response

200 - OK

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.

startChatResponse
An object representing a response to initiate a chat.
Property
Value
Comments
__type
"urn:inin.com:webChat:startChatResponse"

Required

The JSON type representing this option.
pollWaitSuggestion
String

Required

The suggested interval (in milliseconds) at which the client should make polling requests about the chat session.

participantId
String

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.

chatId
String

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.

400 - Bad Request
This may indicate that the chat was not able to be started.
error
Provides additional detail for an error.
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
410 - Gone
This resource has been deprecated and removed from the API.
error
Provides additional detail for an error.
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
500 - Internal Server Error
An unexpected error occurred while processing the request.
error
Provides additional detail for an error.
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.