Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Надіслати SMS / 2Way SMS
Метод дозволяє надіслати SMS.
Підтримується створення одиночного SMS («destination»:»phone»), масової розсилки («destination»:»phones») та персоналізованого SMS («destination»:»individual»).
Щоб надіслати кампанію, надішліть запит на цей URL:
| PUT (POST) https://api.bsg.world/rest/sms/create |
Single SMS
Request parameters
| Параметр | Required | Тип | Опис |
|---|---|---|---|
| destination | Так | string | встановлюється значення «phone» |
| originator | Так | string | відправник. Рядок довжиною до 14 символів |
| body | Так | string | Текст SMS-повідомлення |
| msisdn | Так | string | номер телефону, на який надсилається SMS |
| reference | Ні | string | Зовнішній ідентифікатор SMS. Рядок довжиною до 32 символів, що містить /a-zA-Z0-9/ |
| validity | Ні | integer | Термін дії SMS. За замовчуванням — 72 години. Ціле число від 1 до 72 |
| tariff | Ні | integer | номер тарифу. За замовчуванням — 0. Ціле число від 0 до 9 |
| 2way | Ні | bool | належність до 2WAY |
Request sample
{
"destination":"phone",
"msisdn": "380501234567",
"reference": "reference_id",
"originator": "sender",
"body":"test sms",
"2way": 1
}
Response parameters
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | ідентифікатор повідомлення — унікальний випадковий ідентифікатор, що створюється на платформі BSG під час створення обʼєкта |
| reference | string | Зовнішній ідентифікатор SMS |
| price | float | SMS price |
| currency | string | сurrency in which the SMS price is specified |
Якщо запит успішний, ви отримаєте відповідь:
{
"error":"0",
"id":"22125",
"reference":"12erdgm9",
"price":"0.02",
"currency":"EUR"
}
Масова SMS-кампанія
Масова SMS-кампанія містить один текст для всіх номерів отримувачів.
Request parameters
| Параметр | Тип | Опис |
|---|---|---|
| destination | string | встановлюється значення «phones» |
| phones | array | values array |
| msisdn | string | номер телефону, на який надсилається SMS |
| reference | string | Зовнішній ідентифікатор SMS. Рядок довжиною до 32 символів, що містить /a-zA-Z0-9/ |
| originator | string | Імʼя відправника. Рядок довжиною до 14 символів |
| body | string | Текст SMS-повідомлення |
| validity | integer | Термін дії SMS. За замовчуванням — 72 години. Ціле число від 1 до 72 |
| tariff | integer | номер тарифу. За замовчуванням — 0. Ціле число від 0 до 9 |
| 2way | bool | належність до 2WAY |
Response parameters
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | SMS ID |
| reference | string | Зовнішній ідентифікатор SMS |
| price | float | SMS price |
| currency | string | сurrency in which the SMS price is specified |
| task_id | integer |
Ідентифікатор кампанії, що генерується системою автоматично під час створення кампанії.
Параметр task_id використовується для запиту статусу всієї кампанії |
Якщо запит успішний, ви отримаєте відповідь:
Персоналізована SMS-кампанія
Request parameters
| Параметр | Required | Тип | Опис |
|---|---|---|---|
| destination | Так | string | встановлюється значення «individual» |
| validity | Ні | integer | Термін дії SMS. За замовчуванням — 72 години. Ціле число від 1 до 72 |
| tariff | Ні | integer | номер тарифу. За замовчуванням — 0. Ціле число від 0 до 9 |
| 2way | Ні | bool | належність до 2WAY |
| phones | Так | array | values array |
| msisdn | Так | string | номер телефону, на який надсилається SMS |
| reference | Ні | string | Зовнішній ідентифікатор SMS. Рядок довжиною до 32 символів, що містить /a-zA-Z0-9/ |
| originator | Так | string | Імʼя відправника. Рядок довжиною до 14 символів |
| body | Так | string | Текст SMS-повідомлення |
Request sample
{
"destination":"phones",
"phones":[
{"msisdn": "380972000001","reference":"12erdgm9"},
{"msisdn": "380972000002","reference":"12erdgn0"}
],
"originator":"test",
"body":"test sms",
"validity": 72,
"tariff":9
}
Response parameters
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | SMS ID |
| reference | string | Зовнішній ідентифікатор SMS |
| price | float | SMS price |
| currency | string | сurrency in which the SMS price is specified |
| total price | float | загальна вартість кампанії. |
| currency | string | сurrency in which the camapign price is specified |
Якщо запит успішний, ви отримаєте відповідь:
{
"result":
[
{"reference":"12erdgm9",
"id":"12345",
"error":"0",
"price":"0.02",
"currency":"EUR"},
{"reference":"12erdgn0",
"id":"12346",
"error":"0",
"price":"0.02",
"currency":"EUR"}
],
"error":"0",
"task_id":"21902"
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати