Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Створити індивідуальну / масову SMS-кампанію
Метод дозволяє створити:
- індивідуальну SMS-кампанію — на один номер телефону;
- масову SMS-кампанію на список номерів телефонів. Масова кампанія містить один текст для всіх номерів отримувачів. Для однієї кампанії можна вказати не більше 10 000 контактів.
Limitation:
- У режимі облікового запису DEMO створення кампанії через API недоступне.
- У режимі платформи TEST створення кампанії можливе лише для номерів, доданих до адресної книги.
Request URL
| POST https://one-api.bsg.world/api/campaigns/sms/send |
Request parameters
| Parameter | Required | Type | Default | Description | |
|---|---|---|---|---|---|
| sender | Yes | string | No |
Імʼя відправника SMS:
| |
| phones | Yes | array | Recipients array: | ||
| number | Yes | integer | No |
Номер телефону, на який надсилається SMS.
Від 9 до 15 цифр (номер телефону вказується без +) | |
| reference_id | No | string | No |
Зовнішній ідентифікатор SMS.
Рядок довжиною до 32 символів, що містить /a-zA-Z0-9/ | |
| text | Yes | string | No |
Текст повідомлення для надсилання.
Максимальна кількість символів у тексті повідомлення:
| |
| validity | No | integer | 72 |
Термін дії SMS у годинах.
Ціле число від 1 до 72. За замовчуванням — 72 години | |
| tariff_code | No | integer | 0 | Код тарифу, за яким тарифікуються повідомлення кампанії. Можна вказати лише тариф, підключений до вашого облікового запису. Формат параметра — ціле число від 0 до 9. За замовчуванням — 0 | |
| start_at | No | string | now | Дата й час надсилання повідомлення у форматі ISO 8601: yyyy-mm-dd hh:mm:ss. Використовується лише для планування кампаній на певний час. Максимальний термін планування — 30 днів |
Request sample:
{
"phones": [
{
"number": 12345678900,
"reference_id": "string"
}
],
"sender": "string",
"tariff_code": 0,
"text": "string",
"validity": 72,
"start_at": "2025-01-25 09:00:00"
}
Response parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | Ідентифікатор створеної кампанії | |
| name | string | Назва кампанії: генерується автоматично для створеної кампанії | |
| sender | string | Sender name | |
| status | string |
Статус кампанії. Можливі значення:
| |
| message_type | string | Тип кампанії: sms | |
| start_at | string |
Дата й час запланованого початку кампанії.
Формат відображення згідно з ISO 8601: yyyy-mm-dd hh:mm:ss | |
| real_start_at | string |
Фактичні дата й час початку кампанії.
Формат відображення згідно з ISO 8601: yyyy-mm-dd hh:mm:ss | |
| finished_at | string |
Дата й час завершення кампанії.
Формат відображення згідно з ISO 8601: yyyy-mm-dd hh:mm:ss | |
| created_at | string |
Дата й час створення кампанії.
Формат відображення згідно з ISO 8601: yyyy-mm-dd hh:mm:ss | |
| statistics | array | Campaign statistics: | |
| delivered | integer | Загальна кількість доставлених повідомлень у межах кампанії | |
| sent | integer | Загальна кількість надісланих повідомлень у межах кампанії |
Response sample:
Якщо запит виконано успішно, ви отримаєте відповідь:
{
"data": {
"id": 1,
"name": "string",
"sender": "string",
"status": "creation",
"message_type": "sms",
"start_at": "2021-04-27 19:44:06",
"real_start_at": "2021-04-27 19:44:06",
"finished_at": "2021-04-27 19:44:06",
"created_at": "2021-04-27 19:44:06",
"statistics": {
"delivered": 0,
"sent": 0
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати