Spark Sender

Spark Sender SMS API Documentation

SEND INDIVIDUAL SMS

You can use this endpoint directly to send SMS to a contact number.

ENDPOINT	https://cp.sparksender.com/api/send/
TYPE	GET OR POST
RETURN TYPE	JSON

SEND INDIVIDUAL SMS PARAMETERS

Key	Value	Required
user_id	User ID from your profile page.	YES
api_key	API key from your profile page.	YES
sender_id	Your approved Sender ID. Use “SparkDEMO” for testing. This one is case sensitive.	YES
message	Your message. Max: 480 chars.	YES
recipient_contact_no	The Number of the Recipient.	YES

API RESPONSE SAMPLE

{
"status_code": 204,
"msg_id": "14364"
}

API RESPONSE PARAMETERS

Key	Description
status_code	Your Status Code
msg_id	Message Id

API STATUS CODE LIST

HTTP Response	Response
201	Client API Status is Inactive
202	Invalid API Key
203	Contact Number is Invalid or Operator not Support
204	Successfuly Sent the Message
205	Length of Contact is Invalid
206	Country is not Availble for Sending SMS
207	No Contact Numbers
208	Account Balance is Insufficient
209	Sending the Messsage is Unsuccessfull
210	Client is Suspended
211	No Mask ID / Mask Id is not Approved
212	Rate Card is not Set for the Country
213	Route is not Set for the Country

SAMPLE CODE FOR SENDING INDIVIDUAL SMS

<?php
  
// send_sms function in PHP - cURL
  
function send_sms($client_id,$api_key,$sender_id,$message,$recipient_contact_no){
 
// curl post

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => "https://cp.sparksender.com/api/send/?user_id=$client_id&api_key=$api_key&sender_id=$sender_id&message=$message&recipient_contact_no=$recipient_contact_no",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;    
  
}

//set variables


$client_id             = "11XXXX";        // Replace your client ID                             
$api_key               = "121XXXXE";      // Replace your api key
$sender_id             = "SparkDEMO";     // Replace your sender id
$message               = "Hello";         // Message
$recipient_contact_no  = "94xxxxxxx";     // Recipient contact no

// call send_sms function
  
send_sms($client_id,$api_key,$sender_id,$message,$recipient_contact_no);

?>

<script>

// send_sms function in JavaScript - Fetch

function send_sms(client_id,api_key,sender_id,message,recipient_contact_no){
  
var requestOptions = {
method: "GET",
redirect: "follow"
};
   
fetch("https://cp.sparksender.com/api/send/?user_id="+client_id+"&api_key="+api_key+"&sender_id="+sender_id+"&message="+message+"&recipient_contact no="+recipient_contact_no, requestOptions)
.then(response => response.text())
.then(result => document.write(result))
.catch(error => document.write("error", error));

}

// set variables

  var client_id               = "11XXXX";       // Replace your client Id        
  var api_key                 = "121XXXXE";     // Replace your api key
  var sender_id               = "SparkDEMO;     // Replace your sender id
  var message                 = "Hello";        // Message
  var recipient_contact_no    = "94xxxxxxx";    // Recipient contact no

// call send_sms function
  
send_sms(client_id,api_key,sender_id,message,recipient_contact_no);
 
</script>

<script>

// send_sms function in JavaScript - Jquery

function send_sms(client_id,api_key,sender_id,message,recipient_contact_no){
  
var settings = {

"url": "https://cp.sparksender.com/api/send/?user_id="+client_id+"&api_key="+api_key+"&sender_id="+sender_id+"&message="+message+"&recipient_contact no="+recipient_contact_no,
"method": "GET",
"timeout": 0,
};

$.ajax(settings).done(function (response) {
console.log(response);
});
 
}

// set variables

  var client_id               = "11XXXX";      // Replace your client Id
  var api_key                 = "121XXXXE";    // Replace your api key
  var sender_id               = "SparkDEMO;    // Replace your sender id
  var message                 = "Hello";       // Message
  var recipient_contact_no    = "94xxxxxxx";   // Recipient contact no

// call send_sms function
  
send_sms(client_id,api_key,sender_id,message,recipient_contact_no);
 
</script>

// send_sms function in C - libcurl

function send_sms(client_id,api_key,sender_id,message,recipient_contact_no){
  
CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl){
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(curl, CURLOPT_URL, "https://cp.sparksender.com/api/send/?user_id=client_id&api_key=api_key&sender_id=sender_id&message=message&recipient_contact_no=recipient_contact_no");
curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
struct curl_slist *headers = NULL;
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);
  
}

// set variables

  int client_id              = "11XXXX";       // Replace your client Id
  ch api_key                 = "121XXXXE";     // Replace your api key
  int sender_id              = "SparkDEMO";    // Replace your sender id
  ch message                 = "Hello";        // Message
  ch recipient_contact_no    = "94755555555";  // Recipient contact no

//call send_sms function
  
send_sms(client_id,api_key,sender_id,message,recipient_contact_no);

// send_sms function in NodeJs - Native

function send_sms(client_id,api_key,sender_id,message,recipient_contact_no){
  
    var https = require("follow-redirects").https;
    var fs = require("fs");

    var options = {
        "method": "GET",
        "hostname": "cp.sparksender.com",
        "path": "/api/send/?user_id=client_id&api_key=api_key&sender_id=sender_id&message=message&recipient_contact_no=recipient_contact_no",
        "headers": {
        },
        "maxRedirects": 20
        };

    var req = https.request(options, function (res) {
    var chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
    });

    req.end();
 
}

// set variables

    var client_id               = "11XXXX";       // Replace your client Id  
    var api_key                 = "121XXXXE";     // Replace your api key
    var sender_id               = "SparkDEMO;     // Replace your sender id
    var message                 = "Hello";        // Message
    var recipient_contact_no    = "94xxxxxxx";    // Recipient contact no

//call send_sms function
  
 send_sms(client_id,api_key,sender_id,message,recipient_contact_no);

                                                <?php
  
  // send_sms function in PHP - Guzzle
  
  function send_sms($client_id,$api_key,$sender_id,$message,$recipient_contact_no){
 
    $client = new Client();
    $request = new Request("GET", "https://cp.sparksender.com/api/send/?user_id=$client_id&api_key=$api_key&sender_id=$sender_id&message=$message&recipient_contact_no=$recipient_contact_no");
    $res = $client->sendAsync($request)->wait();
    echo $res->getBody();
  
  }

//set variables

    $client_id             = "11XXXX";     // Replace your client Id                            
    $api_key               = "121XXXXE";   // Replace your api key
    $sender_id             = "SparkDEMO";  // Replace your sender id
    $message               = "Hello"";     // Message
    $recipient_contact_no  = "94xxxxxxx";  // Recipient contact no

  //call send_sms function
  
    send_sms($client_id,$api_key,$sender_id,$message,$recipient_contact_no);

?>

// set variables

client_id             = "11XXXX";       // Replace your client Id                            
api_key               = "121XXXXE"";    // Replace your api key     
sender_id             = "SparkDEMO;     // Replace your sender id
message               = "Hello";        // Message
recipient_contact_no  = "94xxxxxxx";    // Recipient contact no

// Send SMS in Phython Requests

import requests

url = "https://cp.sparksender.com/api/send/?user_id=client_id&api_key=api_key&sender_id=sender_id&message=message&recipient_contact_no=recipient_contact_no"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

SEND BULK SMS

You can use this endpoint directly to send SMS to bulk contact numbers.

ENDPOINT	https://cp.sparksender.com/api/bulkSMS/
TYPE	GET OR POST
RETURN TYPE	JSON

SEND BULK SMS PARAMETERS

Key	Value	Required
user_id	User ID from your profile page.	YES
api_key	API key from your profile page.	YES
sender_id	Your approved Sender ID. Use “SparkDEMO” for testing. This one is case sensitive.	YES
message	Your message. Max: 480 chars.	YES
recipient_contacts	The Numbers of the Recipients. (E.g. 94711111111, 94773333333, 94752222222, 94214545455, 58478)	YES

API RESPONSE SAMPLE

{
   "success": [
         [
                 {
                       "number": "94711111111",
                       "msgId": "1000"
                 },
                 {
                       "number": "94773333333",
                       "msgId": "1001"
                 },
                 {
                       "number": "94752222222",
                       "msgId": "1002"
                 }
         ]
   ],
   "unsuccess": [
         [
                 {
                       "number": "94214545455",
                       "status": 203
                 },
                 {
                       "number": "58478",
                       "status": 203
                 }
         ]
   ]
}

API RESPONSE PARAMETERS

Key	Description
success	Your Result (Success Messages Details)
unsuccess	Your Result (Unsuccess Messages Details)
number	Your Contact Number
msgId	Message Id
status	Your Status Code

API STATUS CODE LIST

HTTP Response	Response
201	Client API Status is Inactive
202	Invalid API Key
203	Contact Number is Invalid or Operator not Support
205	Length of Contact is Invalid
206	Country is not Availble for Sending SMS
207	No Contact Numbers
208	Account Balance is Insufficient
209	Sending the Messsage is Unsuccessfull
210	Client is Suspended
211	No Mask ID / Mask Id is not Approved
212	Rate Card is not Set for the Country
213	Route is not Set for the Country

SAMPLE CODE FOR SENDING BULK SMS

<?php
  
// send_bulk_sms function in PHP - cURL
  

function send_bulk_sms($client_id,$api_key,$sender_id,$message,$recipient_contacts){
 
// curl post

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, "https://cp.sparksender.com/api/bulkSMS/?");
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS,
"user_id={$client_id}&api_key={$api_key}&sender_id={$sender_id}&message={$message}&recipient_contacts={$recipient_contacts}");
  
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  
$response = curl_exec($curl);
  
curl_close ($curl);
 
echo print_r($response,true);    
  
}

//set variables


$client_id             = "11XXXX";                                                    // Replace your client ID                              
$api_key               = "121XXXXE";                                                  // Replace your api key
$sender_id             = "SparkDEMO";                                                 // Replace your sender id
$message               = "Hello";                                                     // Message
$recipient_contacts    = "94711111111, 94773333333, 94752222222, 94214545455, 58478"; // Recipient contacts

// call send_bulk_sms function
  
send_bulk_sms ($client_id,$api_key,$sender_id,$message,$recipient_contacts);
?>

<script>                         
// send_bulk_sms function in JavaScript - Fetch


function send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts){
  
var requestOptions = {
method: "GET",
redirect: "follow"
};
   
fetch("https://cp.sparksender.com/api/bulkSMS/?user_id="+client_id+"&api_key="+api_key+"&sender_id="+sender_id"&message="+message+"&recipient_contacts="+recipient_contacts, requestOptions)
.then(response => response.text())
.then(result => document.write(result))
.catch(error => document.write("error", error));

}

// set variables

var client_id          = "11XXXX";                                                              // Replace your client ID      
var api_key            = "121XXXXE";                                                            // Replace your api key
var sender_id          = "SparkDEMO";                                                           // Replace your sender id
var message            = "Hello";                                                               // Message
var recipient_contacts = "94711111111, 94773333333, 94752222222, 94214545455, 58478";;          // Recipient contact no

// call send_bulk_sms function
  
send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts);
 
</script>

<script>  
                    
// send_bulk_sms function in JavaScript - Jquery


function send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts){
  
var settings = {

"url": "https://cp.sparksender.com/api/bulkSMS/?user_id="+client_id+"&api_key="+api_key+"&sender_id="+sender_id+"&message="+message+"&recipient_contacts="+recipient_contacts,
"method": "GET",
"timeout":  0,
};

$.ajax(settings).done(function (response) {
console.log(response);
});
 
}

// set variables

var client_id          = "11XXXX";                                                           // Replace your client ID  
var api_key            = "121XXXXE";                                                         // Replace your api key
var sender_id          = "SparkDEMO";                                                        // Replace your sender id
var message            = "Hello";                                                            // Message
var recipient_contacts = "94711111111, 94773333333, 94752222222, 94214545455, 58478";       // Recipient contact no

// call send_bulk_sms function
  
send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts);
 
</script>

// send_bulk_sms function in C - libcurl

function send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts){
  
CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl){
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(curl, CURLOPT_URL, "https://cp.sparksender.com/api/bulkSMS/?user_id=client_id&api_key=api_key&sender_id=sender_id&message=message&recipient_contacts=recipient_contacts");
curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
struct curl_slist *headers = NULL;
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);
  
}

// set variables

  int client_id              = "11XXXX";                                                     // Replace your client ID 
  ch api_key                 = "121XXXXE";                                                   // Replace your api key
  int sender_id              = "SparkDEMO";                                                  // Replace your sender id
  ch message                 = "Hello";                                                      // Message
  ch recipient_contacts      = "94711111111, 94773333333, 94752222222, 94214545455, 58478";  // Recipient contact no

//call send_bulk_sms function
  
 send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts);

// send_bulk_sms function in NodeJs - Native

function send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts){
  
    var https = require("follow-redirects").https;
    var fs = require("fs");

    var options = {
        "method": "GET",
        "hostname": "cp.sparksender.com",
        "path": "/api/bulkSMS/?user_id=client_id&api_key=api_key&sender_id=sender_id&message=message&recipient_contacts=recipient_contacts",
        "headers": {
        },
        "maxRedirects": 20
        };

    var req = https.request(options, function (res) {
    var chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
    });

    req.end();
 
}

// set variables

    var client_id               = "11XXXX";                                                    // Replace your client ID 
    var api_key                 = "121XXXXE";                                                  // Replace your api key
    var sender_id               = "SparkDEMO";                                                 // Replace your sender id
    var message                 = "Hello";                                                     // Message
    var recipient_contacts      = "94711111111, 94773333333, 94752222222, 94214545455, 58478"; // Recipient contact no

//call send_bulk_sms function
  
 send_bulk_sms(client_id,api_key,sender_id,message,recipient_contacts);

<?php  
// send_bulk_sms function in PHP - Guzzle

function send_bulk_sms($client_id,$api_key,$sender_id,$message,$recipient_contacts){
 
$client = new Client();
$request = new Request("GET", "https://cp.sparksender.com/api/bulkSMS/?user_id=$client_id&api_key=$api_key&sender_id=$sender_id&message=$message&recipient_contacts=$recipient_contacts");
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
  
}

//set variables

  $client_id             = "11XXXX";                                                    // Replace your client ID                           
  $api_key               = "121XXXXE";                                                  // Replace your api key
  $sender_id             = "SparkDEMO";                                                 // Replace your sender id
  $message               = "Hello";                                                     // Message
  $recipient_contacts    = "94711111111, 94773333333, 94752222222, 94214545455, 58478"; // Recipient contact no

  //call send_bulk_sms function
  
send_bulk_sms($client_id,$api_key,$sender_id,$message,$recipient_contacts);

?>

                       
// set variables

client_id             = "11XXXX";                                                    // Replace your client ID                        
api_key               = "121XXXXE";                                                  // Replace your api key
sender_id             = "SparkDEMO";                                                 // Replace your sender id
message               = "Hello";                                                     // Message
recipient_contacts    = "94711111111, 94773333333, 94752222222, 94214545455, 58478"; // Recipient contact no

// Send SMS in Phython Requests
  
import requests

url = "https://cp.sparksender.com/api/bulkSMS/?user_id=client_id&api_key=api_key&sender_id=sender_id&message=message&recipient_contacts=recipient_contacts"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

GET SMS STATUS

The protocol is used to query the submission result of specific msgId array

GET SMS STATUS REQUEST PARAMETERS

Parameters	Description	Required	Type
user_id	User ID from your profile page.	YES	String
api_key	API key from your profile page.	YES	String
msg_id	Your Message ID.	YES	String

GET SMS STATUS SAMPLE

{
"sms_status": 2
}

GET SMS STATUS PARAMETERS

Key	Description
sms_status	SMS Status Code

SMS STATUS CODE LIST

HTTP Response	Response
0	Pending
1	Send
2	Delivered
3	Fail
4	Processing
5	Invalid Msg Id
6	Api key is invalid
7	Api status in inactive
8	Client is Suspended

SAMPLE CODE FOR GETTING SMS STATUS

<?php
  
  // sms_status function in PHP - cURL
  
  function sms_status($client_id,$api_key,$msg_id){
 
 // curl post

  $curl = curl_init();

  curl_setopt_array($curl, array(
  CURLOPT_URL => "https://cp.sparksender.com/api/getStatus/?user_id=$client_id&api_key=$api_key&msg_id=$msg_id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  ));

  $response = curl_exec($curl);

  curl_close($curl);
  echo $response;    
  
}

//set variables


$client_id             = "11XXXX";    // Your client_id               
$api_key               = "121XXXXE";  // Your api_key
$msg_id                = "123";       // Your msg_id

// call sms_status function
  
 sms_status($client_id,$api_key,$msg_id);

?>

                          <script>

// sms_status function in JavaScript - Fetch

function sms_status(client_id,api_key,msg_id)
  
  var requestOptions = {
  method: "GET",
  redirect: "follow"
  };
   
  fetch("https://cp.sparksender.com/api/getStatus/?user_id="+client_id+"&api_key="+api_key+"&msg_id="+msg_id, requestOptions)
  .then(response => response.text())
  .then(result => document.write(result))
  .catch(error => document.write("error", error));

}

// set variables

    var client_id               = "11XXXX";     // Your client_id
    var api_key                 = "121XXXXE";   // Your api_key
    var msg_id                  = "123";        // Your msg_id
    

// call sms_status function
  
 sms_status(client_id,api_key,msg_id);
 
</script>

<script>

// sms_status function in JavaScript - Jquery

function sms_status(client_id,api_key,msg_id){
  
  var settings = {

  "url": "https://cp.sparksender.com/api/getStatus/?user_id="+client_id+"&api_key="+api_key+"&msg_id="+msg_id,
  "method": "GET",
  "timeout": 0,
  };

  $.ajax(settings).done(function (response) {
    console.log(response);
  });
 
}

// set variables

    var client_id               = "11XXXX";    // Your client_id  
    var api_key                 = "121XXXXE";  // Your api_key
    var msg_id                  = "123";       // Your msg_id
    

// call sms_status function
  
 sms_status(client_id,api_key,msg_id);
 
</script>

// sms_status function in C - libcurl

function sms_status(client_id,api_key,msg_id){
  
 CURL *curl;
 CURLcode res;
 curl = curl_easy_init();
 if(curl){
  curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
  curl_easy_setopt(curl, CURLOPT_URL, "https://cp.sparksender.com/api/getStatus/?user_id=client_id&api_key=api_key&msg_id=msg_id");
  curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
  struct curl_slist *headers = NULL;
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  res = curl_easy_perform(curl);
  }
 curl_easy_cleanup(curl);
  
}

// set variables

    int client_id              = "11XXXX";    // Your client_id 
    ch api_key                 = "121XXXXE";  // Your api_key
    ch msg_id                  = "123";       // Your msg_id

//call sms_status function
  
 sms_status(client_id,api_key,msg_id);

// sms_status in NodeJs - Native

function sms_status(client_id,api_key,msg_id){
  
    var https = require("follow-redirects").https;
    var fs = require("fs");

    var options = {
        "method": "GET",
        "hostname": "cp.sparksender.com",
        "path": "/api/getStatus/?user_id=client_id&api_key=api_key&msg_id=msg_id",
        "headers": {
        },
        "maxRedirects": 20
        };

    var req = https.request(options, function (res) {
    var chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
    });

    req.end();
 
}

// set variables

    var client_id               = "11XXXX";     // Your client_id 
    var api_key                 = "121XXXXE";   // Your api_key
    var msg_id                  = "123";        // Your msg_id

//call sms_status function
  
 sms_status(client_id,api_key,msg_id);

<?php
  
  // sms_status function in PHP - Guzzle
  
  function sms_status($client_id,$api_key,$msg_id){
 
    $client = new Client();
    $request = new Request("GET", "https://cp.sparksender.com/api/getStatus/?user_id=$client_id&api_key=$api_key&msg_id=$msg_id");
    $res = $client->sendAsync($request)->wait();
    echo $res->getBody();
  
  }

//set variables

    $client_id             = "11XXXX";           // Your client_id
    $api_key               = "121XXXXE";         // Your api_key
    $msg_id                = "1111";             // Your msg_id
    

  //call sms_status function
  
    sms_status($client_id,$api_key,$msg_id);

?>

// set variables

    client_id             = "11XXXX";    // Your client_id          
    api_key               = "121XXXXE";  // Your api_key   
    msg_id                = "123";       // Your msg_id   

    // Get SMS Status in Phython Requests
  
    import requests

    url = "https://cp.sparksender.com/api/getStatus/?user_id=client_id&api_key=api_key&msg_id=msg_id"

    payload={}
    headers = {}

    response = requests.request("GET", url, headers=headers, data=payload)

    print(response.text)