Модель даних повідомлення

Детальна інформація про кожне поле Message Object
Написано Микола
Оновлено 5 місяців тому

API повідомлень дозволяє отримувати та створювати повідомлення від імені контактів або операторів.

Ось приклад відповіді для методів API повідомлень:

{
  "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"
}

Нижче ви можете знайти детальну інформацію про кожне з полів Message Object.

Поле Тип Опис
id Integer Унікальний ID повідомлення, наданий HelpCrunch
agent Object Якщо повідомлення надіслано від оператора, цей об’єкт міститиме id, ім’я, email та роль цього оператора
type String "tech" - системне повідомлення (наприклад, про оновлення статусу)
"email" - повідомлення електронної пошти
"knowledgeBase" - посилання на статтю бази знань
"message" - звичайне повідомлення
"private" - особиста нотатка (тільки для агентів)
text String Текст повідомлення
read Boolean true - повідомлення прочитане. false - повідомлення не прочитане
createdAt Date (UNIX timestamp) Дата та час створення повідомлення
updatedAt Date (UNIX timestamp) Дата та час оновлення повідомлення
edited Boolean true - повідомлення відредаговане. false - повідомлення не було відредаговане
broadcastType String "trigger" - проактивний чат
"auto chat" - цільове чат-автоповідомлення
"auto email" - email-автоповідомлення
"manual chat" - ручне чат-повідомлення
"manual email" - ручне email-повідомлення
chat Integer Унікальний ID чату, наданий HelpCrunch
from String "оператор" або "контакт" – хто надіслав повідомлення
 
Чи була наша стаття корисною?