Versions Compared

Key

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

Returns the contact object of a currently active chat.

Status
colourGreen
titleHTTP GET
/livechat/:domain/getContactByChatID/:chatId

Path Variables:

Name

Mandatory

Type

Description

domain

Status

colour

Red

title

yes

no

Status
titlestring

Unique domain identifier

chatId

Status
colourRed
titleYes

Status
titleSTRING

Unique Chat identifier

Response:

Type:
Status
titleJSONP

Name

Type

Description

result

Status
titleBOOLEAN

If true, the service response was performed correctly

contact

Status
titleNULL
/
Status
titleOBJECT

The current Contact Object with chat partecipants info, data collections and calldata variables

error

Status
titleNULL
/
Status
titleSTRING

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

Example:

Request

http://<hostname>:<port>/livechat/default/getContactByChatID/CHAT_fef5015b-8102-457e-b69b-471a55487837

...