API integration for sending SMS

SMS Club offers interface connection (SMS gateway) for automatic SMS sending. It is possible to integrate the service with any project.

Try it for free

Connection to the SMS gateway of our company's service is free of charge without service activation. The only condition is that the data encoding to be passed to the API must be UTF-8.

JSON:API specification

*recommended

To communicate with the server, the browser needs the POST method. Requests are sent to the required address via the HTTP protocol; for this, the standard text format is used - JSON (JavaScript Object Notation).

The right to access user resources is exercised through the OAuth 2.0 authorization protocol. To authenticate requests, you need a token, to obtain which go to your Personal Account in the Profile section. Select the token and paste it into the header of the request: 'Authorization: Bearer your_token'.

Pay attention! The limit on the number of requests (API access) is up to 9 pcs/sec from each user.

SMS sending via API

Service Internet Address: https://im.smsclub.mobi/sms/send

To send SMS notifications via the API, you must specify the following data:

src_addr

Alphanumeric sender name

Phone

Subscriber numbers
(no more than 100 in one request)

message

SMS content

integration_id

*may not be filled

*specify if you work on referral programs

The successful sending of notifications to the partner system is confirmed by returning an array, where "info" is the key, the id of the notification in the SMS Club system. According to this id, a status is assigned, where the phone number of the subscriber to whom the SMS was sent is a value. See sample: "107" - sms id, 380989371132 - client 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

How to get SMS status

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

id_sms - unique SMS identifier, the transmission of which causes the status to be received. You can also send an array of notification IDs, not exceeding 100 IDs. With a successful request, the program returns an info array, where id is the SMS key, value is the status.

Example:

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

Possible answer:

{
 "success_request": {
    "info": {
        "107": "ENROUTE"
    }
 }
}

Status Options

200 – Success! Request completed. Possible notification statuses:

ENROUTE

SMS sent

DELIVRD

SMS received

EXPIRED

Delivery time expired

UNDELIV

SMS cannot be sent

REJECTD

SMS rejected

Error

400

Raw data not validated

401

The user is not recognized by the system

429

The limit of requests per unit of time has been exceeded

453

Doubled SMS in less than 2 minutes

500x

Program crash. Try later

Getting alphanumeric subscriber names

Support Internet Address: https://im.smsclub.mobi/sms/originator

You can get active alpha names by querying the URL above. It is enough to send the available data, which does not include textual content.

If the request is completed, the program will return a list of free alpha names:

Feedback on successful request

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

How to get user balance

Support Internet Address: https://im.smsclub.mobi/sms/balance

Send a request to the above URL. The text content in the authorized user data does not need to be specified.

If the request is completed, the program will return the "info" array, in which:

money - balance
currency - currency

Feedback on successful request

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

SMPP gateway

ESME

SMSC

MSC

SMS, EMS, WAP, USSD, ets

The hardware router complies with the SMPP v3.4 protocol. To test a hardware router, contact our specialist.

HTTP Gateway

The network gateway sends HTTP requests to the assigned service URL. The HTTP protocol and GET/POST methods are used for sending. To test the router, contact our specialists.

XML Gateway

A hardware router is designed to send XML requests to a designated address. Requests encoded in UTF-8 are sent via HTTP using the POST method. To check the network gateway, contact our specialist.

Loading Samples

Select a gateway and download sample scripts.