Versions Compared

Key

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

Terminates all active chats for the domain specified.

...

Status
colourYellow
titleHTTP POST
/livechat/:domain/endAllContacts

Path Variables:

Name

Mandatory

Type

Description

domain

Status
titleNO

Status
titleSTRING

Unique domain identifier

Authorization: StatustitleBASIC AUTHsee Authentication mechanisms

Response:

Type:
Status
titleJSON

Name

Type

Description

result

Status
titleBOOLEAN

If true, the service response was performed correctly

contacts

Status
titlearray

contains the list of the IDs of the chat terminated

error

Status
titleNULL
/
Status
titleSTRING

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

Example:

Request

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

...