Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати список SMS-кампаній
Метод для отримання списку створених кампаній.
Максимальний період вибірки кампаній — 3 місяці.
Request URL
| GET https://one-api.bsg.world/api/campaigns |
Request parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| filter[type] | No | string | sms | Фільтр за типом кампанії, sms |
| filter[from] | No | string | filter[to] − 3 місяці | Дата й час початку вибірки. Формат ISO 8601: yyyy-mm-dd hh:mm:ss |
| filter[to] | No | string | now |
Дата й час завершення вибірки. Формат ISO 8601: yyyy-mm-dd hh:mm:ss
Можна вказати майбутню дату: допустиме значення — 30 днів від поточної дати. |
| page[offset] | No | int | 0 | Отримати повідомлення, починаючи зі зсуву (offset) |
| page[limit] | No | int | 50 | Кількість кампаній у відповіді |
| sort | No | string | id | Сортування за id, sender, type |
| way | No | string | asc | Варіанти сортування: asc, desc |
Response parameters
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer |
Ідентифікатор кампанії, створеної за допомогою:
| |
| name | string | Campaign name | |
| sender | string | Імʼя відправника SMS | |
| 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 | object | Статистика повідомлень кампанії: | |
| 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
}
}
],
"meta": {
"page": {
"total": 1,
"limit": 30,
"offset": 0
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати