{"id":1927,"date":"2023-06-08T19:12:22","date_gmt":"2023-06-08T16:12:22","guid":{"rendered":"https:\/\/docs.unibell.tech\/?page_id=1927"},"modified":"2026-01-12T09:38:27","modified_gmt":"2026-01-12T06:38:27","slug":"sms-http-api","status":"publish","type":"page","link":"https:\/\/docs.unibell.tech\/?page_id=1927","title":{"rendered":"SMS API"},"content":{"rendered":"\n

Sending an SMS message<\/h2>\n\n\n\n

Request<\/strong><\/h2>\n\n\n\n

POST\/GET https:\/\/api.unibell.tech\/sms_new?X-Authorization=AccessKey<\/p>\n\n\n\n

d8ac9959r12b43545XXXXX&destAddr=7917XXXXXXX&sourceAddr=XXXXX&short Message=Hi, how are you?<\/p>\n\n\n\n

Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
destAddr<\/td>string<\/td>The phone number to which the SMS
message is sent, in e.164 format, for the Russian Federation
7XXXXXXXXXX<\/td><\/tr>
sourceAddr<\/td>string<\/td>Sender’s name<\/td><\/tr>
shortMessage<\/td>string<\/td>Message text<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response<\/strong><\/h2>\n\n\n\n
{\n\u201creference\u201d: \u201c5b922bba6be053cd6a2ecebb1a31438a\u201d,\n\u201cstatus\u201d: \u201cok\u201d,\n}<\/code><\/pre>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
status<\/td>string<\/td>Request status, see above<\/td><\/tr>
reference<\/td>string<\/td>Unique message ID<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
To get the results of the request execution, a callback<\/p>\n\n\n\n
over the HTTP\/HTTPS protocol can be configured using the POST method. The parameters are passed Content-Type: application\/x-www-form-urlencoded.<\/p>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
reference<\/td>string<\/td>Unique message ID<\/td><\/tr>
sourceAddr<\/td>string<\/td>Sender’s name<\/td><\/tr>
destAddr<\/td>string<\/td>The phone number to which the SMS
message is sent, in e.164 format, for the Russian Federation
7XXXXXXXXXX<\/td><\/tr>
status<\/td>string<\/td>SMS Message Status
DELIVERED \u2014 delivered
UNDELIVERABLE \u2014 not delivered (clarification in
networkErrorCode)
REJECTED \u2014 rejected with an error(clarification in
networkErrorCode)<\/td><\/tr>
networkErrCode<\/td>string<\/td>SS7 errors, see below<\/td><\/tr>
imsi<\/td>string<\/td>Subscriber’s IMSI<\/td><\/tr>
vlr<\/td>string<\/td>Subscriber’s VLR<\/td><\/tr>
hlr<\/td>string<\/td>Subscriber’s HLR<\/td><\/tr>
createdDateTime<\/td>string<\/td>Date\\time of creation<\/td><\/tr>
statusDateTime<\/td>string<\/td>Date\\time of status receipt<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Error codes in the status<\/h2>\n\n\n\n
Possible error codes in the status of SMS messages or HLR requests (values of networkErrCode), all unspecified codes are considered vendor specific and are not processed separately:<\/p>\n\n\n\n
Code<\/th>Name<\/th>Description<\/th><\/tr><\/thead>
0<\/td>No error<\/td>The subscriber exists and is available.<\/td><\/tr>
1<\/td>The subscriber does not
exist<\/td>		The specified phone number does not exist.<\/td><\/tr>
6<\/td>The subscriber is offline<\/td>The subscriber’s phone is disconnected or is out
of range of the network.<\/td><\/tr>
11<\/td>No SMS service<\/td>Means that the subscriber cannot receive
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 have an SMS exchange with the current
roaming operator. It can also be
a landline number without receiving messages.<\/td><\/tr>
12<\/td>Error in the subscriber’s phone<\/td>The message cannot be delivered to the subscriber due to an
error in the telephone or SIM card.<\/td><\/tr>
13<\/td>The subscriber is blocked<\/td>Occurs, for example, if the subscriber’s account
has a zero or negative balance, and he is
roaming, or blocked by the operator for
prolonged non-payment or voluntarily
by the subscriber himself. Also, this error may
return if the SIM card is damaged or
the PIN and PUK codes of the SIM card are entered incorrectly.<\/td><\/tr>
21<\/td>No service support<\/td>The subscriber’s device does not support working with
this service (service).<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
Sending an SMS message Request POST\/GET https:\/\/api.unibell.tech\/sms_new?X-Authorization=AccessKey d8ac9959r12b43545XXXXX&destAddr=7917XXXXXXX&sourceAddr=XXXXX&short Message=Hi, how are you? Parameter Type Description destAddr string The phone number to which the SMSmessage is sent, in e.164 format, for the Russian Federation7XXXXXXXXXX sourceAddr string Sender’s name shortMessage string Message text Response Parameter Type Description status string Request status, see above reference string Unique message …  SMS API<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":9,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"tpl\/http-content.php","meta":{"footnotes":""},"class_list":["post-1927","page","type-page","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/1927","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1927"}],"version-history":[{"count":6,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/1927\/revisions"}],"predecessor-version":[{"id":3490,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/1927\/revisions\/3490"}],"up":[{"embeddable":true,"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=\/wp\/v2\/pages\/9"}],"wp:attachment":[{"href":"https:\/\/docs.unibell.tech\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1927"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}