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

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

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

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

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

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

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

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

Необхідні cookies

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

Аналітика

Маркетинг

Отримати статус надісланого RCS-повідомлення

Метод: GET

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

Опис : метод для отримання інформації про статус:

одного повідомлення RCS-кампанії;
усіх повідомлень RCS-кампанії.

Відповідь також містить інформацію про повідомлення, надіслане через альтернативний канал. Максимальний дозволений період отримання даних — 3 місяці.

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

Параметр	Обовʼязковий	Тип	Опис.
page[limit]	Ні	integer	Кількість повідомлень у відповіді. За замовчуванням — 50.
page[offset]	Ні	integer	Отримати повідомлення, починаючи з offset. За замовчуванням — 0.
filter[from]	Ні	string	Фільтр за датою надсилання «від» у форматі: yyyy- mm-dd hh:mm:ss. Майбутні дати не допускаються.
filter[to]	Ні	string	Фільтр за датою надсилання «до» у форматі: yyyy-mm-dd hh:mm:ss. Майбутні дати не допускаються. За замовчуванням — поточна дата.
filter[campaign_id]	Ні	integer	Фільтр для отримання повідомлень за ID кампанії, отриманим у відповідь на запити: POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send-individual
filter[reference_id]	Ні	string	Фільтр для отримання повідомлень за зовнішнім ID повідомлення.
filter[id]	Ні	integer	Фільтр для отримання повідомлення за його ID.
sort	Ні	string	Сортування за id, phone, delivered. За замовчуванням — за id
way	Ні	string	Варіанти сортування: asc, desc. За замовчуванням — asc

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

Параметр	Тип	Опис.
id	integer	ID повідомлення.
campaign_id	integer	ID кампанії.
reference_id	string	Зовнішній ID повідомлення.
type	string	Тип кампанії. Можливі значення: sms, rcs
source	string	Можливі значення: web — якщо повідомлення надіслано в кампанії, створеній через особистий кабінет. rest — якщо повідомлення надіслано в кампанії, створеній через API.
phone	string	Номер телефону отримувача повідомлення.
validity	integer	Термін дії повідомлення, у годинах.
status	string	Статус повідомлення. Можливі значення: delivered scheduled moderation accepted sending sent expired failed undelivered unknown read
options	object	Обʼєкт містить інформацію про вміст повідомлення, вказаний в обʼєкті options у запиті: POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send-individual
alternative_channels	object	Обʼєкт містить інформацію про надсилання повідомлення через альтернативний канал.
alternative_channels[]sms	object	Обʼєкт статистики повідомлень, надісланих через SMS або Viber.
alternative_channels[]sms[]parts	integer	Кількість частин у повідомленні.
alternative_channels[]sms[]id	array	Кількість частин у повідомленні.
amont	array	Масив обʼєктів вартості повідомлення
amont[]value	string	Вартість повідомлення. Сума відображається із 7 знаками після коми.
amont[]currency	string	Валюта акаунта, у якій вказано вартість.
sender	string	Імʼя RCS-агента
created_at	string	Дата й час створення повідомлення у форматі: yyyy-mm- dd hh:mm:ss.
sent_at	string	Дата й час надсилання повідомлення у форматі: yyyy- mm- dd hh:mm:ss
delivered_at	string	Дата й час отримання звіту про доставлення повідомлення у форматі: yyyy-mm-dd hh:mm:ss
page	array	Пагінація
page[]total	integer	Загальна кількість повідомлень, що відповідають критеріям вибірки.
page[]offset	integer	Повідомлення виводяться, починаючи з offset
page[]limit	integer	Кількість повідомлень у відповіді.

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

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


{
   "data":[
      {
         "id":26130,
         "campaign_id":1,
         "reference_id":"string",
         "type":"rcs",
         "source":"web",
         "text":"text",
         "phone":380661234567,
         "validity":72,
         "status":"scheduled",
         "amount":{
            "value":"string",
            "currency":"UAH"
         },
         "sender":"sender",
         "created_at":"2021-04-27 19:44:06",
         "sent_at":"2021-04-27 19:44:06",
         "delivered_at":"2021-04-27 19:44:06",
         "rcs_options":{
            "cards":[
               {
                  "text":"string",
                  "media":{
                     "url":"string"
                  },
                  "suggestions":[
                     {
                        "text":"string",
                        "phone":"string"
                     }
                  ]
               },
               {
                  "text":"string",
                  "media":{
                     "url":"string"
                  },
                  "suggestions":[
                     {
                        "text":"string",
                        "url":"string"
                     }
                  ]
               }
            ]
         },
         "alternative_channels":{
            "sms":{
               "parts":0,
               "id":[
                  0
               ]
            }
         }
      }
   ],
   "meta":{
      "page":{
         "total":1,
         "offset":20,
         "limit":40
      }
   }
}