Versions Compared

Key

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

Returns chat transcript between a specified time range and for an optional specified service id.

Status
colourYellow
titleHTTP POST
/livechat/:domain/getChatTranscriptByTimeRangeAndServiceID

Path Variables:

Name

Mandatory

Type

Description

domain

Status
colourRed
titleYES

Status
titleSTRING

Unique domain identifier

Headers:

Name

Mandatory

Type

Description

ctlivetoken

Status
colourRed
titleYES

Status
titleSTRING

Unique ctlive session identifier

Request Body:

Type:
Status
titlejson

Name

Mandatory

Type

Description

beginTime

Status
colourRed
titleyes

Status
titlenumber

Begin time range. Timestamp in UTC format

endTime

Status
colourRed
titleyes

Status
titleNumber

End time range. Timestamp in UTC format

serviceID

Status
titleno

Status
titlestring

Unique service identifier

Response:

Type:
Status
titleJSON

Name

Type

Description

result

Status
titleboolean

If true, the service response was performed correctly

chatTranscript

Status
titlearray

Array that contains Transcript Object

error

Status
titlenull
/
Status
titlestring

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

Example:

Request

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

...