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

« Previous Version 4 Current »

Sends a text message to an active chat.

HTTP POST /livechat/:domain/sendTextMessageToActiveChat/:chatId

Path Variables:

Name

Mandatory

Type

Description

domain

NO

STRING

Unique domain identifier

chatId

YES

STRING

Unique chat identifier

Authorization: BASIC AUTH

Request Body:

Type: JSON

Name

Mandatory

Type

Description

text

YES

STRING

Text message to send in chat

nickname

NO

STRING

User nickname

Response:

Type: JSON

Name

Type

Description

result

BOOLEAN

If true, the service response was performed correctly

error

NULL / STRING

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

Example:

Request

http://<hostname>:<port>/livechat/default/sendTextMessageToActiveChat/CHAT_DEFAULT_966afd14-9bdc-4246-84f7-035d6eb54d9a

Request body

{
  "text": "This is a new message from API",
  "nickname":"Lando Calrissian"
}

Response

{
    "result": true,
    "error": null
}

  • No labels