Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Надсилання одного RCS-повідомлення
Метод : POST
Ендпоінт : /api/messages/rcs/send
Опис : Цей метод дозволяє миттєво надіслати одне RCS-повідомлення. Повідомлення надсилається без створення кампанії за умови, що на балансі клієнта достатньо коштів. Також підтримується надсилання повідомлень через альтернативний SMS-канал.
Вхідні параметри
| Параметр | Обовʼязковий | Тип | Опис. | |
|---|---|---|---|---|
| phone | Так | Object | Обʼєкт містить інформацію про номер мобільного телефону (number) та (reference id) для надсилання повідомлення абоненту. | |
| sender | Так | string | Імʼя агента, що використовується для надсилання RCS-повідомлення. Значення має містити від 1 до 40 символів. | |
| options | Так | Object | Обʼєкт містить інформацію про повідомлення. | |
| validity_seconds | Ні | integer | Термін дії RCS-повідомлення в секундах. Можливе значення — від 30 до 86400. | Можна вказати лише один із параметрів: “validity_seconds” / “validity_hours”. Якщо жоден із параметрів не вказано, за замовчуванням — 72 години. Після завершення цього періоду повідомлення перейде в статус EXPIRED або буде перенаправлене для надсилання в SMS-канал, якщо його було вказано в запиті. |
| validity | Ні& | integer | Термін дії RCS-повідомлення в годинах. Можливе значення — від 1 до 72. | |
| alternative_channel | Ні | Object | Обʼєкт містить інформацію для надсилання сповіщення через SMS у разі недоставленого RCS-повідомлення. | |
| callback_url | Ні | string | Посилання для отримання статусу доставлення RCS-повідомлень. До 100 символів. Якщо цей параметр вказано в методі, він матиме пріоритет над значенням, зазначеним у полі “Callback URL for RCS” в особистому кабінеті. | |
| add_to_contact_boo k | Ні | string | Визначає, чи додавати вказаний номер телефону отримувача повідомлення до книги контактів. Можливі значення: true / false. За замовчуванням — “true”. | |
| tariff_code | Ні | integer | Номер тарифу, підключеного до облікового запису для тарифікації RCS-повідомлень. | |
| check_stop_list | Ні | boolean | Перевірка наявності номера телефону отримувача в стоп-листі RCS. Можливі значення: true — якщо номер знайдено в стоп-листі RCS, повідомлення не надсилається; false — ігнорувати стоп-лист RCS. За замовчуванням — “true”. |
Answer elements
| Параметр | Тип | Опис. |
|---|---|---|
| id | integer | ідентифікатор RCS-повідомлення, створеного системою на запит користувача. |
| reference_id | string | Зовнішній ідентифікатор повідомлення. |
| source | string | Можливі значення: web, rest |
| phone | integer | Номер телефону отримувача. |
| status | string | Поточний статус повідомлення. |
| amount | object | Обʼєкт вартості повідомлення. | |
|---|---|---|---|
| value | string | Вартість повідомлення для користувача згідно з його тарифом. | |
| currency | string | Валюта, у якій вказано вартість повідомлення. | |
| sender | string | Імʼя агента | |
| created_at | string | Дата й час створення повідомлення у форматі: yyyy-mm-dd hh:mm:ss. | |
| sent_at | string | Дата й час надсилання повідомлення у форматі: yyyy-mm-dd hh:mm:ss | |
| delivered_at | string | Дата й час отримання звіту про доставку у форматі: yyyy-mm-dd hh:mm:ss |
Приклад запиту
{
"phone":{
"number":"380661231231",
"reference_id":"string"
},
"sender":"string",
"options":{
"cards":[
{
"text":"This is the first card text",
"media":{
"url":"https://domain.com/image.png"
},
"suggestions":[
{
"text":"Go to site",
"url":"https://domain.com/"
},
{
"text":"Call us",
"phone":"380971112233"
}
]
},
{
"text":"This is the second card text",
"media":{
"url":"https://domain.com/image2.png"
},
"suggestions":[
{
"text":"Go to site",
"url":"https://domain.com/"
}
]
}
]
},
"alternative_channel":{
"sms":{
"text":"string",
"sender":"string",
"validity":72,
"check_stop_list":true
}
},
"callback_url":"string",
"tariff_code":0,
"validity_seconds":86400,
"add_to_contact_book":true,
"check_stop_list":true
}
Приклад відповіді
Якщо запит виконано успішно:
{
"data":{
"id":0,
"reference_id":"string",
"source":"rest",
"type":"rcs",
"phone":0,
"status":"string",
"validity":0,
"amount":{
"value":"string",
"currency":"UAH"
},
"sender":"string",
"created_at":"2025-01-25 09:00:00",
"sent_at":"2025-01-25 09:00:00",
"delivered_at":"2025-01-25 09:00:00"
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати