Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

http://bulksmsnigeria.test/

Authenticating requests

Authenticate requests to this API's endpoints by sending a query parameter api_token in the request.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve/generate your token by visiting your API Settings Page

Endpoints

api/v2/balance/get

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://bulksmsnigeria.test/api/v2/balance/get',
    [
        'headers' => [
            'Accept' => 'application/json',
        ],
        'query' => [
            'api_token'=> 'YOUR_API_KEY',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://bulksmsnigeria.test/api/v2/balance/get"
);

let params = {
    "api_token": "YOUR_API_KEY",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

import requests
import json

url = 'http://bulksmsnigeria.test/api/v2/balance/get'
params = {
  'api_token': 'YOUR_API_KEY',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

curl -X GET \
    -G "http://bulksmsnigeria.test/api/v2/balance/get?api_token=YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Example response (401):

{
    "message": "Unauthenticated."
}

V1

API for Version 1

Send Bulk SMS Message.

requires authentication

The endpoint supports POST/GET Methods. Send your parameters

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://bulksmsnigeria.test/api/v1/sms/create',
    [
        'headers' => [
            'Accept' => 'application/json',
        ],
        'query' => [
            'api_token'=> 'YOUR_API_KEY',
            'to'=> '2347037770033,2349050030090,2347059090000',
            'from'=> 'BulkSMSNG',
            'body'=> 'This is a test message.',
            'gateway'=> '0',
            'append_sender'=> '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://bulksmsnigeria.test/api/v1/sms/create"
);

let params = {
    "api_token": "YOUR_API_KEY",
    "to": "2347037770033,2349050030090,2347059090000",
    "from": "BulkSMSNG",
    "body": "This is a test message.",
    "gateway": "0",
    "append_sender": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

import requests
import json

url = 'http://bulksmsnigeria.test/api/v1/sms/create'
params = {
  'api_token': 'YOUR_API_KEY',
  'to': '2347037770033,2349050030090,2347059090000',
  'from': 'BulkSMSNG',
  'body': 'This is a test message.',
  'gateway': '0',
  'append_sender': '0',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, params=params)
response.json()

curl -X POST \
    "http://bulksmsnigeria.test/api/v1/sms/create?api_token=YOUR_API_KEY&to=2347037770033%2C2349050030090%2C2347059090000&from=BulkSMSNG&body=This+is+a+test+message.&gateway=0&append_sender=0" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Example response (200):

{

0": 200,
"data": {
"status": "success",
"message": "Message Sent",
"message_id": "d0173d84-2f01-4a5f-a0dc-375beea5b806",
"cost": 4.99,
"currency": "NGN",
"gateway_used": "direct_corporate"
}
}

Send Bulk SMS Message.

requires authentication

The endpoint supports POST/GET Methods. Send your parameters

Example request:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://bulksmsnigeria.test/api/v2/sms/create',
    [
        'headers' => [
            'Accept' => 'application/json',
        ],
        'query' => [
            'api_token'=> 'YOUR_API_KEY',
            'to'=> '2347037770033,2349050030090,2347059090000',
            'from'=> 'BulkSMSNG',
            'body'=> 'This is a test message.',
            'gateway'=> '0',
            'append_sender'=> '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://bulksmsnigeria.test/api/v2/sms/create"
);

let params = {
    "api_token": "YOUR_API_KEY",
    "to": "2347037770033,2349050030090,2347059090000",
    "from": "BulkSMSNG",
    "body": "This is a test message.",
    "gateway": "0",
    "append_sender": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

import requests
import json

url = 'http://bulksmsnigeria.test/api/v2/sms/create'
params = {
  'api_token': 'YOUR_API_KEY',
  'to': '2347037770033,2349050030090,2347059090000',
  'from': 'BulkSMSNG',
  'body': 'This is a test message.',
  'gateway': '0',
  'append_sender': '0',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, params=params)
response.json()

curl -X POST \
    "http://bulksmsnigeria.test/api/v2/sms/create?api_token=YOUR_API_KEY&to=2347037770033%2C2349050030090%2C2347059090000&from=BulkSMSNG&body=This+is+a+test+message.&gateway=0&append_sender=0" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Example response (200):

{

0": 200,
"data": {
"status": "success",
"message": "Message Sent",
"message_id": "d0173d84-2f01-4a5f-a0dc-375beea5b806",
"cost": 4.99,
"currency": "NGN",
"gateway_used": "direct_corporate"
}
}