Pricing plans	Services	API	Partners	About the service	Contacts

^{Free in Russia}

Integration with the service (API)

The API allows you to send messages through your projects and services over HTTP/HTTPS, SMTP and SMPP protocols. Ready-made libraries in different programming languages connect to your project and help you send messages from anywhere with a single command. For simplified authorization, instead of a login and password pair, you can use a special API key.

HTTP/HTTPS SMTP SMPP SOAP OMS SMS Commands Libraries and code examples

MESSAGES SENDING

Sending an SMS message

Sending messages. Server response and error codes

Examples of sending messages

Comments in SMS messages

Sending to a group of numbers

Sending an HLR request

Sending an e-mail message

Examples of sending e-mail messages

Sending a voice message (call)

Using the voice menu (IVR)

Examples of sending voice messages

Sending a viber message

File Transfer

Adding a button

Message types

Examples of sending viber messages

Sending a message to Telegram

Examples of sending messages to Telegram

Sending a message to the Telegram chatbot

Examples of sending messages to the Telegram chatbot

Using prefixes when sending messages

Managing message templates

Managing operator templates

Virtual sending (test mode)

Event Notifications

MANAGING MAILING LISTS

Actions with mailing lists

Mailing. Server response and error codes

Examples of sending operations

MESSAGE STATUSES

Checking the status

Message statuses. Server response and error codes

Status codes

Error codes in the status

Deleting a message

CHECKING THE BALANCE STATUS

Balance Request

Balance. Server response and error codes

MANAGING CONTACTS

Actions with contacts and groups

Contacts and groups. Description of the parameters

Contacts and groups. Server response and error codes

Examples of operations with contacts

CLIENT MANAGEMENT

Work with the subclient

List of available operations

Sub-clients. Description of the parameters

Server response and error codes

Examples of actions with sub-clients

Creating and uploading invoices and reports

MANAGING SENDER NAMES (SENDER ID)

List of available operations with sender names

Description of parameters

Server response and error codes

Examples of actions with sender names

GETTING DATA

Getting the history of sent messages

Receiving incoming messages

Getting statistics

Request for rates

Getting information about the operator

Getting data about a short link

VARIOUS

Connecting dedicated numbers for receiving messages

Transmitting statuses and messages to the Client handler

Connecting anti-spam verification (captcha) to the site

Confirm your phone number with a call

Actions with deferred tasks

Message statuses

Checking the status

To check the delivery status of SMS or e-mail, you need to call the GET or POST address method:


https://smscentre.com/sys/status.php?login=<login>&psw=<password>&phone=<phone>&id=<sms_id>

The following parameters are passed to the server:

Option	The value
login	Customer Login.
psw	Client Password (you can add or change it on this page).
apikey	A special API key used for simplified authorization instead of the "login+password" pair (you can create it on this page).
phone	A phone number or a comma-separated list of numbers when requesting the statuses of multiple SMS messages. For multiple requests, the numbers in the list must be be listed in the order corresponding to the message IDs. To preserve the format of a multiple request, when requesting the status of a single message , enter a comma after the phone number. This description is also suitable for e-mail messages.
id	Message ID or a comma-separated list of IDs when requesting the statuses of multiple messages. To preserve the format of a multiple request when requesting the status of a single message, specify a comma after the message ID.
fmt	Server response format: 0 – (default) as a string (Status = 1, check_time = 10.10.2010 10:10:10). 1 – in the form of a status number and a time stamp separated by commas (1,1286524541). 2 – in xml format. 3 – in json format.
all	0 – (by default) get the status of the message in the usual format. 1 – get full information about the sent message. 2 – add data about the subscriber's country, operator, and region to the message information.
charset	The encoding of the query result, if used other than the default windows encoding-1251. Options: utf-8 and koi8-r.
del	1 – delete a previously sent message. Used in conjunction with the phone and id parameters. This parameter is described in more detail here.

Message statuses. Server response and error codes

If an error occurs, the Server returns the following string:

When fmt = 0:
ERROR = N (description)
When fmt = 1:
0,-N
When fmt = 2:
<result>
<error>description</error>
<error_code>N</error_code>
</result>
When fmt = 3:
{
"error": "description",
"error_code": N
}

N – error number, can take the following values:

The value	Description
1	Error in parameters.
2	Invalid username or password. Also occurs when trying to send a message from an IP address that is not included in the list of allowed by the Client (if such a list was previously configured by the Client).
4	The IP address is temporarily blocked.
5	Error deleting a message.
9	Attempt to send more than five requests to get the status of the same message or more than one mass request within a minute. This error also occurs when you try to send five or more requests simultaneously from different connections under the same username (too many concurrent requests).

If the request is successful, the Server returns a response in the form of a string:

Responses for SMS messages:

with fmt = 0 and all = 0: Status = <status>, check_time = <last_date>, err = <err>
with fmt = 1 and all = 0: <status>,<last_timestamp>,<err>
with fmt = 2 and all = 0:
<sms>
<status>status</status>
<last_date>last_date</last_date>
<last_timestamp>last_timestamp</last_timestamp>
<flag>flag</flag>
<err>err</err>
</sms>
with fmt = 3 and all = 0:
{
"status": <status>,
"last_date": "<last_date>",
"last_timestamp": <last_timestamp>,
"flag": <flag>,
"err": <err>
}

with fmt = 0 and all = 1:

Status = <status>, check_time = <last_date>, err = <err>, send_date = <send_date>, phone = <phone>, cost = <cost>, sender_id = <sender>, status_name = <status_name>, message = <message>, comment = <comment>, type = <type>

with fmt = 1 and all = 1:
<status>,<last_timestamp>,<err>,<send_timestamp>,<phone>,<cost>,<sender>,<status_name>,<message>, <comment>, <type>

with fmt = 2 and all = 1:

<sms>
<status>status</status>
<last_date>last_date</last_date>
<last_timestamp>last_timestamp</last_timestamp>
<flag>flag</flag>
<err>err</err>
<send_date>send_date</send_date>
<send_timestamp>send_timestamp</send_timestamp>
<phone>phone</phone>
<cost>cost</cost>
<sender_id>sender</sender_id>
<status_name>status_name</status_name>
<message>message</message>
<comment>comment</comment>
<type>type</type>
<sms_cnt>sms_cnt</sms_cnt>
</sms>

with fmt = 3 and all = 1:

{
"status": <status>,
"last_date": "<last_date>",
"last_timestamp": <last_timestamp>,
"flag": <flag>,
"err": <err>,
"send_date": "<send_date>",
"send_timestamp": <send_timestamp>,
"phone": "<phone>",
"cost": "<cost>",
"sender_id": "<sender>",
"status_name": "<status_name>",
"message": "<message>",
"comment": "<comment>",
"type": <type>,
"sms_cnt": <sms_cnt>
}

with fmt = 0 and all = 2:

Status = <status>, check_time = <last_date>, err = <err>, send_date = <send_date>, phone = <phone>, mccmnc = <mccmnc>, country = <country>, operator = <operator>, operator_orig= <operator_orig>, region = <region>, cost = <cost>, sender_id = <sender>, status_name = <status_name>, message = <message>, comment = <comment>, type = <type>

with fmt = 1 and all = 2:
<status>,<last_timestamp>,<err>,<send_timestamp>,<phone>,<country>,<operator>,<region>,<cost>,<sender>,<status_name>,<message>, <comment>, <type>

with fmt = 2 and all = 2:

with fmt = 3 and all = 2:

Where:
<status> – status Code (list)
<last_date> – the date of the last status change. Format DD.MM.YYYY hh: mm: ss.
<last_timestamp> – time stamp of the last status change.
<flag> is a flag in the form of a 2 byte number containing various information about the message. Combinations of bit values of different characteristics are possible. Bits 0-3 (message type): 0 – SMS, 1 – Flash-SMS, 2 – Binary SMS, 3 – Wap-push, 4 – HLR-request, 5 – Ping-SMS, 6 – MMS, 7 – Call, 8 – E-mail, 10 – Viber, 12 – Social Networks.
Bit 5 – payment of the message from the second balance. Bit 8 is a sign of a template message.
Bits 10,9 are the type of template message (00 - service, 01 - transactional, 10 - authorization, 11 - advertising).
<err> – error code if the message was not delivered.
<send_date> – date the message was sent (format DD.MM.YYYY hh: mm: ss).
<send_timestamp> – time stamp for sending the message.
<phone> – subscriber's phone number or e-mail address.
<country> – name of the country of registration of the subscriber number.
<operator> – current mobile operator of the subscriber.
<operator_orig> – the subscriber's operator by mobile code before porting the number.
<region> – region of registration of the subscriber number.
<cost> – message cost.
<sender> – sender ID.
<status_name> – status name.
<message> – the text of the message.
<comment> – message comment.
<mccmnc> – the numeric code of the subscriber's country plus the numeric code of the subscriber's operator.
<type><type> - message type (0 – SMS, 1 – Flash-SMS, 2 – Binary SMS, 3 – Wap-push, 4 – HLR-request, 5 – Ping-SMS, 6 – MMS, 7 – Call, 8 – E-mail, 10 – Viber, 12 – Social Networks).
<sms_cnt> – number of parts in an SMS message (or seconds in a voice message).

Responses for HLR queries:

with fmt = 0 and all = 0:
Status = <status>, check_time = <check_time>, err = <err>, imsi = <imsi>, msc = <msc>, mcc = <mcc>, mnc = <mnc>, cn = <cn>, net = <net>, rcn = <rcn>, rnet = <rnet>
with fmt = 1 and all = 0: <status>,<last_timestamp>,<err>,<imsi>,<msc>,<mcc>,<mnc>,<cn>,<net>,<rcn>,<rnet>

with fmt = 2 and all = 0:

with fmt = 3 and all = 0:

with fmt = 0 and all = 1:

Status = <status>, check_time = <check_time>, err = <err>, imsi = <imsi>, msc = <msc>, mcc = <mcc>, mnc = <mnc>, cn = <cn>, net = <net>, rcn = <rcn>, rnet = <rnet>, send_date = <send_date>, phone = <phone>, cost = <cost>, sender_id = <sender_id>, status_name = <status_name>, message = <message>, type = <type>

with fmt = 1 and all = 1:
<status>,<last_timestamp>,<err>,<imsi>,<msc>,<mcc>,<mnc>,<cn>,<net>,<rcn>,<rnet>, <send_timestamp>,<phone>,<cost>,<sender_id>,<status_name>,<message>,<type>

with fmt = 2 and all = 1:

<sms>
<status>status</status>
<last_date>last_date</last_date>
<last_timestamp>last_timestamp</last_timestamp>
<flag>flag</flag>
<err>err</err>
<imsi>imsi</imsi>
<msc>msc</msc>
<mcc>mcc</mcc>
<mnc>mnc</mnc>
<cn>cn</cn>
<net>net</net>
<rcn>rcn</rcn>
<rnet>rnet</rnet>
<send_date>send_date</send_date>
<send_timestamp>send_timestamp</send_timestamp>
<phone>phone</phone>
<cost>cost</cost>
<sender_id>sender_id</sender_id>
<status_name>status_name</status_name>
<message>message</message>
<type>type</type>
</sms>

with fmt = 3 and all = 1:

{
"status": <status>,
"last_date": "<last_date>",
"last_timestamp": <last_timestamp>,
"flag": <flag>,
"err": <err>,
"imsi": "<imsi>",
"msc": "<msc>",
"mcc": "<mcc>",
"mnc": "<mnc>",
"cn": "<cn>",
"net": "<net>",
"rcn": "<rcn>",
"rnet": "<rnet>",
"send_date": "<send_date>",
"send_timestamp": <send_timestamp>,
"phone": "<phone>",
"cost": "<cost>",
"sender_id": "<sender>",
"status_name": "<status_name>",
"message": "<message>",
"type": <type>
}

with fmt = 0 and all = 2:

Status = <status>, check_time = <check_time>, err = <err>, imsi = <imsi>, msc = <msc>, mcc = <mcc>, mnc = <mnc>, cn = <cn>, net = <net>, rcn = <rcn>, rnet = <rnet>, send_date = <send_date>, phone = <phone>, country = <country>, operator = <operator>, region = <region>, cost = <cost>, sender_id = <sender_id>, status_name = <status_name>, message = <message>, type = <type>

with fmt = 1 and all = 2:
<status>,<last_timestamp>,<err>,<imsi>,<msc>,<mcc>,<mnc>,<cn>,<net>,<rcn>,<rnet>, <send_timestamp>,<phone>,<country>,<operator>,<region>,<cost>,<sender_id>,<status_name>,<message>,<type>

with fmt = 2 and all = 2:

with fmt = 3 and all = 2:

Where:
<status> – status Code (list)
<last_date> – the date of the last status change. Format DD.MM.YYYY hh: mm: ss.
<last_timestamp> – time stamp of the last status change.
<flag> is a flag in the form of a 2 byte number containing various information about the message. Combinations of bit values of different characteristics are possible. Bits 0-3 (message type): 0 – SMS, 1 – Flash-SMS, 2 – Binary SMS, 3 – Wap-push, 4 – HLR-request, 5 – Ping-SMS, 6 – MMS, 7 – Call, 8 – E-mail, 10 – Viber, 12 – Social Networks.
Bit 5 – payment of the message from the second balance. Bit 8 is a sign of a template message.
<err> – hLR error code or subscriber status code (list).
<imsi> – unique IMSI code of the subscriber's SIM card.
<msc> – the number of the service center of the operator in whose network the subscriber is located.
<mcc> – numeric code of the subscriber's country.
<mnc> – numeric code of the subscriber's operator.
<cn> – name of the country of registration of the subscriber.
<net> – name of the subscriber registration operator.
<rcn> – the name of the roaming country of the subscriber when he is in a foreign network.
<rnet> – the name of the roaming operator of the subscriber when he is in someone else's network.
<send_date> – date the message was sent (format DD.MM.YYYY hh: mm: ss).
<send_timestamp> – time stamp for sending the message.
<phone> – subscriber's phone number.
<country> – name of the country of registration of the subscriber number.
<operator> – the name of the operator of the subscriber.
<region> – region of registration of the subscriber number.
<cost> – message cost.
<sender> – sender ID.
<status_name> – status name.
<message> – the text of the message.
<type><type> - message type (for HLR, it is equal to 4).

If the message is not found or is in the archive database (the status value is -3), then the status code in the appropriate format is returned for fmt = 0,2,3 . For fmt = 1, a response is returned in the format of the status of a regular message.

When multiple statuses are requested:

for fmt = 0 and fmt = 1, the result returns a list of lines, each of which contains information about the status of the corresponding message.
for fmt = 2, the format of the returned statuses is similar to the format for single messages, with the entire list of statuses contained in the "<list>" tag.
for fmt = 3, the format is also similar to the format for single messages, statuses are separated by commas, and the entire list is framed by square brackets.

In the case of multiple status requests, when the parameter all = 1 or all = 2 is set, the message identifier is additionally returned for each status . If all = 0, the message ID and phone number are additionally returned.

Status codes

Possible variants of message status codes or HLR requests (values of <status>):

Code	Name	Description
-3	Message not found	Occurs if no message was found for the specified phone number and ID.
-2	Stopped	Occurs in messages from the mailing list that did not have time to leave the operator until the moment of temporary suspension of this mailing on the pageMailing lists and tasks.
-1	Waiting send	If the time of receiving the message was set by the subscriber when sending the message, then the message will remain in this status until this time, in other cases, the message will remain in this status for a short time before being sent to the SMS center.
0	Transferred to the operator	The message was sent to the operator's SMS center for delivery.
1	Delivered	The message was successfully delivered to the subscriber.
2	Read	The message was read (opened) by the subscriber. This status is possible for e-mail messages that have the format of an html document.
3	Expired	Occurs if the message "life" time has expired, but it has not been delivered to the recipient, for example, if the subscriber was not available for a certain time or the message buffer in his phone was full.
4	Click on link	The message was delivered and the subscriber clicked the short link passed in the message. This status is possible when the options "Automatically shorten links in messages" and "track subscriber numbers" are enabled in the settings".
20	Unable to deliver	The attempt to deliver the message failed, this can be caused by various reasons, for example,, subscriber is blocked, does not exist, it is roaming without SMS exchange support, or his phone doesn't support receiving SMS messages.
22	Wrong number	Incorrect phone number format.
23	Banned	Occurs when restrictions are triggered on sending duplicates, on frequent messages to a single number (flood), on numbers from the blacklist, on texts prohibited by the spam filter or senders ' names (Sender ID).
24	Insufficient funds	The Client's account does not have enough money to send the message.
25	Unavailable number	The phone number does not accept SMS messages, or there is no working route to this operator.

The request for message statuses must be made within one day from the date of sending. After this time, the messages are placed in the archive database. Messages with the final status sent before 18:00 of the previous day are transferred to 03:00 Moscow time. To get the real status of such messages, please contact the support service.

Also, the server does not accept more than five identical requests for the status of the same message or more than one mass request within a minute to reduce the load and protect against errors and loops in the Client-side program.

Error codes in the status

Possible error codes in the status of messages or HLR requests (values of <err>):

Code	Name	Description
0	No error	The subscriber exists and is available.
1	The subscriber does not exist	The specified phone number does not exist.
6	Subscriber is offline	The subscriber's phone is disconnected or out of range of the network.
11	The service is not connected	Means that the subscriber cannot accept the SMS message. For example, the service is not connected, or the subscriber is roaming, where message reception is not activated, or the subscriber's operator does not exchange SMS messages with the current roaming operator. It can also be a landline number without receiving messages.
12	Error in the subscriber's phone	The message cannot be delivered to the subscriber due to an error in the phone or SIM card.
13	Subscriber is blocked	Occurs, for example, if the subscriber's account has a zero or negative balance, and it is roaming, or blocked by the operator for prolonged non-payment, or voluntarily by the subscriber himself. This error can also be returned if the SIM card is damaged or if the PIN and PUK codes of the SIM card are entered incorrectly.
21	No support for the service	The subscriber's device does not support this service (service).
200	Virtual sending	This notification appears under the message status if the message is sent in test mode (if the "Test mode (virtual sending without payment)" checkbox is set in the settings )").
219	SIM Card Replacement	Error sending a message due to the subscriber replacing the SIM card. After the physical replacement of the SIM card, the subscriber is blocked from receiving messages from the letter names of the senders for 24 hours. The block can be lifted by adding 100 rubles to the balance..
220	Queue overflowed from operator	This error may occur when the subscriber is not available to receive SMS messages, but messages continue to arrive to the operator and the internal message queue for this subscriber is overflowing. In rare cases, an error may occur as a result of a failure in the network of the operator itself or an overflow of the general message queue. In all such situations, the system tries to resend the specified messages several times at certain intervals.
237	The caller is not responding	Occurs if the caller did not pick up the phone during the dial attempt.
238	No template	Occurs if sending a message is possible only according to a certain template, and the message being sent does not satisfy it.
239	Forbidden ip address	Occurs when trying to send a message from an ip address that is not included in the list of ip addresses allowed by the Client to send. It can also occur when you try to send a message from an ip address that was not previously used for sending messages and logging in to your personal account.
240	Subscriber is busy	Occurs when sending a voice message to a subscriber if the line is busy or the subscriber has canceled the call.
241	Conversion error	An audio conversion error occurred when converting a text or audio file to the destination format for sending a voice message to the subscriber. This error may also occur during transmission SMS messages in separate parts, when not all parts are transmitted to the operator.
242	Recorded answering machine	Means that an answering machine was fixed on the subscriber's side when the voice message was sent .
243	No contract	Occurs when you try to send mailings of an advertising or mass nature without a signed contract.
244	Mailing is prohibited	It means that the sending of mass and advertising mailings is prohibited for this Client, or a prohibited link is found in the message text.
245	Status is not received	During the day, the delivery status was not received from the operator, in this case, it is impossible to say for sure whether the message was delivered or not.
246	Time limit	If the "Sending time" is set in the "Settings" section of the "Limits and Restrictions" tab in your personal account and the "prohibit sending at another time" checkmark is checked, then when you try to send SMS messages in a time period other than that specified in the "Sending Time" field, sending messages will be prohibited with this error.
247	Limit exceeded messages	Exceeded the total daily message limit specified by the Client in the personal account in the "Settings" section".
248	No route	This means that sending messages to this number is not available in our service. For example, you entered a non-existent mobile code, or there is no working SMS gateway for the specified number and text.
249	Invalid number format	Occurs when the mobile code of the specified number and the number length corresponding to this code are incorrect.
250	Telephone number is forbidden settings	The number fell under the restrictions set by the Client for mobile numbers in the personal account in the "Settings" section".
251	Limit is exceeded on a single number	Exceeded the daily message limit per number. The limit is set By the Client in the personal account in the "Settings"section. Also, this error is possible when sending more than 50 messages to one subscriber, which were sent with a break between messages of less than 30 seconds.
252	Number not permitted	Occurs, for example, when a Client tries to specify one of our federal numbers as the recipient of an SMS message.
253	Prohibited spam filter	If the text of the message contains obscene expressions and insults, calls to send sms and some other prohibited texts, then sending the message will be blocked. It is also forbidden to specify as the sender short paid numbers, the number of the recipient of messages, the names of operators, other people's Internet resources, companies and government organizations.
254	Unregistered sender id	This error occurs when you try to send a message from an unregistered sender name.
255	Rejected by operator	The operator rejected the message without specifying the exact error code. This happens, for example, when the number does not belong to any mobile operator, i.e. with a non-existent code, or for some other reason, the operator cannot deliver the message.

Possible error codes in the status of e-mail messages (values of <err>):

Code	Name	Description
0	No error	The recipient exists and is available.
1	Recipient does not exist	The specified e-mail address does not exist.
2	Crowded Inbox	The recipient's mail server rejected the message with the specified error code.
3	Recipient server was not found	The domain specified as the mail server was not found.
4	Mailbox is locked	An error returned from the recipient's mail server stating that the message could not be delivered due to the mailbox being blocked.
239	Forbidden ip address	Occurs when trying to send a message from an ip address that is not included in the list of ip addresses allowed by the Client to send. It can also occur when you try to send a message from an ip address that was not previously used for sending messages and logging in to your personal account.
245	Status is not received	During the day, the delivery status was not received from the recipient's mail server, in this case it is impossible to say for sure whether the message was delivered or not.
248	No route	It means that sending messages to this e-mail address is not available in our service. For example, there is no working e-mail gateway for the specified address and text.
249	Invalid format'	Occurs when the recipient's e-mail address is entered incorrectly in the format.
252	E-mail address is prohibited	Occurs, for example, when the specified e-mail address is found in the blacklist.
253	Prohibited spam filter	If the text of the message contains obscene expressions and insults, calls to send sms or e-mail and some other prohibited texts, then sending the message will be blocked. It is also prohibited to specify as the sender the e-mail address of the recipient of the message, the addresses of other people's Internet resources, companies and government organizations.
254	Unregistered sender	This error occurs when trying to send a message from an unregistered e-mail address of the sender.
255	Rejected by the recipient server	The recipient's mail server rejected the message without specifying the exact error code. This happens, for example, when an internal server error occurs when it cannot process a message.

Deleting a message

To delete a message, you need to call the status request script using the GET or POST method, specifying the del command:


https://smscentre.com/sys/status.php?del=1&login=<login>&psw=<password>&phone=<phone>&id=<sms_id>

The description of the parameters passed to the Server and the errors returned by it is similar to the one given for the status request function.

If the request is successful, the Server returns a response in the form of a string:

when fmt = 0,1: OK
when fmt = 2:
<result>OK</result>
when fmt = 3:

{
"result": "OK"
}

Messages must be deleted before being transferred to the archive database.

Log in via:


Remember for auto entry



Registration	Forgot your password?


© 2003–2024 SMS Center LLC	support@smscentre.com Contacts		Design — Artemy Lebedev Studio Site Information