Створити повідомлення

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

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

➡️ Запит

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

ID чату та атрибути повідомлення мають бути розміщені в тілі запиту POST. Перегляньте приклад нижче.

{
    "chat": 5215261,
    "text": "Can you can a can as a canner can can a can?",
    "markdownText": "Can you can a **can** as a canner can can a **can**",
    "agent": 4188,
    "type": "message"
}
chat, text, agent і type обов'язкові під час створення повідомлення від оператора. Для повідомлення від контакту просто пропустіть параметр agent.

Якщо ви хочете створити повідомлення з розміткою (жирний, курсив, підкреслення тощо),  додатково вкажіть атрибут markdownText.

Зверніть увагу, що у відповіді немає параметра markdownText. Текст із розміткою буде розміщено в полі text.

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

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

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

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

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

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

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"
    }
  ]
}
Чи була наша стаття корисною?