Agent Private Message
  • 28 Jul 2022
  • 1 Minute to read
  • Dark

Agent Private Message

  • Dark

Article Summary

Agent Private Message

Agent Private Message JSON Format

Agent Private Message is represented as simple flat JSON objects with the following keys:

idintegerId of the private message.
formAgentIdguidId of the sender agent.
toAgentIdguidId of the recipient agent.
contentstringContent of the private message.
attachmentFileKeystringKey value of the attachment.
timedatetimeTime of the private message.

Search Agent Private Messages

POST livechat/agentPrivateMessages:Search

  • Parameters:

pageIndexintegerquerynoPage index.
filtersarraybodyYesFilter array. Available items are: time, agent,keywords.
pageSizeintegerquerynoPage size.
includestringquerynoAvailable values for Include are: "fromAgent", "toAgent".
  • Response:

An array of Agent Private Message

  • Example

Sample Request:

curl \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"filters":[{"name":"time","operator":"is","value":["2021-04-24T07:00:00.000Z","2021-04-25T07:00:00.000Z"]},{"name":"keywords","operator":"is","value":["hello"]}]}' 


HTTP/1.1 200 OK

  "total": 1,
  "pageCount": 1,
  "list": [
          "id": 42,
          "fromAgentId": "ebb24a78-8eb6-43de-bcbb-199a94538fd5",
          "toAgentId": "803b0838-eb75-481c-a0ea-bc7a75ff0564",
          "text": "hello",
          "messageType": "text",
          "attachmentFileKey": "",
          "time": "2021-11-25T10:35:40.6472696Z"
  "pageIndex": 0,
  "pageSize": 10

Was this article helpful?