Bulk SMS HTTP API Specifications:

SMS Messaging

https://api.bulksmsonline.co/smsapi?username=XXXX&password=YYYYY&type=Y&to=0000000000&source=sender&message=YourText
                    

All parameters are explained below. Note that all the parameters, especially message and URL should be URL-UTF-8 encoded.

https://api.bulksmsonline.co/smsapi?username=XXXX&password=YYYYY&type=t&to=00000000&source=xxxxxxx&message=Test%20Message!!!
                        

https://api.bulksmsonline.co/smsapi?username=XXXX&password=YYYYY&type=u&to=00000000&source=xxxxxxxx&message= 00620075006C006B0073006D0073006F006E006C0069006E0065
                        

https://api.bulksmsonline.co/smsapi?username=XXXX&password=YYYYY&type=t&to=00000000&source=xxxxxxxx&message= TestMessage&Scheduled=2020-01-08T05:54:00
                        

https://api.bulksmsonline.co/balance?username=XXXX&password=YYYYY
                        

SMPP API SMS Messaging

For our customers that require low level control of SMS messaging and lowest possible latency, we offer our Enhanced SMPP service

Therefore, you need to reach out to our support team to get your credentials whitelist to use this service. This document provides a reference for all features available to you via the SMPP interface for sending SMS. Most importantly, SMPP is the industry standard for sending SMS to Network providers and is our native protocol.

Telecommunications industry uses the Short Message Peer-to-Peer (SMPP) as a protocol for exchanging SMS messages between Short Message Service Centers (SMSC) and/or External Short Messaging Entities (ESME).

The protocol is a level-7 TCP/IP protocol, which allows fast delivery of SMS messages.

The most commonly use versions of SMPP are v3.3. Moreover, the most widely supportive standard, and v3.4, which adds transceiver support (single connections that can send and receive messages).

Subsequently, data exchange may be synchronous, where each peer must wait for a response for each PDU being sent.

Furthermore asynchronous, where multiple requests can be issued in one go and acknowledged in a skew order by the other peer.

• SMPP is a direct connection to carriers and routes sources and provides instant delivery
• High throughput (up to 60 msgs/second)
• Usage of Short Code
• SMPP offers status delivery reports
• 24/7 support via our support system

Submitting Messages

Submission Types:

Submission of messages may with either submit_sm or data_sm, using either the short_message or message_payload fields.
The message length may not exceed the byte limit for the network that the message is being sent to (for example 140 byteson GSM networks).

Support of concatenated messages by using the User Data Header (UDH), which include in the message size byte limit.

Restful API SMS Messaging

Overview

RESTful API is ideal for the programmatic sending of SMS, regardless of volume. Developers wanting a more extensive integration solution will find that this API perfectly caters to their programmatic sending needs. The API is designed using RESTful standards over HTTP and accepts JSON data.

Required Knowledge

If you plan on using the API you should be familiar with the following:

• JSON
• HTTP
• REST

Base URL

The base URL for the API is:

https://api.bulksmsonline.co
                            

The base URL supports HTTPS. To access a specific version of the API, simply postfix the URL with the version of the API, as in the case of:

https://api.bulksmsonline.co/rest/api/v1
                            

The base URL will always be set to use the latest version of the API. However, in order to reduce the chance of compatibility issues, always reference the version you are developing against in the URL.

API Access

To use the API you must use your account username and password to generate a temporary token (See Authentication Tokens) and include the token in HTTP requests. This mechanism minimises the risk of compromising your API credentials.

With the prerequisites completed, you can now start using the API. The following sections of this guide will briefly explain the available features of the REST API.

For technical details about the HTTP request and response objects for each function, please refer to the following documentation.

Introduction

The REST Messaging API is designed to be a simple and powerful tool for large scale messaging with features such as:

• Use a convenient HTTP interface.
• Organize your frequent recipients into groups.
• Send messages at a later time with scheduling.
• Customize your message for each recipient using parameterization.
• Automatic default originator selection support for messages without originator.

Base URL to Generate Token

https://api.bulksmsonline.co/rest/api/v1/sms/gettoken/username/YourUsername/password/YourPassword
                    

Example request with token to send a SMS

Base URL to send sms
The following URLs can be used by the REST API. We have servers in the US and Singapore.

https://api.bulksmsonline.co/rest/api/v1/sms/send/
                    

Rate Limits

The rate limit is calculated from all messages sent via the API, so a batch with 15 recipients will count as 15 messages for rate limiting purposes.

This means that new batches will be accepted immediately but might be delayed if earlier batches are still on queue.

SMS REST formats

This section will take a brief look at some of the formats used in the REST API.

• JSON

  JSON (application/json) is the content type of both requests and responses if not otherwise specified. Requests with invalid JSON will be rejected.

  Null values can be omitted in requests and will be omitted in responses. In some cases explicitly setting null will overwrite a previously set value with null. See Update a group for an example.

• MSISDN

  Only MSISDNs in international format are accepted by the API..
  MSISDNs can be sent in with or without a leading + (i.e. +123456789 or 123456789) and without a leading 00.

  Any space, dash or bracket will also be ignored by the API.
  All MSISDNs returned by the REST API will be without a + or 00 prefix, even if they were sent in with one.

SMS REQUEST OBJECT PARAMETER

{
   from           string
                  nullable: true
   to             [
                  nullable: true
                  string]
   type           stringEnum:
                  [ Text, FlashText, UniCode, UniCodeFlash ]
   content        string
                  nullable: true
   sendDateTime   string($date-time)
                  nullable: true
}
                    

Introduction of MNV Lookup

Number validation and database optimization

https://api.bulksmsonline.co/mnv?username=XXXX&password=YYYYY&msisdn=12345677899
                    

General

You can use Number Validation API to retrieve validity information for a phone number. Number Validation API is a synchronous, easy-to-use web service. As any phone number is concerned, you can:

• Retrieve the international and local format
• Find out about the country it is registered in
• Identify the mobile country code and mobile network code (MCC/MNC) of a mobile phone number for routing outbound communication
• Improve security checks by comparing the country of the provided phone number with the country of a provided IP or domain name.

You can use Number Lookup Services for:

Database Cleaning

Designed for companies with vast number of database records, our Database Cleaning package enables identifying unused and inactive numbers.

Optimize Communication Expenses

Our MNV service differentiates between landline and mobile phone numbers. This, in turn, helps you send SMS to the apt line type and consequently saves your valuable resources and time for your business.

Introduction of MNP Lookup

Number lookup and database optimization

https://api.bulksmsonline.co/mnp?username=XXXX&password=YYYYY&msisdn=12345677899
                    

General

Performing a Number Lookup provides a direct network level check against any GSM mobile number. The check can provide detailed information, such as the original network a mobile number was assigned, whether the number has been ported to a different network, which ported network it has moved to, if the mobile has been turned on recently and the country the mobile was last used.

Mobile subscribers often change numbers, roaming or change providers while retaining their original phone number (ported numbers). Knowing which mobile numbers are in use and available, or which network your client is currently using, can greatly improve accuracy and cost effectiveness for many types of businesses..

With Number Lookup, you can determine:

• Which numbers are currently active
• If the mobile number is in roaming state
• If the mobile number is ported to another mobile operator
• The optimal route for messages and voice

You can use Number Lookup Services for:

Database Cleaning

Designed for companies with vast number of database records, our Database Cleaning package enables identifying unused and inactive numbers.

Telecoms

Roaming information is used to optimize phone call routing and termination, and minimise telecom costs.

Roaming

Financial institutions (BFI) using the service, for roaming (location) information in order to prevent ATM frauds and much more.

Saves money and time

Search the home network of your current customers and direct your calls consequently.

Calling Restful API using C# .Net

''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' '''''''' 
' :: How to generate Token in C# using our Restful API
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' '''''''' 
var client              = new RestClient(" https://api.bulksmsonline.co/rest/api/v1/sms/gettoken/username/YOURUSERNAME/password/YOURPASSWORD");
var request             = new RestRequest(Method.GET);
IRestResponse response  = client.Execute(request);

''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' '''''''' 
' ::: How to send sms with your generated Token
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' '''''''' 

var client  = new RestClient(" https://api.bulksmsonline.co/rest/api/v1/sms/send");
var request = new RestRequest(Method.POST);

request.AddHeader("content-type", "application/json");
request.AddHeader("token", "USER TOKEN GENERATED FROM GET TOKEN API");

request.AddParameter(
    "application/json",
    "{\"from\":\"Sender Name\",\"to\":[\"12345678999\",\"12345678999\"],\"type\":\"Text\",\"content\":\"Sample SMS Content To Be Sent\"}",
    ParameterType.RequestBody);

IRestResponse response = client.Execute(request);
                    

Calling Restful API using PHP

/* 
*:: How to generate Token in PHP using our Restful API
*/ 
    " https://api.bulksmsonline.co/rest/api/v1/sms/gettoken/username/YOURUSERNAME/password/YOURPASSWORD",
    CURLOPT_RETURNTRANSFER  => true,
    CURLOPT_ENCODING        => "",
    CURLOPT_MAXREDIRS       => 10,
    CURLOPT_TIMEOUT         => 30,
    CURLOPT_HTTP_VERSION    => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST   => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
/* 
*::: How to send sms with your generated Token
*/

    " https://api.bulksmsonline.co/rest/api/sms/send",
    CURLOPT_RETURNTRANSFER    => true,
    CURLOPT_ENCODING          => "",
    CURLOPT_MAXREDIRS         => 10,
    CURLOPT_TIMEOUT           => 30,
    CURLOPT_HTTP_VERSION      => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST     => "POST",
    CURLOPT_POSTFIELDS        => "{\"from\":\"Sender Name\",\"to\":[\"12345678999\",\"12345678999\"],\"type\":\"Text\",\"content\":\"Sample SMS Content To Be Sent\"}",
    CURLOPT_HTTPHEADER        => array(
                                "token : USER TOKEN GENERATED FROM GET TOKEN API",
                                "content-type: application/json"
                            ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                    

Calling Restful API using Java

/** 
* :: How to generate Token in JAVA using our Restful API
**/
OkHttpClient client = new OkHttpClient();

Request request     = new Request.Builder()
  .url(" https://api.bulksmsonline.co/rest/api/v1/sms/gettoken/username/YOURUSERNAME/password/YOURPASSWORD")
  .get()
  .build();

Response response   = client.newCall(request).execute();

/** 
* ::: How to send sms with your generated Token
**/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(
    mediaType,
    "{\"from\":\"Sender Name\",\"to\":[\"12345678999\",\"12345678999\"],\"type\":\"Text\",\"content\":\"Sample SMS Content To Be Sent\"}"
    );
Request request = new Request.Builder()
  .url(" https://api.bulksmsonline.co/rest/api/v1/sms/send")
  .post(body)
  .addHeader("token", "USER TOKEN GENERATED FROM GET TOKEN API")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();