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

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

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

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

Прийняти всі cookies*

*Рекомендовано для комфортного користування сайтом

Прийняти лише необхідні cookies

Прийняти лише вибрані cookies

Необхідні cookies

Соціальні мережі

Аналітика

Маркетинг

Отримати детальну інформацію про RCS-кампанію

Метод : GET

Ендпоінт : /api/campaigns/{id}/detail

Опис: Метод дозволяє отримати детальну інформацію про RCS-кампанію, надіслану через API.

Параметри рядка запиту

Параметр	Обовʼязковий	Тип	Опис.
id	Так	integer	id кампанії, отриманий у відповіді на запит: – POST /api/campaigns/rcs/send – POST /api/messages/rcs/send – POST /api/campaigns/rcs/send-groups

Елементи відповіді

Параметр	Тип	Опис.
id	integer	id кампанії.
name	string	Назва кампанії. Приклад: “RCS api campaign / {yyyyy-mm-dd hh:mm:ss}”, де yyyy-mm-dd hh:mm:ss — дата й час створення кампанії.
sender	string	Імʼя агента.
status	string	Поточний статус кампанії. Можливі значення: creation — кампанію створено; spam — кампанія не пройшла модерацію; scheduled — кампанію заплановано; sending — кампанія почала надсилати повідомлення; paused — кампанію призупинено (повідомлення не надсилаються); stopped — кампанію зупинено (фінальний статус); done — кампанію завершено (фінальний статус).
type	string	Тип кампанії. Можливі значення: sms, rcs
start_at	string	Дата й час старту кампанії у форматі: yyyy-mm-dd hh:mm:ss
real_start_at	string	Фактичні дата й час старту кампанії у форматі: yyyy- mm- dd hh:mm:ss
finished_at	null\|string	Дата завершення кампанії у форматі: yyyy-mm-dd hh:mm:ss
created_at	string	Дата й час створення кампанії у форматі: yyyy-mm-dd hh:mm:ss.
statistics	array	Масив обʼєктів статистики кампанії.
statistics[]delivered	integer	Кількість повідомлень у кампанії зі статусом Delivered.
statistics[]scheduled	integer	Кількість повідомлень у кампанії зі статусом Scheduled.
statistics[]moderation	integer	Кількість повідомлень у кампанії зі статусом Moderation
statistics[]accepted	integer	Кількість повідомлень у кампанії зі статусом Accepted
statistics[]sending	integer	Кількість повідомлень у кампанії зі статусом Sending
statistics[]sent	integer	Кількість повідомлень у кампанії зі статусом Sent
statistics[]expired	integer	Кількість повідомлень у кампанії зі статусом Expired
statistics[]failed	integer	Кількість повідомлень у кампанії зі статусом Failed
statistics[]undelivered	integer	Кількість повідомлень у кампанії зі статусом Undelivered
statistics[]unknown	integer	Кількість повідомлень у кампанії зі статусом Unknown
statistics[]read	integer	Кількість повідомлень у кампанії зі статусом Read
alternative_channels	object
alternative_channels[]sms	object	Обʼєкт визначає канал для альтернативного надсилання повідомлень у межах кампанії.
alternative_channels[]sms[]st atistics	object	Обʼєкт статистики повідомлень, надісланих через альтернативний канал.
alternative_channels[]sms[]st atistics[]delivered	integer	Кількість повідомлень у кампанії зі статусом delivered
alternative_channels[]sms[]st atistics[]scheduled	integer	Кількість повідомлень у кампанії зі статусом scheduled
alternative_channels[]sms[]st atistics[]moderation	integer	Кількість повідомлень у кампанії зі статусом moderation
alternative_channels[]sms[]st atistics[]accepted	integer	Кількість повідомлень у кампанії зі статусом accepted
alternative_channels[]sms[]st atistics[]sending	integer	Кількість повідомлень у кампанії зі статусом sending
alternative_channels[]sms[]st atistics[]sent	integer	Кількість повідомлень у кампанії зі статусом sent
alternative_channels[]sms[]st atistics[]expired	integer	Кількість повідомлень у кампанії зі статусом expired
alternative_channels[]sms[]st atistics[]failed	integer	Кількість повідомлень у кампанії зі статусом failed
alternative_channels[]sms[]st atistics[]undelivered	integer	Кількість повідомлень у кампанії зі статусом undelivered
alternative_channels[]sms[]st atistics[]unknown	integer	Кількість повідомлень у кампанії зі статусом unknown
total_messages	integer	Загальна кількість повідомлень, створених у межах кампанії.
total_phones	integer	Кількість контактів у кампанії.
total price	string	Загальна вартість кампанії. Сума відображається з точністю до 7 знаків після коми.
currency	string	Валюта облікового запису, у якій вказано вартість кампанії.

Приклад відповіді

Якщо запит виконано успішно:


{
   "en-US":{
      "id":1,
      "name":"string",
      "sender":"string",
      "status":"creation",
      "type":"rcs",
      "started_at":"2021-04-27 19:44:06",
      "actual_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,
         "scheduled":0,
         "moderation":0,
         "accepted":0,
         "sending":0,
         "expired":0,
         "failed":0,
         "undelivered":0,
         "unknown":0,
         "read":0
      },
      "alternative_channels":{
         "sms":{
            "statistics":{
               "delivered":0,
               "sent":0,
               "scheduled":0,
               "moderation":0,
               "accepted":0,
               "sending":0,
               "expired":0,
               "failed":0,
               "undelivered":0,
               "unknown":0
            }
         }
      },
      "total_messages":1,
      "total_phones":1,
      "total_price":"0.3000000",
      "currency":"UAH"
   }
}