Developers API

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

Contents

 

Getting Started

API Authentication

Sending A Message

Check Message Status

Fetching Message Inbox

Check Credit Balance

Create Whatsapp Channel

List Whatsapp Channels

Scan QR Code

View Channel Details

Clear Channel Message Queue

Reset Channel

Delete Channel

Getting 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 (Single or Bulk)

.

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: Comma separated list of Destination Number(s) (including 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",
                        }

 

Check 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",
                        }

 

Create Whatsapp Channel

.

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

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • label: The label to use for your new channel (required)
  • plan: The billing package for your new channel. E.g starter, business, pro or enterprise (See Whatsapp Packages & Pricing)(required)

Sample Success Response (JSON)

  •                        {
                            "request": "createchannel",
                            "status": "success",
                            "channel_id": "53583gd693dg93tdg923gd2reo",
                            "gateway_id": "123",
                            "subscription_end": "2018-04-24 12:25:23"
                        }

Sample Error Response (JSON)

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

 

List Whatsapp Channels

.

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

Sample request

Parameters

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

Sample Success Response (JSON)

  •                        {
                            "request": "listchannel",
                            "status": "success",
                            "channels": [
                                {
                                    "channel_id": "53583gd693dg93tdg923gd2reo",
                            		"gateway_id": "123",
                                    "whatsapp_number": "123456789",
                                    "label": "My First Channel",
                                    "last_sync": "2019-04-24 12:25:23"
                                },
                                {
                                    "channel_id": "61fg68d6f3dg83tggr78gd2c7h",
                            		"gateway_id": "456",
                                    "whatsapp_number": "123556789",
                                    "label": "My Other Channel",
                                    "last_sync": "2019-06-14 12:25:23"
                                }
                           ]
                            "channel_count": "2"
                        }

Sample Error Response (JSON)

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

 

Scan QR Code

.

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

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • channel_id: The channel ID generate scan QR image (required)

Sample Success Response (Base-64 image Code)

  •       Base-64 encoded image that renders the generated QR image from whatsapp

Sample Error Response (JSON)

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

 

View Channel Details

.

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

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • channel_id: The ID of channel to view (required)

Sample Success Response (JSON)

  •                        {
                            "request": "viewchannel",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                            "gateway_id": "123",
                            "plan": "pro",
                            "whatsapp_number": "123456789",
                            "whatsapp_version": "1289",
                            "label": "My First Channel",
                            "last_sync": "2019-04-24 12:25:23"
                            "device_status": "session active",
                            "up_time": "2:04:44"
                        }

Sample Error Response (JSON)

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

 

Clear Channel Message Queue

.

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

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • channel_id: The ID of channel to clear queue on (required)

Sample Success Response (JSON)

  •                        {
                            "request": "clearqueue",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                            "queue_count": "0"
                        }

Sample Error Response (JSON)

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

 

Reset Channel

.

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

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • channel_id: The ID of channel to reset (required)

Sample Success Response (JSON)

  •                        {
                            "request": "resetchannel",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                        }

Sample Error Response (JSON)

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

 

Delete Channel

.

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

Sample request

Parameters

  • apikey: Your unique API Key (required)
  • apitoken: Your unique API Token (required)
  • channel_id: The ID of channel to delete (required)

Sample Success Response (JSON)

  •                        {
                            "request": "deletechannel",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                        }

Sample Error Response (JSON)

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

 


We provide best bulksms communication tools, bulksms sms API, and sms coverage to more than 760 networks in the world. Our reliable and high availability infrastructure with capability to send more than 15000 sms per second. Our products are aimed in building our customers success which helps them to achieve their business objectives and day to day business communication needs

Copyright © 2023 SMSKit.net