Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Надіслати SMS списку контактів
Метод дозволяє надіслати SMS списку контактів із адресної книги. Кампанія може містити персоналізовані дані з полів контакту в тексті повідомлення для кожного контакту.
Для однієї кампанії можна вказати не більше 10 000 контактів.
Limitation:
- У режимі облікового запису DEMO створення кампанії через API недоступне.
- У режимі платформи TEST створення кампанії можливе лише для верифікованих номерів.
Щоб надіслати SMS списку контактів, надішліть запит на цей URL:
| POST https://one-api.bsg.world/api/campaigns/sms/send-groups |
Request pаrаmeters:
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| groups[] | Yes | array <int> | No | Масив списків контактів з адресної книги. Ідентифікатор списку контактів, яким потрібно надіслати SMS. |
| sender | Yes | string | No |
Імʼя відправника SMS:
|
| text | Yes | string | No |
Message text.
Щоб підставити персоналізовані дані отримувача в текст повідомлення, вкажіть ідентифікатор(и) поля(ів) контакту у форматі {field_id}. Максимальна кількість символів у тексті повідомлення:
|
| 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:
{
"groups": [
1
],
"sender": "string",
"text": "string",
"tariff_code": 0,
"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 |
Статус кампанії. Можливі значення:
| |
| 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 | Campaign statistics: | |
| 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
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати