API
API
API
API
API
API
API

BSG використовує HTTP-cookies (а також подібні або додаткові технології), щоб:
1) забезпечити безпечну, стабільну та доступну роботу сайту (через використання обов’язкових cookies) та
2) зрозуміти, як ви користуєтеся сайтом (через використання необов’язкових cookies) — з метою покращення вашого досвіду та надання персоналізованого контенту.

Інформація у cookie-файлах може бути пов’язана з вашими уподобаннями або пристроєм і допомагає сайту працювати так, як ви очікуєте. Зазвичай ці файли не ідентифікують вас безпосередньо, але дозволяють забезпечити більш персоналізовану взаємодію з сайтом.

Відповідно до вимог Загального регламенту про захист даних (GDPR), який регулює обробку та передачу персональних даних осіб у ЄС, ми надаємо вам можливість заборонити використання певних типів cookies під час відвідування нашого сайту.

Ознайомтеся з нашими Правилами використання cookies та Політикою конфіденційності, щоб дізнатися більше про те, як BSG збирає та використовує cookies.
Зверніть увагу, що заборона певних типів cookies може вплинути на роботу сайту та обмежити доступ до деяких сервісів. Оберіть відповідну категорію нижче, щоб дізнатися більше або вимкнути cookies.

Прийняти всі cookies*
*Рекомендовано для комфортного користування сайтом
Прийняти лише необхідні cookies
Прийняти лише вибрані cookies
Необхідні cookies
Соціальні мережі
Аналітика
Маркетинг

BSG переїхав на новий DevPortal
щоб швидше випускати найновіші версії One API

Використовуйте його для актуальних ендпоінтів, гайдів і журналів змін

Перейти на новий DevPortal
Документація для розробників
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 Ідентифікатор кампанії, створеної за допомогою:
  • POST /api/campaigns/sms/send

  • POST /api/campaigns/sms/send-groups

  • POST /api/campaigns/sms/send- individual

Response parameters

Parameter Type Description
id integer Ідентифікатор завдання, створеного для масової кампанії
name string Campaign name
sender string Імʼя відправника SMS
status string Поточний статус кампанії. Можливі значення:
  • creation — створено

  • spam — кампанія не пройшла модерацію

  • scheduled — кампанію заплановано

  • sending — розпочато надсилання кампанії

  • paused — кампанію призупинено

  • stopped — кампанію зупинено

  • done — кампанію завершено
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”
}
}

Зацікавлені у спеціальній пропозиції?

Готові розширювати можливості?
Давайте обговоримо.

Надіслати

Корисні Матеріали

WhatsApp Business API: повний гайд — налаштування, ціни, сценарії [2026]
WhatsApp Business API: повний гайд — налаштування, ціни, сценарії використання [2026]

WhatsApp Business API у 2026 — кроки налаштування, нова модель тарифікації за повідомлення та перевірені сценарії використання за галузями.

Що таке CPaaS? Повний бізнес-гайд із Communications Platform as a Service
Що таке CPaaS? Повний бізнес-гайд із Communications Platform as a Service

Що таке CPaaS? Хмарний API-шар, що додає SMS, WhatsApp, голос та OTP у ваші застосунки — як це працює і чому це краще за стек із кількох вендорів.

Один комунікаційний API для SMS, WhatsApp, Viber і RCS — чому він кращий за пʼять
Один комунікаційний API для SMS, WhatsApp, Viber та RCS — чому він кращий за пʼять

Чому один комунікаційний API для SMS, WhatsApp, Viber та RCS кращий за пʼять окремих інтеграцій — каскадний fallback, єдині звіти.