Розсилка (відправка повідомлення в бот)

URI: довільний (надається клієнтом)

Метод використовується системою Pharmapoint для відправки повідомлення користувачу через налаштований клієнтом бот Telegram або Viber.

інформація

Після доставки повідомлення користувачу потрібно використати метод Передача статусу повідомлення. Окрім кодів верифікації та підтвердження списання (request_id = null).

Запит виконується методом POST з тілом запиту у форматі JSON.

Авторизація

Headers:
api-key: ****** 

Для авторизації використовується API-Key, що був наданий клієнтом.

Параметри запиту

Ім'я	Тип	Обов'язковий	Опис
request_id	integer	Так	Ідентифікатор повідомлення у системі Pharmapoint 🛈 request_id використовується для передачі статусу відправлення повідомлення клієнту (Telegram / Viber) методом Передача статусу повідомлення. 🛈 Для кодів верифікації та підтвердження списання request_id буде мати значення null
phone	string	Так	Номер телефону одержувача, на який буде відправлено повідомлення
type	string	Так	Тип месенджера або бота, який використовуватиметься для відправки повідомлення: telegram viber
text	string	Так	Текст повідомлення, який буде надіслано користувачу
image_url	string	Ні	Посилання на зображення, яке супроводжуватиме повідомлення 🛈 Якщо параметр image_url не використовується буде мати значення null
button	object	Так	Об'єкт, що містить деталі інтерактивної кнопки 🛈 Якщо параметр button не використовується буде мати значення null
button.text	string	Ні	Текст, що відображатиметься на кнопці
button.url	string	Ні	Посилання, на яке перейде користувач після натискання на кнопку

Приклад запиту від Pharmapoint

{
  "request_id": 22546,
  "phone": "380999808056",
  "type": "telegram",
  "text": "Добрий день, любий клієнт",
  "image_url": "https://www.google.com/img",
  "button": {
    "text": "Знижки",
    "url": "https://aptekaskarb.ua"
  }
}

Параметри відповіді

Ім'я	Тип	Опис
id	number / null	id повідомлення в системі клієнта 🛈 Якщо id в системі клієнта відсутнє, у відповіді передати null
status	string	Статус обробки запиту: accept — запит успішно прийнято failed — запит відхилено через помилку
error	string	Текст помилки 🛈 Вказується лише у випадку, якщо поле status має значення failed. Якщо помилки немає (status = accept), це поле повинно бути null або не передаватися зовсім

Приклади відповіді

Приклад успішної відповіді

{
  "id": 68456174,
  "status": "accept"
}

Приклад не успішної відповіді

{
  "id": null,
  "status": "failed",
  "error": "Текст помилки"
}