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

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

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

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

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

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

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

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

Необхідні cookies

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

Аналітика

Маркетинг

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

Метод : POST

Ендпоінт : /api/campaigns/rcs/send-groups

Опис : метод дає змогу надсилати rcs-повідомлення групі контактів (ID групи створюється в адресній книзі клієнта). Також підтримується надсилання повідомлень через альтернативний SMS-канал.

Вхідні параметри

Параметр	Обовʼязковий	Тип	Опис.
groups	Так	Array	Масив списків (list id) з контактами з адресної книги, яким буде надіслано RCS-кампанії. id списків можна отримати: через API «Отримати список»: https://bsg.world/ua/developers/rest-api/receive-an-index-of-all-contact-lists або у вашому кабінеті (Адресна книга → Списки) — BSG.world
sender	Так	string	Імʼя агента, від якого надсилається rcs-повідомлення. Від 1 до 40 символів.
tariff_code	Ні	string	Номер тарифу для тарифікації rcs-повідомлень. Указаний тариф має бути активовано в кабінеті користувача та перебувати в активному статусі.
validity	Ні	integer	Термін дії RCS-повідомлення в годинах. Після його завершення повідомлення отримає статус EXPIRED або буде перенаправлено в SMS-канал, якщо його вказано в запиті. Значення від 1 до 72. За замовчуванням — 72 години.
start_at	Ні	string	Дата й час надсилання повідомлення для планування кампанії. Максимально допустимі дата й час планування розсилки — 30 днів (включно з поточною датою), до 23:59:59 тридцятого дня. Формат значення: “{yyyy-mm-dd hh:mm:ss}”. За замовчуванням завжди створюється кампанія типу «Миттєва», але якщо в запиті вказано параметр “start_at”, система створює кампанію типу «Запланована».
options	Так	Object	Обʼєкт містить інформацію про повідомлення.
alternative_channel	Ні	Object	Обʼєкт містить інформацію для надсилання повідомлення через альтернативний SMS-канал, якщо rcs-повідомлення не доставлено.
check_stop_list	Ні	boolean	Перевіряє, чи є номер телефону отримувача в стоп-листі RCS. Можливі значення: true — якщо номер знайдено в стоп-листі RCS, повідомлення не надсилати; false — ігнорувати стоп-лист RCS. За замовчуванням — “true”.

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

Назва поля	Тип	Опис.
id	integer	Унікальний ідентифікатор створеної RCS-кампанії.
name	string	Назва кампанії, яку система генерує автоматично: “RCS api campaign / {yyyyy-mm-dd hh:mm:ss}”, де yyyy-mm-dd hh:mm:ss — дата й час створення кампанії.
sender	string	Імʼя агента.

status	string	Статус кампанії. У момент створення кампанії відображається статус “creation”.
message_type	string	Тип повідомлення: rcs
start_at	string	Дата й час старту кампанії (запланованого) у форматі: yyyy-mm-dd hh:mm:ss
real_start_at	string	Фактичні дата й час старту кампанії у форматі: yyyy-mm- dd hh:mm:ss.
finished_at	null\|strin g	Дата й час завершення кампанії у форматі: yyyy-mm-dd hh:mm:ss. Під час створення кампанії значення — null.
created_at	string	Дата й час створення кампанії у форматі: yyyy- mm-dd hh:mm:ss
statistics	object	Обʼєкт статистики кампанії.
	delivered	integer	Загальна кількість доставлених rcs-повідомлень у межах кампанії в статусах: DELIVERED READ Під час створення кампанії завжди = 0.
	sent	integer	Загальна кількість надісланих rcs-повідомлень у межах кампанії в статусах: DELIVERED SENT ACCEPTED SENDING UNDELIVERED FAILED EXPIRED UNKNOWN Під час створення кампанії завжди = 0.
calculated_price	float	Попередня вартість кампанії.
alternative_channels	object	Обʼєкт містить інформацію про повідомлення, надіслані через альтернативний канал.
	sms	object	Альтернативний канал надсилання повідомлень.
		statistics	object	Обʼєкт статистики SMS-повідомлень, надісланих у межах кампанії.
			delivered	integer	Загальна кількість доставлених SMS-повідомлень у межах кампанії в статусах: DELIVERED Під час створення кампанії завжди = 0.

sent

integer

Загальна кількість SMS-повідомлень, надісланих у межах кампанії, в статусах: DELIVERED SENT ACCEPTED SENDING UNDELIVERED FAILED EXPIRED UNKNOWN Під час створення кампанії завжди = 0.

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


{
   "groups":[
      0
   ],
   "sender":"Agent Name",
   "options":{
      "cards":[
         {
            "text":"Go to site",
            "media":{
               "url":"https://domain.com/"
            },
            "suggestions":[
               {
                  "text":"Go to site",
                  "url":"https://domain.com/"
               }
            ]
         },
         {
            "text":"string",
            "media":{
               "url":"string"
            },
            "suggestions":[
               {
                  "text":"string",
                  "url":"string"
               }
            ]
         },
         {
            "text":"string",
            "media":{
               "url":"string"
            },
            "suggestions":[
               {
                  "text":"string",
                  "phone":"string"
               }
            ]
         },
         {
            "title":"string",
            "text":"string",
            "media":{
               "url":"string"
            },
            "suggestions":[
               {
                  "text":"string",
                  "url":"string"
               }
            ]
         }
      ]
   },
   "alternative_channel":{
      "sms":{
         "text":"Hello, world!",
         "sender":"string",
         "validity":72,
         "check_stop_list":true
      }
   },
   "start_at":"2025-01-25 09:00:00",
   "tariff_code":0,
   "validity":72,
   "add_to_contact_book":true,
   "check_stop_list":true
}

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

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


{
   "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
            }
         }
      }
   }
}