Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
API Viber дозволяє надсилати повідомлення в месенджер Viber, а також надсилати SMS як альтернативу, якщо повідомлення не було доставлене в месенджер.
Надіслати Viber-повідомлення
Метод дозволяє надсилати повідомлення Viber. У повідомлення можна додати зображення, заголовок і кнопку CTA.
Також цей метод дозволяє вказати опцію переадресації (каскадування) повідомлення через SMS із зазначенням SMS Alpha-імені та його тексту.
Щоб надіслати Viber-повідомлення, надішліть запит на цей URL:
| PUT ( POST ) https://api.bsg.world/rest/viber/create |
Request parameters:
| Parameter | Mandatory | Type | Description | ||
|---|---|---|---|---|---|
| validity | No | string | Термін дії Viber-повідомлення в секундах (за замовчуванням — 24 години). Ціле число від 15 до 86400. | ||
| tariff | No | integer | Номер тарифу. За замовчуванням — 0. Ціле число від 0 до 9. | ||
| messages | Масив обʼєктів повідомлень. Містить 1 і більше обʼєктів такої структури: | ||||
| to | Масив отримувачів: | ||||
| msisdn | Yes | string | Номер телефону, на який надсилається повідомлення. | ||
| reference | No | string | Зовнішній ідентифікатор повідомлення. Рядок довжиною до 32 символів, що містить /a-zA-Z0-9/. | ||
| text | Yes | string | Текст Viber-повідомлення. | ||
| alpha_name | Yes | string | Відправник. Рядок довжиною до 14 символів. | ||
| is_promotional | Yes | boolean | Ознака того, чи є повідомлення рекламним чи транзакційним. | ||
| options | Додаткові параметри для додавання зображення, заголовка та кнопки. | ||||
| img | No | string | Image URL. | ||
| caption | No | string | Button name. | ||
| action | No | string | Button URL. | ||
| scheduledDatetime | No | string | Час надсилання Viber-повідомлення (для планування кампаній). | ||
| alt_route | No | Додаткові параметри для переадресації Viber-повідомлення через SMS. Ці параметри вказуються, лише якщо потрібно забезпечити альтернативну доставку повідомлень у разі недоставлення в месенджер | |||
| originator | Yes | Sender | |||
| text | Yes | Message text |
Request example:
{
"tariff": 9,
"validity": 24,
"messages": [
{
"to": [
{
"msisdn": "380972920283",
"external_id": "example_12"
},
{
"msisdn": "380972920282",
"external_id": "example_13"
}
],
"text": "My Viber messages are shinier than your SMS messages",
"alpha_name": "My Company",
"is_promotional": false,
"options": {
"viber": {
"img": "http://my-cool-webpage.com/logo.png",
"caption": "Join us!",
"action": "http://my-cool-webpage.com"
"alt_route": {
"originator": "testsms",
"text": "SMS message will be received if you are not a VIBER user."
}
},
"scheduledDatetime": "ISO 8601 date"
}
]
}
Response parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| messages | містить вкладені дані: | ||
| id | integer | Message ID | |
| reference | string | Зовнішній ідентифікатор Viber-повідомлення | |
| price | float | Message cost | |
| currency | string | Валюта облікового запису, у якій вказано вартість повідомлення в кампанії Viber |
Якщо запит виконано успішно, ви отримаєте відповідь:
[
{
"error": "0",
"messages": [
{
"id": "22125",
"reference": "example_12",
"price": "0.02",
"currency": "EUR"
},
{
"id": "22126",
"price": "0.02",
"currency": "EUR"
}
]
}
]
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати