Developer Docs

Table of contents

Create individual / bulk SMS Campaign

The method allows you to make:

  • individual SMS campaign ― to one phone number;
  • bulk SMS campaign to a list of phone numbers. The bulk campaign contains one text for all recipient numbers. It is possible to specify no more than 10 000 contacts for one campaign.


  • In the DEMO account mode, creating a campaign via API is not available.
  • In the TEST platform mode, creating a campaign is possible only for numbers that are added to the Contact Book.

Request URL


Request parameters

senderYesstringNoSMS Sender name:
  • 1 to 11 characters for the Sender alphanumeric name (consists of Latin letters, symbols, numbers, spaces)

  • 1 to 15 characters for the Sender numeric name
phonesYesarrayRecipients array:
numberYesintegerNoThe phone number to which the SMS is sent.
From 9 to 15 digits (phone number is specified without +)
reference_idNostringNoSMS external ID.
String up to 32 characters long containing /a-zA-Z0-9/
textYesstringNoThe text of the message to be sent.
Maximum number of characters for a message text:
  • 335 characters Cyrillic

  • 765 characters Latin
validityNointeger72SMS validity period in hours.
Integer from 1 to 72. By default 72 hours
tariff_codeNointeger0Code of tariff at which the campaign messages will be billed. You can only specify the tariff connected to your account. The parameter format is an integer from 0 to 9. The default is 0
start_atNostringnowDate and time of the message sending in ISO 8601 format: yyyy-mm-dd hh:mm:ss. Used only for scheduling campaigns for a specific time. Maximum date for scheduling is 30 days

Request sample:

  "phones": [
      "number": 12345678900,
      "reference_id": "string"
  "sender": "string",
  "tariff_code": 0,
  "text": "string",
  "validity": 72,
  "start_at": "2025-01-25 09:00:00"

Response parameters:

idintegerCreated campaign ID
namestringCampaign name: auto-generated for the created campaign
senderstringSender name
statusstringCampaign status. Possible values:
  • creation – created

  • spam – campaign did not pass moderation

  • scheduled – campaign is scheduled

  • sending – campaign began to be sent

  • paused – campaign is paused

  • stopped – campaign is stopped

  • done – campaign is completed
message_typestringCampaign type: sms
start_atstringDate and time of the scheduled campaign start.
Display format according to ISO 8601: yyyy-mm-dd hh:mm:ss
real_start_atstringActual date and time the campaign started.
Display format according to ISO 8601: yyyy-mm-dd hh:mm:ss
finished_atstringDate and time the campaign is completed.
Display format according to ISO 8601: yyyy-mm-dd hh:mm:ss
created_atstringDate and time the campaign is created.
Display format according to ISO 8601: yyyy-mm-dd hh:mm:ss
statisticsarrayCampaign statistics:
deliveredintegerTotal number of messages delivered within the campaign
sentintegerTotal number of messages sent within the campaign

Response sample:

If the request is successful, you will receive a response:

  "data": {
    "id": 1,
    "name": "string",
    "sender": "string",
    "status": "creation",
    "message_type": "sms",
    "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

We use cookies (and other similar technologies) to collect data to improve your experience on our site. By using our website, you’re agreeing to the collection of data as described in our Website Data Collection Policy.