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