Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Terminates all active chats for the domain specified.

HTTP POST /livechat/:domain/endAllContacts

Path Variables:

Name

Mandatory

Type

Description

domain

NO

STRING

Unique domain identifier

Authorization: BASIC AUTH

Response:

Type: JSON

Name

Type

Description

result

BOOLEAN

If true, the service response was performed correctly

contacts

ARRAY

contains the list of the IDs of the chat terminated

error

NULL / STRING

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

Example:

Request

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

Response

{
    "result": true,
    "contacts": [
        "CHAT_DEFAULT_72d65373-16af-46ed-a419-65bfd6c8e378",
        "CHAT_DEFAULT_b1b0817c-c357-409f-b05d-98c4ac7b162b",
        "CHAT_DEFAULT_7ab61240-7063-404f-8cef-ca12ae9aed76"
    ],
    "error": null
}

  • No labels