API

WIth our trusted and RESTFul API, you can quickly and easily integrate our services on any third party systems or develop awesome SMS applications too.

SMSKit is a high quality SMS platform which enables you to integrate any of your applications with our message sending and receiving system. The main advantage of our system is its simplicity of implementation. The SMS message may have your company name or any phone number that you own as sender name. Every message sent from our system has its own unique id which allows you to receive its delivery confirmation.

How To Get Started

To start using SMSKit you need to Create an Account. Registration is completely free of charge. Your account is ready to use just after registration,

Once you are have registered, login to your account and navigate to Extras -> API to enable API access on your account and manage your API credentails.

API Authentication

User authentication is required to interact with our API end-point. Authentication is done by passing your API Key and API Token as part of your request body

Sample authentication request

Sending a Message

API End-point:              https://account.smskit.net/smsAPI?sendsms
Request Method:        POST or GET

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • type: Message Type Eg. sms, voice, unicode, flash, mms, whatsapp (default is sms) (required)
  • from: Your Sender ID (required)
  • to: Destination Number (country code) (required)
  • text: Your message text (url encoded) (required)
  • file: Voice file URL (for voice message) or Multimedia file URL (for mms or whatsapp message) (optional)
  • scheduledate: Date and Time to send message (YYYY-MM-DD HH:mm:ss) (optional)
  • duration: Duration of your voice message in seconds (required for voice)

Sample Success Response (JSON)

  •                     {
                            "request": "sendsms",
                            "status": "queued",
                            "group_id": "1234",
                            "date": "2018-04-24 12:25:23"
                        }   
                    

Sample Error Response (JSON)

  •                      {
                            "request": "sendsms",
                            "status": "error",
                            "message": "Sender ID not allowed"
                        }   
                     

Check Message Status

API End-point:              https://account.smskit.net/smsAPI?groupstatus
Request Method:        POST or GET

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • groupid: The group_id returned by sendsms request (required)

Sample Success Response (JSON)

  •                    {
                            "request": "groupstatus",
                            "status": "success",
                            "group_id": "1234",
                            "group_status": "sent",
                            "recipients": [
                                {
                                    "id": "21",
                                    "to": "231235433",
                                    "status": "failed"
                                },
                                {
                                    "id": "22",
                                    "to": "4471235433",
                                    "status": "sent"
                                },
                                {
                                    "id": "25",
                                    "to": "1871235433",
                                    "status": "queued"
                                }
                            ],
                            "date": "2018-04-24 12:25:23"
                        }   
                   

Sample Error Response (JSON)

  •                     {
                            "request": "groupstatus",
                            "status": "error",
                            "message": "Error message",
                        }   
                     

Fetching Message Inbox

API End-point:              https://account.smskit.net/smsAPI?getinbox
Request Method:        GET

Sample Request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • list: "all" will return all messages while "unread" will return only unread messages (default is unread) (optional)

Sample Success Response (JSON)

  •                     {
                            "request": "getinbox",
                            "status": "success",
                            "inbox": [
                                {
                                    "id": "12",
                                    "from": "123456789",
                                    "to": "2347015272",
                                    "message": "Hi. This is message 1",
                                    "date": "2018-04-24 12:25:23"
                                },
                                {
                                    "id": "26",
                                    "from": "447882892",
                                    "to": "2347015272",
                                    "message": "Hi again. This is message 2",
                                    "date": "2018-04-24 12:25:23"
                                }
                           ]
                        }   
                     

Sample Error Response (JSON)

  •                     {
                            "request": "getinbox",
                            "status": "error",
                            "message": "Error",
                        }   
                     

Credit Balance

API End-point:              https://account.smskit.net/smsAPI?balance
Request Method:        GET

Sample Request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)

Sample Success Response (JSON)

  •                     {
                            "balance": "12345"
                        }   
                     

Sample Error Response (JSON)

  •                     {
                            "request": "balance",
                            "status": "error",
                            "message": "Invalid user",
                        }