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

Метод: POST

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

Опис: Цей метод дає змогу надіслати одне RCS-повідомлення або виконати масове розсилання RCS-повідомлень. Також підтримується надсилання повідомлень через альтернативний SMS-канал.

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

Параметри обʼєкта phones

Параметри обʼєкта alternative_channel

Параметри обʼєкта sms

Параметри обʼєкта options

Обʼєкт options, залежно від типу RCS-повідомлення, може приймати лише text (для текстового повідомлення) або масив card (для повідомлень Single card і Carousel):

Параметри масиву cards

Для повідомлень Single card і кожної картки Carousel має бути вказано принаймні один із параметрів: text або media.

Параметри обʼєкта media

Параметри масиву suggestions

Answer elements

Приклад запиту для надсилання RCS-повідомлення:

{
   "phones":[
      {
         "number":"380661231231",
         "reference_id":"string"
      }
   ],
   "sender":"Agent Name",
   "options":{
      "cards":[
         {
            "text":"This is the first card text",
            "media":{
               "url":"https://domain.com/image.png"
            },
            "suggestions":[
               {
                  "text":"Go to site",
                  "url":"https://domain.com/"
               },
               {
                  "text":"Call us",
                  "phone":"380971112233"
               }
            ]
         },
         {
            "text":"This is the second card text",
            "media":{
               "url":"https://domain.com/image2.png"
            },
            "suggestions":[
               {
                  "text":"Go to site",
                  "url":"https://domain.com/"
               }
            ]
         }
      ]
   },
   "alternative_channel":{
      "sms":{
         "text":"Hello, world!",
         "sender":"string",
         "validity":72,
         "check_stop_list":true
      }
   },
   "start_at":"2024-09-01 09:00:00",
   "tariff_code":0,
   "validity":72,
   "add_to_contact_book":true,
   "check_stop_list":true
}

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

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

{
   "data":{
      "id":1235643,
      "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
            }
         }
      }
   }
}