Отримати повідомлення чату

Отримайте всі повідомлення з будь-якого чату
Написано Микола
Оновлено 8 місяців тому

Ви можете отримати всі повідомлення з будь-якого чату за його id. Для пошуку чату за його атрибутами використовуйте метод Знайти чати.

➡️ Запит

URL https://api.helpcrunch.com/v1/chats/<chat_id>/messages
Метод GET
Headers Authorization: Bearer <your_api_key>

<chat_id> – це ідентифікатор чату, наданий HelpCrunch. Він обов’язковий для цього методу і виглядає як комбінація чисел (наприклад, 1568834).

✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код успішного статусу 200 OK разом із наведеним нижче тілом відповіді.

{
  "data": [
    {
      "id": 542335,
      "agent": {
        "id": 542335,
        "name": "string",
        "email": "string",
        "role": "string"
      },
      "type": "tech",
      "text": "string",
      "read": true,
      "createdAt": "1603885746",
      "updatedAt": "1603885746",
      "edited": true,
      "broadcastType": "trigger",
      "chat": 542335,
      "from": "agent"
    }
  ],
  "total": 543
}

Усі повідомлення сортуються за датою createdAt у порядку спадання, тобто останнє повідомлення з чату буде першим у відповіді.

Ви можете отримати деталі по кожному полю обʼєкту повідомлення у статті Модель даних повідомлення.

Як отримати всі повідомлення

За замовчуванням цей метод повертає останні 100 повідомлень із чату. Щоб отримати інший набір повідомлень, слід використовувати параметри offset та limit у рядковому запиті запиту GET.

Ліміт за замовчуванням становить 100 і він не може бути більшим за це. Зміщення за замовчуванням - 0.

Щоб переглянути всі доступні повідомлення, спочатку використовуйте атрибут total відповіді JSON, щоб отримати загальну кількість повідомлень.

Потім надсилайте наступні запити зі зростаючими зміщеннями та фіксованим лімітом, доки не отримаєте всі дані.

https://api.helpcrunch.com/chats/1568834/messages?offset=100&limit=100
https://api.helpcrunch.com/chats/1568834/messages?offset=200&limit=100
https://api.helpcrunch.com/chats/1568834/messages?offset=300&limit=100
...

Загальний ліміт запитів становить 120 запитів за хвилину.

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді. Детальніше про коди помилок ви можете прочитати за посиланням.

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "customer",
      "message": "This value should be of type numeric."
    },
    {
      "code": "filter[0].field",
      "message": "This value should not be blank."
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "unauthorized",
      "message": "Unauthorized"
    }
  ]
}

429 Too Many Requests

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "too_many_requests",
      "message": "Too many requests"
    }
  ]
}
Чи була наша стаття корисною?