Connection to the SMS-gateway, API

Navigation

You can connect to our SMS-gateway free of charge, no prior activation is needed. SMS-gateway allows to launch automatic SMS delivery and integrate SMS mailing with any project.

All data provided to API should be UTF-8 encoded.

JSON API (recommended method)

Communication with the service is carried out by sending HTTP, method POST, requests to the specified requests to the specified an address using the textual JSON data exchange format.

To authenticate the request, use "OAuth 2", with this type of authentication you need to use token, which can get in your account in the section "Profile". After that, respectively, turn on the given token in the request header, such as : 'Authorization: Bearer your_token'.

Attention!

Limiting the frequency of requests to the service should be no more than 9 requests in second from one client.

Sending messages

Service address:

https://im.smsclub.mobi/sms/send

Messages are sent by specifying the following parameters.

src_addr – Sender from which to send;
phone – An array of numbers, you can send up to 100 numbers for request;
message – Message text;
integration_id – Not required field. Fill when using the referral system;

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

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

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

An example in JSON format::

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

Getting the status of messages

Service address:

https://im.smsclub.mobi/sms/status

To receive message statuses, you need to pass a single parameter:

id_sms – Array of ID messages for which you want to get the status, the limit is not more than 100;

Example in "JSON" format:

{
    "id_sms": ["106"]
}

After a successful request, the system will return an “info” array, in which the key will be the message id, and its status will be the value.

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

Statuses:

200 – Request successfully processed.

Possible message statuses:

ENROUTE – message sent;
DELIVRD – message delivered;
EXPIRED – life expired, message not delivered;
UNDELIV – unable to deliver message;
REJECTD – the message was rejected by the system (blacklist or other filters).

400 – Input parameter validation error.
401 – User authentication error.
429 – Too many requests per time unit. By requests for a given default, it is necessary to perform requests to the services of the service no more than 9 requests in 1 second.
453 – Duplicate messages in an interval of less than 2 minutes.
500х – Service is temporarily unavailable.

Get a list of alpha usernames

Service address:

https://im.smsclub.mobi/sms/originator

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

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

Sample answer:

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

Getting user balance

Service Address:

https://im.smsclub.mobi/sms/balance

To get a balance, you need to make a request to the above URL without the body of the request 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

Sample answer:

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

SMPP-gateway

The gateway corresponds to all standards of SMPP v3.4. protocol. If you want to test the gateway, please contact our managers.

HTTP-gateway

This gateway allows to send HTTP queries to an indicated service address via HTTP protocol (GET/POST methods). If you want to test the gateway, please contact our managers.

XML-gateway

This gateway allows to send XML queries in UTF-8 encoding to an indicated service address via HTTP protocol (POST method). If you want to test the gateway, please contact our managers.