API SMS integration

SMS gateway allows you to automate the distribution of SMS messages and embed the service in any project

Try it for free

You can connect to our SMS gateway for free, service activation is not required. All data that is passed to the API must be encoded in UTF-8.

Sending API Messages

Messages are sent by setting the following parameters:

1.

src_addr

*
Альфа-имя, от которого
идет отправка
2.

Phone

*
Array of numbers
(up to 100 per request)
3.

message

*
Text
4.

integration_id

*optional field
*Fill out when using the referral system

After successfully sending the message to the partner's system, an array will be returned, "info" in which the key is the id of the message in our system, by which you can then get the status, and the value will be the phone number to which the message was sent. In the example below, "106" is the sms id, 380989361131 is the recipient's number.

An example of sending a message in "JSON" format:

{
    "phone" : ["380989361131"],
    "message" : "test text",
    "src_addr" : "VashZakaz"
}
                

An example of a response in "JSON" format:

{
 "success_request": {
    "info": {
        "106": "380989361131"
    }
 }
}
                
Tariffs

Getting the status of messages

To get message statuses, you need to pass a single parameter: id_sms – An array of message IDs for which you need to get the status, the limit is not more than 100. After a successful request, the system will return the “info” array, in which the key will be the message id, but the meaning of his status.

Status request:

{
    "id_sms" : ["106"],
}
                

Sample response in:

{
 "success_request": {
    "info": {
        "106": "ENROUTE"
    }
 }
}
                

Statuses

200 – The request was successfully processed. Possible message statuses:

1.

ENROUTE

message sent
2.

DELIVRD

message delivered
3.

EXPIRED

expired, message not delivered
4.

UNDELIV

message cannot be delivered
5.

REJECTD

message rejected by the system

Error

400

Input validation error

401

User authentication error

429

Too many requests per unit of time

453

Duplication of a message in an interval of less than 2 minutes

500x

Service is temporarily unavailable

Getting a list of alpha usernames

To get a list of available alpha names, you need to make a request to the above URL without a request body using only authorized user information.

After a successful request, the system will return a list of active alpha names:

Response Example

{
 "success_request": {
    "info": [
        "test1",
        "test2"
        ]
    }
}
                    

Getting a user's balance

To get the balance, you need to make a request to the above URL without a request body using only authorized user information

After a successful request, the system will return the user's balance, the array "info" where:

money - balance
currency - account currency

Response Example

{
 "success_request": {
    "info": [
        "money": "8111.1700",
        "currency": "UAH"
        ]
    }
}
                    

SMPP gateway

ESME

SMSC

MSC

SMS, EMS, WAP, USSD, ets

This gateway meets all the parameters of the SMPP v3.4 protocol. To test our gateway, you need contact the manager.

HTTP Gateway

This gateway allows you to send HTTP requests to a given service address via the HTTP protocol using the GET/POST methods. To test our gateway, you need to contact the manager.

XML Gateway

This gateway allows you to send XML requests in UTF-8 encoding to a given service address via the HTTP protocol using the POST method. To test our gateway, you need to contact the manager.

Download examples

Here you can download examples of scripts to work with the selected gateway

Метод JSON
Single   pdf
Mass
Balance
Statuses
Sender IDs
TOP