Single RCS Message Sending

Method: POST

Endpoint: /api/messages/rcs/send

Description: This method allows you to send a single rcs message instantly. The message is sent without creating a campaign, provided that the client has enough funds on his/her balance. The ability to send messages via an alternative SMS channel is also supported.

Input parameters

Parameter	Mandatory	Type	Description.
phone	Yes	Object	The object contains information about the mobile phone number (number) and (reference id) to send a message to the subscriber.
sender	Yes	string	The name of the agent used to send the rcs message. The value must contain from 1-40 characters.
options	Yes	Object	The object contains information about the message.
validity_seconds	No	integer	Expiration date RCS message in the seconds. The possible value is from 30 to 86400.	Only one of the following parameters can be specified “validity_seconds” / “validity_hours”. If none of the parameters is specified, then by default – 72 hours. After this period expires, the message will be in EXPIRED status or will be redirected to the SMS channel for sending if it was specified in the request.
validity	No&	integer	Expiration date RCS notification in hours. The possible value is from 1 to 72.
alternative_channel	No	Object	The object contains information for sending a notification via SMS in case of undeliverable rcs message.
callback_url	No	string	Link to get the delivery status of rcs messages. Up to 100 characters. If this parameter is specified in the method, it will take precedence over the value specified in the “Callback URL for RCS” field in the Personal Area.
add_to_contact_boo k	No	string	Specifies whether to add the specified phone number of the message recipient to the contact book. Possible values: true / false The default is “true”.
tariff_code	No	integer	The number of the tariff connected to the account for rcs message billing.
check_stop_list	No	boolean	Check the recipient’s phone number for being on the RCS stop list. Possible values: true – if the number is found in the RCS stop list, the message is not sent. false – ignore the RCS stop list. The default is “true”.

Answer elements

Parameter	Type	Description.
id	integer	id of the RCS message created by the system at the user’s request.
reference_id	string	External message identifier.
source	string	Possible values: web rest
phone	integer	Recipient’s phone number.
status	string	Current status of the message.

amount		object	The object of the message cost.
	value	string	The cost of the message for the user according to his tariff.
	currency	string	The currency in which the cost of the message is indicated.
sender		string	Name of the agent
created_at		string	Date and time of message creation in the format: yyyy-mm-dd hh:mm:ss.
sent_at		string	Date and time of sending the message in the format: yyyy-mm-dd hh:mm:ss
delivered_at		string	Date and time of receipt of the delivery report response in the format: yyyy- mm- dd hh:mm:ss

Example of a query

{
   "phone":{
      "number":"380661231231",
      "reference_id":"string"
   },
   "sender":"string",
   "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":"string",
         "sender":"string",
         "validity":72,
         "check_stop_list":true
      }
   },
   "callback_url":"string",
   "tariff_code":0,
   "validity_seconds":86400,
   "add_to_contact_book":true,
   "check_stop_list":true
}

An example of an answer

If the request is successfully executed:

{
   "data":{
      "id":0,
      "reference_id":"string",
      "source":"rest",
      "type":"rcs",
      "phone":0,
      "status":"string",
      "validity":0,
      "amount":{
         "value":"string",
         "currency":"UAH"
      },
      "sender":"string",
      "created_at":"2025-01-25 09:00:00",
      "sent_at":"2025-01-25 09:00:00",
      "delivered_at":"2025-01-25 09:00:00"
   }
}