Versions Compared

Key

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

Sends a text message to an active chat.

...

Status
colourYellow
titleHTTP POST
/livechat/:domain/sendTextMessageToActiveChat/:chatId

Path Variables:

Name

Mandatory

Type

Description

domain

Status
titleNO

Status
titleSTRING

Unique domain identifier

chatId

Status
colourRed
titleyes

Status
titlestring

Unique chat identifier

Authorization: StatustitleBasic authsee Authentication mechanisms

Request Body:

Type:
Status
titleJSON

Name

Mandatory

Type

Description

text

Status
colourRed
titleYES

Status
titleSTRING

Text message to send in chat

nickname

Status
titleno

Status
titlestring

User nickname

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/sendTextMessageToActiveChat/CHAT_DEFAULT_966afd14-9bdc-4246-84f7-035d6eb54d9a

...