Chat API дозволяє отримувати, шукати, створювати та ставити нагадування про чати. За потреби ви також можете оновити статус чату, відповідального оператора та відділ. Таким чином ви зможете повністю контролювати свої чати в HelpCrunch.
Ось приклад відповіді для більшості методів Chat API:
{
"data": [
{
"id": 542335,
"closedBy": "string",
"lastCustomerMessageAt": "1603885746",
"status": "new",
"closedAt": "1603885746",
"rating": "perfect",
"createdAt": "1603885746",
"lastMessageAt": "1603885746",
"readByAgent": true,
"readByCustomer": true,
"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
}
}Нижче ви можете знайти детальну інформацію про кожне з полів Chat Object:
| Поле | Тип | Опис |
| id | Integer | Унікальний ID чату, наданий HelpCrunch |
| closedBy | String | "Контакт" або "оператор" - той хто закрив чат |
| lastCustomerMessageAt | String (UNIX timestamp) | Дата та час останнього повідомлення контакту |
| status | String | Поточний статус чату: новий, відкритий, в очікуванні, на паузі, без спілкування, закритий або пустий |
| closedAt | String (UNIX timestamp) | Дата та час закриття чату |
| rating | String | Як клієнт оцінив чат після його закриття: чудово, посередньо, погано |
| createdAt | String (UNIX timestamp) | Дата та час створення чату |
| lastMessageAt | String (UNIX timestamp) | Дата та час останнього повідомлення в чаті від оператора чи контакту |
| createdWith | String | Тригер, що ініціював створення чату: "public_api", "broadcast_reply", "agent_message", "customer_message" |
| readByAgent | Boolean | Чат був прочитаний агентом |
| readByCustomer | boolean | Чат був прочитаний клієнтом |
| snoozedUntil | String (UNIX timestamp) | Дата та час на який стоїть нагадування про чат. Щоб скасувати нагадування, передайте значення null |
| lastMessageText | String | Текст останнього повідомлення в чаті |
| lastMessageId | Integer | Унікальний ID останнього повідомлення, наданий HelpCrunch |
| applicationId | Integer | Унікальний ID застосунку, наданий HelpCrunch |
| lastCommunicatedAgentId | Integer | Наданий HelpCrunch унікальний ID оператора, який надіслав останнє повідомлення. Ви можете отримати інформацію про операторів (ID, ім’я, адреса електронної пошти, роль) за допомогою методу REST API "Отримати всіх учасників команди". |
| agents | Array of agent objects | Оператори, які надіслали принаймні одне повідомлення в чат. Дані кожного оператора складаються з ID, імені, електронної адреси та ролі |
| customer | Object | Основна інформація про контакт, включаючи унікальний ID від HelpCrunch, ім’я, адресу електронної пошти та userId користувача (вказується на вашій стороні) |
| assignee | Object | Оператор, на якого зараз призначений чат. Складається з унікального ID від HelpCrunch, імені, електронної пошти та ролі |
| department | Object | Відділ, на який зараз призначений чат. Складається з унікального ID від HelpCrunch та назви |
