General rules for the RCS API

API work is performed using JSON objects and http requests, as well as the REST architecture.

Authentication

The client authorization process is carried out according to https://bsg.world/developers/rest-api/authentication for API version 2.0.

Base URL

The API is available at: https://one-api.bsg.world

General rules for sending messages

1. Successful sending of an RCS message is possible only under certain conditions:

   • RCS agent is registered for the client and is in active status;
   • Recipient’s phone number:
     • supports the ability to receive RCS notifications;
     • is not in the RCS stop list (if the stop list check was enabled in the request to send the message).
2. In API requests to send RCS messages, the list of recipients’ phone numbers must be unique (no duplicates).
3. The maximum allowed number of contacts in one campaign is 5000.
4. If the created campaign contains messages to subscribers from countries that do not match the RCS agent, such messages will not be sent. You will be able to view the campaign statistics and details of its messages after sending.

Sending RCS messages in the TEST Mode Account

1. In the test mode of the account, the client can send RCS messages on behalf of the test BSG agent (permission to use it must be agreed with the manager in advance).
2. Withdrawals for sending RCS messages on behalf of the test agent are made from the client’s credit/own funds on the balance sheet.
3. Sending an RCS message in test mode is allowed only to a verified contact (the recipient’s phone number that has been confirmed by the client via a code).

Billing of RCS messages

1. The RCS message is charged at the expense of the client’s principal balance and credit limit.
2. Billing is performed only for RCS messages with the status Delivered.
3. The cost of an RCS message in the customer’s tariff depends on the direction of delivery;
4. RCS message type (text, single card/carousel).
5. If you use an alternative SMS channel, the message is charged at the price of an SMS message according to the connected tariff on your account.
6. If the client’s balance runs out of funds while sending messages, the created campaign is paused (the campaign is assigned the “Paused” status). After replenishing the balance, to continue sending messages, you need to resume the campaign yourself.

Webhook

By configuring the URL for the webhook in your bsg.world account on the Integration and API page, in the Callback URL For RCS field, you can receive reports with the status of RCS messages sent.

The message status report includes the following information:

An example of a notification of the status of an RCS message:

{
   "error":0,
   "errorDescription":"No errors",
   "id":"3266500452",
   "msisdn":"380997087351",
   "reference":"hello",
   "time_in":"2024-08-22 11:47:42",
   "time_sent":"2024-08-22 11:47:42",
   "time_dr":"2024-08-22 11:47:53",
   "status":"delivered",
   "price":"1.1000000",
   "currency":"EUR"
}

RCS Message Statuses