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

Authorization: StatustitleBASIC AUTHsee Authentication mechanisms

Request Body:

Type:
Status
titleJSON

Name

Mandatory

Type

Description

chatID

Status
colourRed
titleYES

Status
titleSTRING

Unique Chat identifier

Response:

Type:
Status
titleJSON

Name

Type

Description

result

Status
titleBOOLEAN

If true, the service response was performed correctly

error

Status
titleNULL
/
Status
titleSTRING

Contains the error description if an error has occurred in the request

Example:

Request

http://<hostname>:<port>/livechat/default/endContactByChatID

...