SMSECHOS Bulk SMS API
| Special Character | Meaning | Auto Encoded by smsechos.com |
|---|---|---|
| \r | Carraige Return | Yes |
| \n | Newline | Yes |
| # | Hash or Number sign | Yes |
| * | Asterisk | Yes |
| @ | At sign | Yes |
| % | Percent sign | Yes |
| ” | Quote marks | Yes |
| ’ | Apostrophe | Yes |
| $ | Dollar sign | Yes |
| ? | Question mark | Yes |
| ! | Exclamation mark | Yes |
| = | Equals sign | Yes |
If a symbol is not listed above, then you have to manually insert its code into your SMS following the GSM 3.38 coding standard here https://en.wikipedia.org/wiki/GSM_03.38 or any other source. Remember codes are preceded with a % for example # symbol is %23 and @ symbol is %00 If you have doubts, write customer support.
https://api.smsechos.com/index.php?r=site/apiwebsendmsg
phoneNumber = Online account Login. Attach country code to it.
Password = Online account password
msg = Message to be sent
$sender_id = This is optional field, If you wish to override default sender id, then set this field
SerialNumber-country code=contact number
SerialNumber-country code=contact number
OR
country code=contact number
Will work fine. Note the serial number in this case are sequential integers you will generate at your end.
For example assuming I have to send SMS to (237)650218839 and (237)670879560, also assuming my online account phone number is 1111111111 with country code 237 and password is 1234 and message is “Hello World”. Then using any approach to do the POST call (CURL, AJAX, etc) my URL for the call should be formed to look like this,
https://api.smsechos.com/index.php?r=site/apiwebsendmsg&phoneNumber=2371111111111&Password=1234&msg=Hello World&1-237=650218839&2-237=670879560
Notice each country code is preceded by a sequential number, 1, 2, etc. Without this sequential number separated using - from the country code might lead to unreliable results. But if sending only to a single contact, only country code will suffice but if you set it up as 1-country code=number for the single number it will work fine.
And POST array will be received by our API like this,
POST['phoneNumber'] = 2371111111111
POST['Password'] = 1234
POST['msg'] = Hello World
POST['1-237'] = 650218839
POST['2-237'] = 670879560
The rest will be handled by the API.
JSON encoded 2 dimensional array containing history of how message was handled for each contact. The first dimension holds an array of status for each contact. The following information can be gotten out of the array:
For the above example call, something like this for the response $rep can be gotten like this,
record = 237
returnstatus = 0 means did not go well and 1 means went well
650218839 = "Failure" or "Success"
reason = A string of message telling why it went or did not went well
Tech = Type of Route the SMS took as we support multiple routes for reliability
replystatus = 100 means not enough airtime, 200 means login or password incorrect, 300 means internal server error, 400 means slow bandwidth or connection and 500 means unknown error occured.
sents = A count of total sent
sentsaved = A count of those that were sent and the contacts saved under your online account
sentdiscounted = A count of those that were sent and discounted from your account
success = True meaning it was successful for this current contact or False meaning it failed
unknownstatus = this is set when an error 500 above is set
success = set when message went or never went well
creditfinish = set only when airtime is finish
Error = set when contact list is empty
ise = set when API throws an error
values =
0 //Success, No problems
500 //Unknown error
600 //credit finished
700 //Contacts List supplied is empty
800 //Internal server error
900 //Wrong login
values =
-11 //Not enough airtime
-21 //No sender ID supplied
value = current balance airtime
values = String with a message associated with the transaction in general
Any other array element in the response is the status of each contacts sending transaction, for each contact, the returned array for that contact has the following fields
values = Serial number of the transaction queue
value = associated contact number for this transaction
In this section, any code different from one should be reported to the whisper team under help of the platform. A whisper expert will attend to you.
values = 1 //message was sent successfully 100 //The airtime got finished somehow when processing request for this contact 404 //Wrong platform credentials 0 //General network problem -500 //Slow or internet connection bandwidth too low Any other code means unknow error occurred
{#sample-code}
public function methodCall() {
//sendsms code
//CURL
$url = 'https://api.smsechos.com/index.php?r=site/apiwebsendmsg&';
$username = '+237670000000';
$password = md5('test');
$sender_id = "ABC Ltd"; // This is optional field // If you wish to override default sender id, then set this field
$verification_code = rand(1000,9999);
$receiver = "670879560";//696449761
//$timeout=10;
$request = $url . "phoneNumber=" . urlencode($username) . "&Password=" . $password;
$request.="&msg=" . urlencode("Hello World: " . $verification_code) . "&237=" . urlencode($receiver). "&sender_id=" . urlencode($sender_id);
$url = $request;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
//curl_setopt($ch, CURLOPT_POST, 1);
$response = curl_exec($ch);
curl_close($ch);
$response = json_decode($response);
foreach($response as $k){
if(isset($k->success))
echo $k->success;
if(isset($k->genreplystatus))
echo $k->genreplystatus;
if(isset($k->minireplystatus))
echo $k->minireplystatus;
if(isset($k->balance))
echo $k->balance;
if(isset($k->generalreason))
echo $k->generalreason;
if(is_object($k) && isset($k->contact))
var_dump($k);
}
//additionally, you can do $k->contactnumber
exit;
//return $response;
}