v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Ticket Messages

List messages

List messages matching the given parameters, paginated.

get/api/messages

Query parameters

cursorstring nullable

Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

Value indicating your position in the list of all messages. If omitted, the first messages of the list will be returned.

limitinteger

Maximum number of messages to return.

order_by'created_datetime:asc' | 'created_datetime:desc'

Attribute used to order messages.

ticket_idinteger nullable

Example:1

The ID of the ticket the messages are associated with.

Response

A list of messages.

objectstring required

uristring required

Example response

{
  "data": [
    {
      "id": 924712,
      "message_id": "<123345676453.2445.234@web>",
      "ticket_id": 12,
      "external_id": "MSG-78545",
      "public": true,
      "integration_id": 28643,
      "intents": [
        {
          "name": "discount/request"
        }
      ],
      "rule_id": 89465,
      "from_agent": true,
      "subject": "Re:Refund request",
      "body_text": "Hello,\n\n        I can't place an order on your site, it says: I don't have enough credit.\n        How can I add some credits?\n\n        Cheers,\n        John Doe\n        ",
      "body_html": "Hello,<br><br>\n\n            I can't place an order on your site, it says: I don't have enough credit.<br>\n            How can I add some credits?<br><br>\n\n            Cheers,<br>\n            John Doe\n            ",
      "attachments": [],
      "macros": [],
      "actions": [],
      "headers": {
        "My-Header": "foo"
      },
      "meta": {},
      "created_datetime": "2020-01-27T10:42:21.468912",
      "processed_datetime": "2020-01-27T10:42:21.468912",
      "deleted_datetime": "2020-01-27T10:42:21.468912",
      "opened_datetime": "2019-07-05T15:22:46.472436",
      "replied_by": {
        "integration_id": 28643,
        "created_datetime": "2020-01-27T10:42:21.468912",
        "body_text": "Hello,\n\n        I can't place an order on your site, it says: I don't have enough credit.\n        How can I add some credits?\n\n        Cheers,\n        John Doe\n        "
      },
      "replied_to": {
        "integration_id": 28643,
        "created_datetime": "2020-01-27T10:42:21.468912",
        "body_text": "Hello,\n\n        I can't place an order on your site, it says: I don't have enough credit.\n        How can I add some credits?\n\n        Cheers,\n        John Doe\n        "
      }
    }
  ]
}