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

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

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

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

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

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

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

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

Необхідні cookies

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

Аналітика

Маркетинг

Отримати список RCS-кампаній

Метод : GET

Ендпоінт : /api/campaign

Опис : метод повертає список RCS-кампаній із детальною інформацією про кожну з них. Максимальний період вибірки кампаній — 3 місяці.

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

Параметр	Обовʼязковий	Тип	Опис.
filter[type]	Ні	string	Фільтр за типом кампанії. Допустимі значення: sms — щоб отримати SMS-кампанії rcs — щоб отримати RCS-кампанії Якщо значення не вказано, за замовчуванням — “sms”.
filter[from]	Ні	string	Дата й час початку вибірки (за датою створення кампанії) у форматі: yyyy-mm-dd hh:mm:ss. За замовчуванням: filter[to] -3 місяці
filter[to]	Ні	string	Дата й час завершення вибірки (за датою створення кампанії) у форматі: yyyy-mm-dd hh:mm:ss. За замовчуванням — поточні дата й час.
page[offset]	Ні	int	Отримати кампанії починаючи з offset. За замовчуванням — 0.
page[limit]	Ні	int	Кількість кампаній у відповіді. За замовчуванням — 50.
sort	Ні	string	Сортування за id, sender, type, date, status За замовчуванням — сортування за id
way	Ні	string	Варіанти сортування: asc, desc. За замовчуванням — asc.
filter[field]	Ні	string	Поле пошуку за sender, taskname (id кампанії)
filter[value]	Ні	string	Значення для пошуку.

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

Параметр	Тип	Опис.
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 — кампанію завершено (фінальний статус).
message_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	string	Дата завершення кампанії у форматі: yyyy-mm-dd hh:mm:ss
created_at	string	Дата й час створення кампанії у форматі: yyyy-mm-dd hh:mm:ss.
statistics	object	Масив обʼєктів статистики кампанії.
statistics[]delivered	integer	Загальна кількість повідомлень, доставлених кінцевим користувачам у межах кампанії, у статусах: DELIVERED READ
statistics[]sent	integer	Загальна кількість повідомлень, надісланих у межах кампанії, у статусах: DELIVERED SENT ACCEPTED SENDING UNDELIVERED FAILED EXPIRED UNKNOWN
calculated_price	float	Попередня вартість кампанії.
alternative_channels	object	Обʼєкт з інформацією про повідомлення кампаній, надісланих через альтернативний канал.
alternative_channels[]sms	object	Обʼєкт визначає канал альтернативного надсилання повідомлень у межах кампанії.
alternative_channels[]sms[]sta tistics	object	Обʼєкт статистики повідомлень, надісланих через альтернативний канал.
alternative_channels[]sms[]sta tistics[]sent	integer	Загальна кількість повідомлень, надісланих у межах кампанії, у статусах: DELIVERED SENT ACCEPTED SENDING UNDELIVERED FAILED EXPIRED UNKNOWN
alternative_channels[]sms[]sta tistics[]delivered	integer	Загальна кількість повідомлень, доставлених у межах кампанії, у статусах: DELIVERED READ
page	object	Обʼєкт пагінації
page[]total	integer	Загальна кількість кампаній, що відповідають умовам вибірки
page[]offset	integer	Кампанії виводяться починаючи з offset
page[]limit	integer	Кількість кампаній, що повертаються у відповіді на запит.

Приклад запиту


curl -X GET "https://api.example.com/campaigns?page[offset]=88&page[limit]=500&sort=id&way=desc&filter[from]=2024
-H "Authorization: Bearer <your_token>" \
-H "Content-Type: application/json"

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

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


{
   "data":[
      {
         "id":1,
         "name":"string",
         "sender":"string",
         "status":"creation",
         "message_type":"rcs",
         "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
         },
         "calculated_price":123.4,
         "alternative_channels":{
            "sms":{
               "statistic":{
                  "delivered":0,
                  "sent":0
               }
            }
         }
      }
   ],
   "meta":{
      "page":{
         "total":1,
         "limit":30,
         "offset":0
      }
   }
}