Versions Compared

Key

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

Returns the data collections for the specified currently active chat.

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

Path Variables:

Name

Mandatory

Type

Description

domain

Status
titleno

Status
titlestring

Unique domain identifier

chatId

Status
colourRed
titleYES

Status
titleSTRING

Unique Chat identifier

Headers:

Name

Mandatory

Type

Description

ctlivetoken

Status
colourRed
titleYES

Status
titleSTRING

Unique ctlive session identifier

Response:

Type:
Status
titleJSONP

Name

Type

Description

result

Status
titleBOOLEAN

If true, the service response was performed correctly

datacollections

Status
titleNULL
/
Status
titleOBJECT

An object that contains the Data Collection Object configured for the service with the customer responses

error

Status
titleNULL
/
Status
titleSTRING

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

Example:

Request

http://<hostname>:<port>/livechat/default/getDataCollectionByChatID/CHAT_456c6db0-29e8-4c87-b31a-4b2cf129243e

...