Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати звіт SMS-кампанії
Метод дозволяє отримати детальну інформацію про кампанію зі статистикою надісланих повідомлень.
Request URL
| GET https://one-api.bsg.world/api/campaigns/{id}/detail |
Request parameters:
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| id | Yes | integer | no |
Ідентифікатор кампанії, створеної за допомогою:
|
Response parameters
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | Ідентифікатор завдання, створеного для масової кампанії | |
| name | string | Campaign name | |
| sender | string | Імʼя відправника SMS | |
| status | string |
Поточний статус кампанії. Можливі значення:
| |
| type | string | тип кампанії — sms | |
| start_date | string | Дата й час початку кампанії (заплановані). Формат ISO 8601: yyyy-mm-dd hh:mm:ss | |
| actual_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 | Кількість повідомлень, отриманих одержувачем | |
| scheduled | integer | Кількість повідомлень, запланованих для кампанії | |
| moderation | integer | Кількість повідомлень на модерації | |
| accepted | integer | Кількість повідомлень, прийнятих оператором | |
| sending | integer | Кількість повідомлень у черзі на надсилання | |
| sent | integer | Кількість повідомлень, які надіслано й очікується їх доставка | |
| expired | integer | Кількість недоставлених повідомлень (телефон вимкнено) | |
| failed | integer | Кількість повідомлень з помилкою надсилання (можливо, відсутній префікс) | |
| undelivered | integer | Кількість недоставлених повідомлень | |
| unknown | integer | Кількість повідомлень, для яких немає звіту про доставку | |
| total_messages | integer | Загальна кількість повідомлень, створених у межах кампанії | |
| total_phones | integer | Кількість контактів у кампанії | |
| total_price | string | Загальна вартість кампанії | |
| currency | string | Валюта, у якій вказано вартість кампанії. Формат ISO 4217 |
Response sample
Якщо запит виконано успішно, ви отримаєте відповідь:
{
"data": {
“id”: “12345”,
“name”: “string”
“sender”: “testsms”,
“status”: “done”,
“type”: “instant”,
“start_at”: “2022-01-01 00:01:02”,
“actual_start_at”: “2022-01-01 00:01:03”,
“creation_at”: “2022-01-01 00:00:01”,
“finished_at”: “2022-01-01 00:10:03”,
“statistics”: [
{
“delivered”: 0,
“scheduled”: 0,
“moderation”: 0,
“accepted”: 0,
“sending”: 20,
“sent”: 100,
“expired”: 0,
“failed”: 0,
“undelivered”: 0,
“unknown”: 0
}
]
“total_messages”: 120,
“total_phones”: 120,
“total_price”: “35,0987645”,
“currency”: “USD”
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати