Versions Compared

Key

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

Delete chat transcript before a specified timestamp

Status
colourYellow
titleHTTP POST
/livechat/:domain/deleteChatByDate

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

...

Authorization: see Authentication mechanisms

Request Body:

Type:

Status
titlejson

Name

Mandatory

Type

Description

ts

Status
colourRed
titleyes

Status
titlenumber

Timestamp before which to cancel chat

Response:

Type:
Status
titleJSONp

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/deleteChatByDate

...