Terminates an active chat.
| Status | ||||
|---|---|---|---|---|
|
Path Variables:
Name | Mandatory | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
domain |
|
| Unique domain identifier |
Authorization: see Authentication mechanisms
Request Body:
Type:
| Status | ||
|---|---|---|
|
Name | Mandatory | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
chatID |
|
| Unique Chat identifier | ||||||||||
reason |
|
| Reason for closing the chat. Any reason different from “success” is considered a failure reason |
Response:
Type:
| Status | ||
|---|---|---|
|
Name | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
result |
| If true, the service response was performed correctly | ||||||||
error |
| Contains the error description if an error has occurred in the request |
Example:
Request
http://<hostname>:<port>/livechat/default/endContactByChatID
Request body
| Code Block | ||
|---|---|---|
| ||
{
"chatID" : "CHAT_1b434365-0229-4b64-a56c-2942cae63a90",
"reason" : "success"
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"result": true,
"error": null
} |