Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Terminates an active chat.

Status
colourYellow
titleHTTP POST
/livechat/:domain/endContactByChatID

Path Variables:

Name

Mandatory

Type

Description

domain

Status
titleno

Status
titlestring

Unique domain identifier

...

Name

Mandatory

Type

Description

chatID

Status
colourRed
titleYES

Status
titleSTRING

Unique Chat identifier

reason

Status
colourRed
titleYES

Status
titleSTRING

Reason for closing the chat. Any reason different from “success” is considered a failure reason

Response:

Type:
Status
titleJSON

...

Code Block
languagejson
{
	"chatID" : "CHAT_1b434365-0229-4b64-a56c-2942cae63a90",
	"reason" : "success"
}

Response

Code Block
languagejson
{
    "result": true,
    "error": null
}