SMS

Request to Send SMS

To generate a test request with your parameters, please open the request generator.

Request Examples

Request exampleExample of extended request

{
  "login":"YOUR_LOGIN",
  "password":"YOUR_PASSWORD",
  "destAddr":"Subscriber's_Number",
  "message":{
    "type":"SMS",
    "data":{
      "text":"Text. Follow link: <http://verylongurl.com/very/long/url>",
      "serviceNumber":"SENDER'S_NAME",
      "ttl":10
    }
  }
}

Parameters

Parameter	Required	Data type	Description
login	yes	string	Partner’s name in the system.
password	yes	string	Partner’s password in the system.
useTimeDiff	no	boolean	Taking into account the time zone when starting messaging. More details If true, the message is sent to the subscriber according to the messaging schedule and his time zone. If false, the message is sent according to the messaging initiator schedule UTC+3 regardless of the message recipient time zone. Default value: false.
id	no	string	Unique identifier on the Partner’s side. More details This parameter is necessary for controlling repeated submissions and duplication (the control service is activated separately). The Partner can call the Service Provider (request to send a message) multiple times with the same ID. In this case, the message will be sent to the subscriber only once (on the first request). In response to the requests, the Service Provider will return the same message identifier in the Service Provider's system to the Partner (the same as for the first request). The Service Provider optionally returns this identifier to the Partner in the message delivery report if it is available.
shortenLinks	no	boolean	Parameter controls the automatic shortening of long links in the message. More details Possible values are: true — to shorten links (by default); false — shortening link is not required. If the parameter is not included in the request, but the service is available to the Partner, the links will be shortened by default. The ability to use this service is discussed and configured in advance by the Service Provider. For more details: Link Shortening Service.
scheduleInfo	no	object	Messaging schedule. More details If not specified, it is sent immediately upon receipt of the request.
scheduleInfo/timeBegin	no	string	Start time. More details Example: 10:00.
scheduleInfo/timeEnd	no	string	End time. More details Example: 21:00.
scheduleInfo/ weekdaysSchedule	no	string	Messaging days. More details Specified by numbers from 1 (Monday) to 7 (Sunday), for example, 12345. If there are no restrictions on days of the week, this parameter can be empty or not delivered in the request.
scheduleInfo/deadline	no	string	End date of the messaging. More details Example: 2024-05-10T16:29:30+0300.
destAddr	yes	string	Subscriber’s phone number. More details It contains the country code, operator code and phone number. For the Russian Federation, the code can be 8, 7 or +7. Examples: 72101234567, +72101234567, 8-210-123-45-67, 82101234567.
message	yes	object	Parameters of a message being sent.
message/type	yes	enum	Message type. More details The value of SMS is transmitted.
message/data	yes	object	Parameters of the data being sent.
message/data/text	yes	string	Text of the message being sent. More details Character limit: no more than 2000.
message/data/ serviceNumber	no	string	Service name from which the message is being sent. More details This parameter is required in the request when a service name is not specified in the client settings. If it is specified, then it becomes optional in the request. If it is specified in the client settings and passed in the request, the message to the subscriber will be sent from the name specified in the request.
message/data/ttl	no	integer	Message lifetime. More details Acceptable range in minutes: from 1 to 2880. Note When ttl = 0 or the parameter is absent in the request, the value from the default settings is used, which is set during the integration setup separately for each client.
message/data/ttlUnit	no	enum	Unit of measurement of the message delivery period. More details It is transmitted only with ttl. Possible values are: SECONDS; MINUTES (by default); HOURS.
registeredDelivery	no	integer	Requirement of delivery reports. More details Possible values are: 0 — statuses are not required; 1 — statuses are required (by default); 2 — only "Undelivered" status is required.
notifyUrl	no	string	Hostname of the incoming API to receive the delivery report. More details This parameter is optional in the request, but if sent you should consider the following: if the parameter is specified, it cannot be empty. The notifyUrl string must be no more than 2048 characters long. If any of the specified conditions are not met, an error will be generated and the request will not be executed.
extraParam	no	string	Additional parameters passed as param1=value1,param2= value2, where param1 and param2 — parameter names, value1 and value2 — values. More details The comma character cannot be included in the parameter name, but it can be included in its value — in this case it must be doubled. Example: the string place=abzakovo,name=guest house-2,coordinates=53.8085896,,58.6362112, from=23.02.09,to=05.03.09.
cascadeChainLink	no	object	Cascading message parameters. More details See Cascading Message Sending.

Response

After sending the message, the Service Provider synchronously returns a response. In case of a successful submission, HTTP code 200 OK is returned.

Successful SMS Sending

Response exampleResponse parameters

  {
     "mtNum": "7390612217"
     "id": "8770599"
  }

SMS Sending Errors

For error responses, the HTTP response code will be different from 200 (see Error Codes).

Response exampleResponse parameters

  {
      "error": {
          "code": 9,
          "description": "Message type is not correct"
      },
      "extendedDescription": "SMS sending is not allowed for *user*."
  }

Error Codes

Code	Description	HTTP-code
1	Service is unavailable	503
2	Invalid IP-address	403
3	Too many connections	429
4	Invalid request	400
5	Invalid login	401
6	Invalid password	401
7	serviceNumber is not defined	400
8	destAddr is not correct	406
9	Message type is not correct	406
10	Prohibited sending duplicates	409
11	Invalid TTL	406
100	100	500

SMS Delivery Statuses

To receive SMS message statuses, you need to set up the Delivery Status Service.

Warning

For SMS messages sent to subscribers of the Megafon operator, from the 01.03.2023 the transmission of the “Delivered” and “Undelivered” statuses is stopped.

Delivery Error Codes

Delivery error codes for each message type are provided in the corresponding tab of the Description of Error Codes (parameter status=5) section.