Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Створення персоналізованої SMS-кампанії
Метод дає змогу надсилати персоналізовану SMS-розсилку на список номерів телефонів. Персоналізована кампанія містить різний текст повідомлення для кожного номера отримувача.
Для однієї кампанії можна вказати не більше 10 000 контактів.
Обмеження:
- У режимі DEMO-акаунта створення кампанії через API недоступне.
- У режимі TEST платформи створення кампанії можливе лише для номерів, доданих до адресної книги.
URL запиту
| POST https://one-api.bsg.world/api/campaigns/sms/send-individual |
Параметри запиту:
| Параметр | Обовʼязковий | Тип | За замовчуванням | Опис | |
|---|---|---|---|---|---|
| messages | Так | array | Ні | Масив обʼєктів повідомлень (до 10 000 номерів на кампанію за раз): | |
| phone | Так | integer | Ні |
Номер телефону, на який надсилається SMS.
Від 9 до 15 цифр (номер телефону вказується без +) | |
| sender | Так | string | Ні |
Імʼя відправника SMS:
| |
| text | Так | string | Ні |
Текст повідомлення.
Максимум 335 символів кирилицею, 765 символів латиницею. | |
| reference_id | Ні | string | Ні |
Зовнішній ID SMS.
Рядок до 32 символів, що містить /a-zA-Z0-9/ | |
| validity | Ні | integer | 72 |
Термін дії SMS.
Термін дії SMS у годинах. Ціле число від 1 до 72. За замовчуванням — 72 години. | |
| tariff_code | Ні | integer | 0 | Номер тарифу, за яким тарифікуватимуться повідомлення кампанії. Можна вказати лише тариф, підключений до вашого акаунта. Формат параметра — ціле число від 0 до 9. За замовчуванням — 0. | |
| start_code | Ні | string | Ні | Дата й час надсилання повідомлення у форматі ISO 8601: yyyy-mm-dd hh:mm:ss. Використовується лише для планування кампаній на певний час. Максимальна дата планування — 30 днів. Якщо користувач не вказав значення, встановлюється поточний час (кампанія без затримки). |
Приклад запиту:
{
"messages": [
{
"phone": 12345678900,
"text": "Hello! How are you?",
"sender": "testsms",
"reference_id": "Test98765"
}
],
"tariff_code": 0,
"validity": 72,
"start_at": "2025-01-25 09:00:00"
}
Параметри відповіді:
| Параметр | Тип | Опис | |
|---|---|---|---|
| id | integer | ID створеної кампанії | |
| name | string | Назва кампанії: генерується автоматично для створеної кампанії | |
| sender | string | Імʼя відправника | |
| status | string |
Статус кампанії. Можливі значення:
| |
| mesage_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 | Статистика кампанії: | |
| delivered | integer | Загальна кількість доставлених повідомлень у межах кампанії | |
| sent | integer | Загальна кількість надісланих повідомлень у межах кампанії |
Приклад відповіді:
Якщо запит успішний, ви отримаєте відповідь:
{
"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
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати