/
endContactByChatID
endContactByChatID
Terminates an active chat.
status:HTTP POST /livechat/:domain/endContactByChatID
Path Variables:
Name | Mandatory | Type | Description |
---|---|---|---|
domain | status:no | status:string | Unique domain identifier |
Authorization: see Authentication mechanisms
Request Body:
Type: status:JSON
Name | Mandatory | Type | Description |
---|---|---|---|
chatID | status:YES | status:STRING | Unique Chat identifier |
reason | status:YES | status:STRING | Reason for closing the chat. Any reason different from “success” is considered a failure reason |
Response:
Type: status:JSON
Name | Type | Description |
---|---|---|
result | status:BOOLEAN | If true, the service response was performed correctly |
error | status:NULL / status: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
}
, multiple selections available,
Related content
getContactByChatID
getContactByChatID
More like this
getContactTranscriptByChatID
getContactTranscriptByChatID
More like this
endAllContacts
endAllContacts
More like this
getChatTranscriptByChatID
getChatTranscriptByChatID
More like this
getChatTranscriptByCalldata
getChatTranscriptByCalldata
More like this
sendExternalTextMessageToActiveChat
sendExternalTextMessageToActiveChat
More like this