message

Return all messages for a particular user

get/v1/org/{orgId}/message/me

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/message/me
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

typestring

Message "type" (WEB, CHAT, or EMAIL)

unreadOnlyboolean

Message "status" (read or unread)

fromstring

MessageId to start paginating from

limitinteger

Limit

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "userId": "588f7ee98f138b19220041a7",
      "readAt": "2017-01-24T13:57:52Z",
      "seenAt": "2017-01-24T13:57:52Z",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      }
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 20 revisions of this API.