Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Загальні правила RCS API
Робота з API відбувається через JSON-обʼєкти та HTTP-запити за архітектурою REST.
Автентифікація
Авторизація клієнта виконується згідно з https://bsg.world/ua/developers/rest-api/authentication для API версії 2.0.
Базовий URL
API доступний за адресою: https://one-api.bsg.world
Загальні правила надсилання повідомлень
- Успішне надсилання RCS-повідомлення можливе лише за певних умов:
- RCS-агент зареєстрований для клієнта й має активний статус;
-
Номер телефону отримувача:
- підтримує отримання RCS-повідомлень;
- не перебуває в стоп-листі RCS (якщо в запиті на надсилання повідомлення ввімкнено перевірку стоп-листа).
- В API-запитах на надсилання RCS-повідомлень список номерів телефонів отримувачів має бути унікальним (без дублікатів).
- Максимально дозволена кількість контактів в одній кампанії — 5000.
- Якщо створена кампанія містить повідомлення для абонентів із країн, що не відповідають RCS-агенту, такі повідомлення не буде надіслано. Статистику кампанії та деталі її повідомлень можна переглянути після надсилання.
Надсилання RCS-повідомлень у тестовому режимі акаунта
- У тестовому режимі акаунта клієнт може надсилати RCS-повідомлення від імені тестового агента BSG (дозвіл на його використання потрібно заздалегідь погодити з менеджером).
- Кошти за надсилання RCS-повідомлень від імені тестового агента списуються з кредитних/власних коштів на балансі клієнта.
- Надсилати RCS-повідомлення в тестовому режимі можна лише на верифікований контакт (номер телефону отримувача, який клієнт підтвердив кодом).
Тарифікація RCS-повідомлень
- RCS-повідомлення оплачується з основного балансу та кредитного ліміту клієнта.
- Тарифікуються лише RCS-повідомлення зі статусом Delivered.
- Вартість RCS-повідомлення в тарифі клієнта залежить від напрямку доставки;
- типу RCS-повідомлення (текст, одна картка/карусель).
- Якщо використовується альтернативний SMS-канал, повідомлення тарифікується за ціною SMS згідно з підключеним тарифом вашого акаунта.
- Якщо під час надсилання повідомлень на балансі клієнта закінчуються кошти, створену кампанію буде призупинено (їй присвоюється статус “Paused”). Після поповнення балансу, щоб продовжити надсилання, потрібно самостійно відновити кампанію.
Webhook
Налаштувавши URL для вебхука у вашому акаунті bsg.world на сторінці «Інтеграція та API», у полі Callback URL For RCS, ви можете отримувати звіти зі статусами надісланих RCS-повідомлень.
Звіт про статус повідомлення містить таку інформацію:
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | ID повідомлення. |
| msisdn | string | Номер телефону, на який надіслано повідомлення. |
| reference | string | Зовнішній ідентифікатор повідомлення (reference), заданий користувачем. |
| status | string | Статус повідомлення. Докладніше див. розділ «Статуси RCS-повідомлень». |
| time_in | string | Дата й час створення повідомлення у форматі: yyyy-mm-dd hh:mm:ss. |
| time_sent | string | Дата й час надсилання повідомлення у форматі: yyyy-mm-dd hh:mm:ss |
| time_dr | string | Дата й час отримання звіту про доставку у форматі: yyyy-mm-dd hh:mm:ss |
| price | string | Вартість повідомлення відображається із 7 знаками після коми |
| currency | string | Валюта акаунта клієнта, у якій зазначено вартість. |
Приклад сповіщення про статус RCS-повідомлення:
{
"error":0,
"errorDescription":"No errors",
"id":"3266500452",
"msisdn":"380997087351",
"reference":"hello",
"time_in":"2024-08-22 11:47:42",
"time_sent":"2024-08-22 11:47:42",
"time_dr":"2024-08-22 11:47:53",
"status":"delivered",
"price":"1.1000000",
"currency":"EUR"
}
Статуси RCS-повідомлень
| № | Статус | Опис. |
|---|---|---|
| 1 | SCHEDULED | Повідомлення заплановано. |
| 2 | MODERATION | Повідомлення на модерації. |
| 3 | SENT | RCS-повідомлення надіслано отримувачу. |
| 4 | DELIVERED | RCS-повідомлення доставлено отримувачу. |
| 5 | SENDING | Повідомлення в черзі на надсилання. |
| 6 | ACCEPTED | Повідомлення прийнято до надсилання. |
| 7 | EXPIRED | Термін дії RCS-повідомлення минув. |
| 8 | UNDELIVERED | Повідомлення не доставлено. |
| 9 | READ | Отримувач прочитав RCS-повідомлення. |
| 10 | UNKNOWN | Статус доставки відсутній. |
| 11 | FAILED | Помилка, що сталася під час надсилання. |
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати