Send SMS

API endpoint to send SMS.

Log in to see full request history

📘

Before sending an SMS, you need to create an SMS sender. Please refer to the article Omnichannel Integration for more details.

When using this API endpoint, the user fields listed in the table below are saved in the system and updated when using the same API endpoint in the future:

FieldDescription
namеUser name;
genderUser gender: 'm' – male, 'f' – female;
platform_id0 – Unknown, 1 – Desktop, 2 – Mobile (Mobile Browser + Tablet), 3 – Android App, 4 – iOS App;
country_idTwo- or three-letter country code (e.g. "esp");
language_idTwo-letter language code (e.g. "es");
akAuth key - key for user authorization / autologin on the product;
ageUser age;
photoLink to the user's photo;
vipUser status: 1 – payer, 0 – non-payer.

📘

By default, the VIP parameter has the value “0” (non-payer).

Body Params
int32
required

Type ID of the transactional SMS;

int32
required

Project identifier;

string
required

Recipient's phone number;

data
object

Data that will be used in the app push (e.g. recipient data, links, pictures, etc.);

string
required

User ID on the client's side

Responses

Language
Credentials
:
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json