Отримати всі чати

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

Ви можете отримати всі ваші чати або якусь кількість чатів за допомогою цього методу. Якщо ви хочете отримати лише один чат по його ID, використовуйте метод Отримати інформацію про чат. Для пошуку чату за його атрибутами використовуйте метод Знайти чати.

➡️ Запит

URL https://api.helpcrunch.com/v1/chats?sort=chats.closedAt&order=asc
Метод GET
Headers Authorization: Bearer <your_api_key>

Параметри сортування

Щоб відсортувати чати в порядку спадання, використовуйте параметр order=desc у рядку запиту. Для сортування у порядку зростання використовуйте order=asc.

Параметр сортування Опис
chats.createdAt за датою створення чату
chats.lastCustomerMessageAt за датою останнього повідомлення від клієнта
chats.lastMessageAt за датою останнього повідомлення від оператора або клієнта
chats.closedAt за датою закриття чатів

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

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

{
  "data": [
    {
      "id": 542335,
      "closedBy": "string",
      "lastCustomerMessageAt": "1603885746",
      "status": "new",
      "closedAt": "1603885746",
      "rating": "perfect",
      "createdAt": "1603885746",
      "lastMessageAt": "1603885746",
      "createdWith": "string",
      "snoozedUntil": "1603885746",
      "lastMessageText": "string",
      "lastMessageId": 542335,
      "applicationId": 542335,
      "lastCommunicatedAgentId": 542335,
      "agents": [
        {
          "id": 542335,
          "name": "string",
          "email": "string",
          "role": "string"
        }
      ],
      "customer": {
        "id": 542335,
        "name": "string",
        "email": "string",
        "userId": "string"
      },
      "assignee": {
        "id": 542335,
        "name": "string",
        "email": "string",
        "role": "string"
      },
      "department": {
        "id": 542335,
        "name": "string"
      }
    }
  ],
  "meta": {
    "total": 435
  }
}

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

Як отримати всі чати

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

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

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

Ви можете запитати .../chats/total щоб отримати лише загальну кількість чатів.

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

https://api.helpcrunch.com/chats?offset=100&limit=100
https://api.helpcrunch.com/chats?offset=200&limit=100
https://api.helpcrunch.com/chats?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"
    }
  ]
}
Чи була наша стаття корисною?