Terminates an active chat.
| Status |
|---|
| colour | Yellow |
|---|
| title | HTTP POST |
|---|
|
/livechat/:domain/endContactByChatIDPath Variables:
Name | Mandatory | Type | Description |
|---|
domain | |
colour | RedyesAuthorization: see Authentication mechanisms
Request Body:
Type:
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:
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
...
| Code Block |
|---|
|
{
"chatID" : "CHAT_1b434365-0229-4b64-a56c-2942cae63a90",
"reason" : "success"
} |
Response
| Code Block |
|---|
|
{
"result": true,
"error": null
} |