Versions Compared

Key

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

Returns chat transcript before the specified timestamp

Status
colourGreen
titleHTTP GET
livechat/:domain/getChatTranscriptByDate/:ts

Path Variables:

Name

Mandatory

Type

Description

domain

Status
colourRed
titleyes

Status
titlestring

Unique domain identifier

ts

Status
colourRed
titleYES

Status
titleSTRING

timestamp before which to retrieve chat transcripts

Authorization: see Authentication mechanisms

Response:

Type:
Status
titleJSON

Name

Type

Description

result

Status
titleboolean

If true, the service response was performed correctly

chatTranscripts

Status
titleobject

An object that contains the

chat transcripts

Transcript Object retrieved

error

Status
titlenull
/
Status
titlestring

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

Example:

Request

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

...

1569248216650

Response

Code Block
languagejson
{ 
   "result":true,
   "chatTranscripts":[ 
      { 
         "result":true,
         "transcript":{ 
            "messages":[ 
               { 
                  "data":{ 
                     "id":"5331c71f-46e7-4f5c-acbb-d7d0eaf0813c",
                     "messageType":"TEXT",
                     "content":{ 
                        "text":"hello",
                        "user":{ 
                           "id":"USER_gverde1@acd.enghouse.com",
                           "isAgent":true
                        }
                     },
                     "ts":1569248116642
                  },
                  "_id":"5d88d3951190da27f4fecedb",
                  "room":"CHAT_0addc50f-6866-40d1-bcbd-9da802c3fb9e"
               },
               { 
                  "data":{ 
                     "id":"cb34571c-ce74-4b21-a297-28311cf50c2e"a3a15ff2-7de3-4677-bfce-1a3ed26097e3",
                     "messageType":"TEXT",
                     "content":{ 
                        "text":"hi",
                        "user":{ 
                           "id":"USER_c8e1eb84-60d3-4d69-b10b-96364845023e",
                           "isAgent":false
                        }
                     },
                     "ts":1569248120015
                  },
                  "_id":"5d88d3951190da27f4feceda",
                  "room":"CHAT_0addc50f-6866-40d1-bcbd-9da802c3fb9e"
               },
               { 
                  "data":{ 
                     "id":"ea10e6ef-e461-4a95-aeeb-22eb1cfe2de5",
                     "messageType":"IMAGE",
                     "ts":1568970399937.01569248133529
                  },
                  "_id":"5d88d3951190da27f4feced9",
                  "room":"CHAT_0addc50f-6866-40d1-bcbd-9da802c3fb9e"
               },
               { 
                  "data":{ 
                     "id":"d0f9d131-29ef-41f0-b2ed-0d90bf769d6c",
                     "messageType":"TEXT",
                     "content":{ 
                        "text":"bye",
                        "user":{ 
                           "id":"USER_gverde1@acd.enghouse.com",
                           "isAgent":true
                        }
                     },
                     "ts":1569248144629
                  },
                  "_id":"6n8ds3e43bcb9e40e0435g245d88d3951190da27f4feced8",
                  "room":"CHAT_686ffd840addc50f-74fd6866-4f1840d1-a5d1bcbd-9537ffd04acf9da802c3fb9e"
               }
            ],
            "_id":"5d7bb2353bcb9e40e0330a725d88d3951190da27f4feced7",
            "room":"CHAT_686ffd840addc50f-74fd6866-4f1840d1-a5d1bcbd-9537ffd04acf9da802c3fb9e",
            "__v":0
         }
      },
      { 
         "result":true,
         "transcript":{ 
            "messages":[ 
               { 
                  "data":{ 
                     "id":"551b9dbc-8de8-46a1-89c4-b617f9d7e98e",
                     "messageType":"TEXT",
                     "content":{ 
                        "text":"hello there",
                        "user":{ 
                           "id":"USER_c8e1eb84-60d3-4d69-b10b-96364845023e",
                           "isAgent":false
                        }
                     },
                     "ts":1569248228779
                  },
                  "_id":"5d88d3f91190da27f4fecee2",
                  "room":"CHAT_4910ea9a-0e43-4dea-9418-fb913cbf9a64"
               },
               { 
                  "data":{ 
                     "id":"e34246cf-e057-44e7-ba5b-45cd5be4c55f",
                     ":"15f8fe7c-c7c6-4136-8a9a-5bbaadd167b0messageType":"TEXT",
                     "content":{ 
                        "text":"hello",
                        "user":{ 
                           "id":"USER_gverde1@acd.enghouse.com",
                           "isAgent":true
                        }
                     },
                     "ts":1569248236845
                  },
                  "_id":"5d88d3f91190da27f4fecee1",
                  "room":"CHAT_4910ea9a-0e43-4dea-9418-fb913cbf9a64"
               },
               { 
                  "data":{ 
                     "id":"44c1c289-941a-4680-829f-9ea3757b7b78",
                     "messageType":"IMAGE"TEXT",
                     "content":{ 
                        "text":"bye",
                        "user":{ 
                           "id":"USER_c8e1eb84-60d3-4d69-b10b-96364845023e",
                           "isAgent":false
                        }
                     },
                     "ts":15683883137211569248242051
                  },
                  "_id":"5d7bb4e43bcb9e40e0330a755d88d3f91190da27f4fecee0",
                  "room":"CHAT_a2901b374910ea9a-66bb0e43-49d04dea-a0419418-b84bb8f421c4fb913cbf9a64"
               }
            ],
            "_id":"5d7bb4e43bcb9e40e0330a745d88d3f91190da27f4fecedf",
            "room":"CHAT_a2901b374910ea9a-66bb0e43-49d04dea-a0419418-b84bb8f421c4fb913cbf9a64",
            "__v":0
         }
      }
   ],
   "error":null
}

...