Messaging API Documentation

Welcome to the Best SMS Bulk Messaging API documentation. This API allows you to easily integrate SMS and WhatsApp messaging capabilities into your applications. Whether you are building a notification system, sending marketing campaigns, or implementing an OTP service, our API provides reliable, scalable messaging capabilities with straightforward HTTP endpoints.

Overview

Our messaging API enables developers to send text messages via SMS and WhatsApp. With our powerful, easy-to-use API, you can interact with the messaging platform using JSON or HTTP endpoints, providing flexible options for different use cases.

Core Features

Send SMS and WhatsApp Messages: Use our versatile API to send text messages through SMS or WhatsApp with configurable sender IDs and templates.
Scheduled Messaging: Set scheduled times for message delivery, making it perfect for reminders and campaigns.
OTP Verification: Easily send OTP codes for user authentication via WhatsApp or SMS, enhancing the security of your platform.
Message Delivery Status Tracking: Obtain real-time information about message delivery status, ensuring transparency and reliable communication with users.
Security: Our secured messaging API utilizes secure tokens and API keys for authorization to protect sensitive information.

Getting Started

To start using our API, you need to follow the steps below:

Sign Up: Create an account at Best SMS Bulk to get access to your API credentials.
API Key: Once registered, navigate to Agent - Users - edit the API user - Generate an API key. This key is required to authorize requests related to the secured messaging API (Section 6).
Authentication: Our API supports both Basic Authentication (username/password) and API-Key-based authorization. Please use the appropriate credentials as per the endpoint requirements.
Explore Endpoints: Use our comprehensive documentation below to explore each endpoint. Sample code for PHP, C#, Python, and JavaScript (Node.js) is provided to get you started quickly.

Base URL

All API requests should be made to the following base URL:

https://www.bestsmsbulk.com/bestsmsbulkapi

Required Headers

Content-Type: application/json
API-Key: Your unique API key for authentication

HTTP Status Codes

Our API returns standard HTTP status codes to indicate the success or failure of your request:

200 OK: The request was successful.
400 Bad Request: Your request was not properly formatted or contains invalid parameters.
401 Unauthorized: You need to authenticate with valid credentials to access this resource.
403 Forbidden: You do not have permission to access this resource.
500 Internal Server Error: An error occurred on our server. Please try again later.

Support

If you have any questions or encounter issues, please refer to the Additional Support section at the end of this document, or contact our helpdesk via email or phone.

1. SEND SMS TEXT HTTP API

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPI.php

Submission Methods

GET/POST

Parameters Description

Parameter	Description
message	Body of your Message / SMS Content
senderid	The Sender ID (case sensitive)
destination	Mobile number(s) in format: 96170XXXXXX; Multiple numbers separated by ;
username	Your username
password	Your password
date	Date when you want your message to be sent (Format: YYYY-MM-DD). If not set, the message will be sent directly.
time	Time when you want your message to be sent (Format: hh:mm, 24h format). If not set, the message will be sent directly.

Sample Code


$apiKey = "your_api_key";
$username = "your_username";
$password = "your_password";
$senderId = "SENDERID";
$destination = "96170123456";
$message = "Hello, this is a test SMS!";

$url = "https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPI.php";

$data = [
    'username' => $username,
    'password' => $password,
    'senderid' => $senderId,
    'destination' => $destination,
    'message' => $message,
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ],
];

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
    // Handle error
}

var_dump($result);


using System;
using System.Net.Http;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var values = new Dictionary
        {
            { "username", "your_username" },
            { "password", "your_password" },
            { "senderid", "SENDERID" },
            { "destination", "96170123456" },
            { "message", "Hello, this is a test SMS!" }
        };

        var content = new FormUrlEncodedContent(values);
        var response = await client.PostAsync("https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPI.php", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}


import requests

url = "https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPI.php"
data = {
    "username": "your_username",
    "password": "your_password",
    "senderid": "SENDERID",
    "destination": "96170123456",
    "message": "Hello, this is a test SMS!"
}

response = requests.post(url, data=data)

if response.status_code == 200:
    print("Response:", response.text)
else:
    print("Error:", response.status_code, response.text)


const https = require('https');
const querystring = require('querystring');

const postData = querystring.stringify({
    username: 'your_username',
    password: 'your_password',
    senderid: 'SENDERID',
    destination: '96170123456',
    message: 'Hello, this is a test SMS!'
});

const options = {
    hostname: 'www.bestsmsbulk.com',
    port: 443,
    path: '/bestsmsbulkapi/sendSmsAPI.php',
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Content-Length': postData.length
    }
};

const req = https.request(options, (res) => {
    let data = '';
    res.on('data', (chunk) => {
        data += chunk;
    });
    res.on('end', () => {
        console.log('Response:', data);
    });
});

req.on('error', (e) => {
    console.error('Error:', e.message);
});

req.write(postData);
req.end();

2. SEND SMS JSON HTTP API

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPIJson.php

Submission Methods

GET/POST

Parameters Description

Parameter	Description
message	Body of your Message / SMS Content
senderid	The Sender ID (case sensitive)
destination	Mobile number(s) in format: 96170XXXXXX; Multiple numbers separated by ;
username	Your username
password	Your password
date	Date when you want your message to be sent (Format: YYYY-MM-DD). If not set, the message will be sent directly.
time	Time when you want your message to be sent (Format: hh:mm, 24h format). If not set, the message will be sent directly.

Sample Code


$apiKey = "your_api_key";
$username = "your_username";
$password = "your_password";
$senderId = "SENDERID";
$destination = "96170123456";
$message = "Hello, this is a test SMS!";

$url = "https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPIJson.php";

$data = [
    'username' => $username,
    'password' => $password,
    'senderid' => $senderId,
    'destination' => $destination,
    'message' => $message,
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ],
];

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
    // Handle error
}

var_dump($result);


using System;
using System.Net.Http;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var values = new Dictionary
        {
            { "username", "your_username" },
            { "password", "your_password" },
            { "senderid", "SENDERID" },
            { "destination", "96170123456" },
            { "message", "Hello, this is a test SMS!" }
        };

        var content = new FormUrlEncodedContent(values);
        var response = await client.PostAsync("https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPIJson.php", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}


import requests

url = "https://www.bestsmsbulk.com/bestsmsbulkapi/sendSmsAPIJson.php"
data = {
    "username": "your_username",
    "password": "your_password",
    "senderid": "SENDERID",
    "destination": "96170123456",
    "message": "Hello, this is a test SMS!"
}

response = requests.post(url, data=data)

if response.status_code == 200:
    print("Response:", response.text)
else:
    print("Error:", response.status_code, response.text)


const https = require('https');
const querystring = require('querystring');

const postData = querystring.stringify({
    username: 'your_username',
    password: 'your_password',
    senderid: 'SENDERID',
    destination: '96170123456',
    message: 'Hello, this is a test SMS!'
});

const options = {
    hostname: 'www.bestsmsbulk.com',
    port: 443,
    path: '/bestsmsbulkapi/sendSmsAPIJson.php',
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Content-Length': postData.length
    }
};

const req = https.request(options, (res) => {
    let data = '';
    res.on('data', (chunk) => {
        data += chunk;
    });
    res.on('end', () => {
        console.log('Response:', data);
    });
});

req.on('error', (e) => {
    console.error('Error:', e.message);
});

req.write(postData);
req.end();

3. GET SMS MESSAGE DELIVERY STATUS

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/getSmsStatusJson.php

Submission Methods

GET/POST

Parameters Description

Parameter	Description
username	Your username
password	Your password
limit	The limit of the number of delivery statuses to be pulled. Default value: 1000 – last 1000 delivery statuses

Sample Code


$username = "your_username";
$password = "your_password";
$limit = 1000;

$url = "https://www.bestsmsbulk.com/bestsmsbulkapi/getSmsStatusJson.php";

$data = [
    'username' => $username,
    'password' => $password,
    'limit' => $limit,
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ],
];

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
    // Handle error
}

var_dump($result);


using System;
using System.Net.Http;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var values = new Dictionary
        {
            { "username", "your_username" },
            { "password", "your_password" },
            { "limit", "1000" }
        };

        var content = new FormUrlEncodedContent(values);
        var response = await client.PostAsync("https://www.bestsmsbulk.com/bestsmsbulkapi/getSmsStatusJson.php", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}


import requests

url = "https://www.bestsmsbulk.com/bestsmsbulkapi/getSmsStatusJson.php"
data = {
    "username": "your_username",
    "password": "your_password",
    "limit": 1000
}

response = requests.post(url, data=data)

if response.status_code == 200:
    print("Response:", response.text)
else:
    print("Error:", response.status_code, response.text)


const https = require('https');
const querystring = require('querystring');

const postData = querystring.stringify({
    username: 'your_username',
    password: 'your_password',
    limit: '1000'
});

const options = {
    hostname: 'www.bestsmsbulk.com',
    port: 443,
    path: '/bestsmsbulkapi/getSmsStatusJson.php',
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Content-Length': postData.length
    }
};

const req = https.request(options, (res) => {
    let data = '';
    res.on('data', (chunk) => {
        data += chunk;
    });
    res.on('end', () => {
        console.log('Response:', data);
    });
});

req.on('error', (e) => {
    console.error('Error:', e.message);
});

req.write(postData);
req.end();

4. COMBINED SMS AND WHATSAPP HTTP API

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPITemplate.php

Submission Methods

GET/POST

Parameters Description

Parameter	Description
message	Only for SMS - Body of your Message / SMS Content
senderid	The Sender ID (case sensitive)
destination	Mobile number(s) in format: 96170XXXXXX; Multiple numbers separated by ;
username	Your username
password	Your password
route	Accepted values: sms (for SMS) or wp (for WhatsApp)
template	For 'wp' route only - Approved template name
variables	For 'wp' route only - If the approved template includes variables, they should be included here and separated by a comma
media	For 'wp' route only - The link to the media file to be attached with the message
button	For 'wp' route only - If the template includes a button

Code Sample


$username = "your_username";
$password = "your_password";
$senderId = "SENDERID";
$destination = "96170123456";
$message = "Hello, this is a test message!";
$route = "wp";
$template = "template_name";
$variables = "variable1,variable2";

$url = "https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPITemplate.php";

$data = [
    'username' => $username,
    'password' => $password,
    'senderid' => $senderId,
    'destination' => $destination,
    'message' => $message,
    'route' => $route,
    'template' => $template,
    'variables' => $variables
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ],
];

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
    // Handle error
}

var_dump($result);


using System;
using System.Net.Http;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var values = new Dictionary
        {
            { "username", "your_username" },
            { "password", "your_password" },
            { "senderid", "SENDERID" },
            { "destination", "96170123456" },
            { "message", "Hello, this is a test message!" },
            { "route", "wp" },
            { "template", "template_name" },
            { "variables", "variable1,variable2" }
        };

        var content = new FormUrlEncodedContent(values);
        var response = await client.PostAsync("https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPITemplate.php", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}


import requests

url = "https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPITemplate.php"
data = {
    "username": "your_username",
    "password": "your_password",
    "senderid": "SENDERID",
    "destination": "96170123456",
    "message": "Hello, this is a test message!",
    "route": "wp",
    "template": "template_name",
    "variables": "variable1,variable2"
}

response = requests.post(url, data=data)

if response.status_code == 200:
    print("Response:", response.text)
else:
    print("Error:", response.status_code, response.text)


const https = require('https');
const querystring = require('querystring');

const postData = querystring.stringify({
    username: 'your_username',
    password: 'your_password',
    senderid: 'SENDERID',
    destination: '96170123456',
    message: 'Hello, this is a test message!',
    route: 'wp',
    template: 'template_name',
    variables: 'variable1,variable2'
});

const options = {
    hostname: 'www.bestsmsbulk.com',
    port: 443,
    path: '/bestsmsbulkapi/common/sendSmsWpAPITemplate.php',
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Content-Length': postData.length
    }
};

const req = https.request(options, (res) => {
    let data = '';
    res.on('data', (chunk) => {
        data += chunk;
    });
    res.on('end', () => {
        console.log('Response:', data);
    });
});

req.on('error', (e) => {
    console.error('Error:', e.message);
});

req.write(postData);
req.end();

5. BEST SMS BULK WHATSAPP OTP API

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPI.php

Submission Methods

GET/POST

Parameters Description

Parameter	Description
message	OTP Code only
destination	Mobile number(s) in format: 96170XXXXXX; Multiple numbers separated by ;
username	Your username
password	Your password
date	Date when you want your message to be sent (Format: YYYY-MM-DD). If not set, the message will be sent directly.
time	Time when you want your message to be sent (Format: hh:mm, 24h format). If not set, the message will be sent directly.
route	Accepted values: sms (for SMS) or wp (for WhatsApp)

Code Sample


$username = "your_username";
$password = "your_password";
$destination = "96170123456";
$message = "Your OTP code is 123456";
$route = "wp";

$url = "https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPI.php";

$data = [
    'username' => $username,
    'password' => $password,
    'destination' => $destination,
    'message' => $message,
    'route' => $route
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ],
];

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
    // Handle error
}

var_dump($result);


using System;
using System.Net.Http;
using System.Collections.Generic;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var values = new Dictionary
        {
            { "username", "your_username" },
            { "password", "your_password" },
            { "destination", "96170123456" },
            { "message", "Your OTP code is 123456" },
            { "route", "wp" }
        };

        var content = new FormUrlEncodedContent(values);
        var response = await client.PostAsync("https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPI.php", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}


import requests

url = "https://www.bestsmsbulk.com/bestsmsbulkapi/common/sendSmsWpAPI.php"
data = {
    "username": "your_username",
    "password": "your_password",
    "destination": "96170123456",
    "message": "Your OTP code is 123456",
    "route": "wp"
}

response = requests.post(url, data=data)

if response.status_code == 200:
    print("Response:", response.text)
else:
    print("Error:", response.status_code, response.text)


const https = require('https');
const querystring = require('querystring');

const postData = querystring.stringify({
    username: 'your_username',
    password: 'your_password',
    destination: '96170123456',
    message: 'Your OTP code is 123456',
    route: 'wp'
});

const options = {
    hostname: 'www.bestsmsbulk.com',
    port: 443,
    path: '/bestsmsbulkapi/common/sendSmsWpAPI.php',
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Content-Length': postData.length
    }
};

const req = https.request(options, (res) => {
    let data = '';
    res.on('data', (chunk) => {
        data += chunk;
    });
    res.on('end', () => {
        console.log('Response:', data);
    });
});

req.on('error', (e) => {
    console.error('Error:', e.message);
});

req.write(postData);
req.end();

6. SECURED MESSAGING API

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/common/messaging_api_secured_json.php

Submission Methods

POST

Headers

Header Name	Description	Required
API-Key	User's unique API key	Yes
Content-Type	application/json	Yes

Request Format

The request body must be sent as a JSON payload.

Request Body Parameters

Parameter	Type	Description	Required	Default Value
username	string	The username associated with the account	Yes	N/A
password	string	The password associated with the account	Yes	N/A
message	string	The message content	Yes	N/A
senderid	string	The sender ID for the message (SMS only)	No	Empty string
destination	string	The destination phone number(s), separated by ;	Yes	N/A
route	string	Message route: sms or wp (WhatsApp)	No	wp
template	string	WhatsApp template name	No	Empty string
variables	string	Variables for the WhatsApp template, comma-separated	No	Empty string
date	string	Scheduled date in YYYY-MM-DD format	No	Today's date
time	string	Scheduled time in HH:mm:ss format	No	Current time

Code Sample


$username = "your_username";
$password = "your_password";
$senderId = "SENDERID";
$destination = "96170123456";
$message = "Hello, this is a test message!";
$route = "wp";
$template = "template_name";
$variables = "variable1,variable2";

$url = "https://www.bestsmsbulk.com/bestsmsbulkapi/common/messaging_api_secured_json.php";

$data = [
    'username' => $username,
    'password' => $password,
    'senderid' => $senderId,
    'destination' => $destination,
    'message' => $message,
    'route' => $route,
    'template' => $template,
    'variables' => $variables,
];

$options = [
    'http' => [
        'header'  => "Content-Type: application/json\r\n",
        'method'  => 'POST',
        'content' => json_encode($data),
    ],
];

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
    // Handle error
}

var_dump($result);


using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var jsonData = new
        {
            username = "your_username",
            password = "your_password",
            senderid = "SENDERID",
            destination = "96170123456",
            message = "Hello, this is a test message!",
            route = "wp",
            template = "template_name",
            variables = "variable1,variable2"
        };

        var content = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(jsonData), Encoding.UTF8, "application/json");
        var response = await client.PostAsync("https://www.bestsmsbulk.com/bestsmsbulkapi/common/messaging_api_secured_json.php", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}


import requests
import json

url = "https://www.bestsmsbulk.com/bestsmsbulkapi/common/messaging_api_secured_json.php"
data = {
    "username": "your_username",
    "password": "your_password",
    "senderid": "SENDERID",
    "destination": "96170123456",
    "message": "Hello, this is a test message!",
    "route": "wp",
    "template": "template_name",
    "variables": "variable1,variable2"
}

headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, data=json.dumps(data), headers=headers)

if response.status_code == 200:
    print("Response:", response.text)
else:
    print("Error:", response.status_code, response.text)


const https = require('https');

const data = JSON.stringify({
    username: 'your_username',
    password: 'your_password',
    senderid: 'SENDERID',
    destination: '96170123456',
    message: 'Hello, this is a test message!',
    route: 'wp',
    template: 'template_name',
    variables: 'variable1,variable2'
});

const options = {
    hostname: 'www.bestsmsbulk.com',
    port: 443,
    path: '/bestsmsbulkapi/common/messaging_api_secured_json.php',
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Content-Length': data.length
    }
};

const req = https.request(options, (res) => {
    let responseData = '';
    res.on('data', (chunk) => {
        responseData += chunk;
    });
    res.on('end', () => {
        console.log('Response:', responseData);
    });
});

req.on('error', (e) => {
    console.error('Error:', e.message);
});

req.write(data);
req.end();

7. BSB AI Chatbot API

API Link

https://www.bestsmsbulk.com/bestsmsbulkapi/bsbaichatbot/bsb_ai_chatbot_api.php

Submission Method

POST

Required Headers

Header Name	Description	Required
API-Key	Your unique API key from the user panel	Yes
Content-Type	application/json	Yes

Request Body (JSON)


{
  "username": "your_username",
  "password": "your_password",
  "message": "Hello, I need help!",
  "from": "123456789",
  "date": "2025-03-25",    // optional
  "time": "14:30:00"       // optional
}

Success Response


{
  "status": "success",
  "message": "Hi there! 👋 How can I assist you today?"
}

Error Responses

401 Unauthorized: Wrong username/password
403 Forbidden: Invalid or missing API key
400 Bad Request: Missing fields or JSON format issues
405 Method Not Allowed: Only POST allowed

Key Notes

The chatbot response may be changed dynamically based on context and user message.

Additional Support

If you need further assistance, please contact our support team:

Email: support@proxireach.com
Phone: +961 76 515481