raja-sms
v1.0.4
Published
Raja sms also known as "Rajanya sms" is an online SMS gateway for indonesia. raja-sms is a node plugin for - Sending SMS - Checking balance
Downloads
1
Readme
RAJA - SMS Node:
Raja sms also known as "Rajanya sms" is an online SMS gateway for indonesia. raja-sms is a node plugin for
- Sending SMS
- Checking balance
Installation:
Using npm:
$ npm install raja-sms --save
Usage:
In Node.js:
var raja_sms = require("raja-sms");
/**Send SMS */
raja_sms.sendSMS(api_key , options , payload)
.then(function(response){
//Handle the response;
},
function(error){
//Handle the error;
});
/**Check your account balance */
raja_sms.getBalance(api_key , options)
.then(function(balance){
console.log(`Balance is: ${balance}`);
},function(error){
console.log(error);
});
API Key: api_key (required)
This is your API key obtained from Raja SMS. Go to your account dash board of Raja SMS to get it.
Options: options
It's an object which necessarily takes two parameters:
- smsServerIp (
required
) : This is provided to you by "Raja SMS". - callBack (
optional
) : Your callback on getting response from sms gateway. - Example :
{smsServerIp : '127.0.0.1' , callBack: 'http://test/sms/webhook'}
Note
: The above smsServerIp is just dummy("localhost").
Payload: payload (required)
Note
:This is required when sending SMS. It's not required when you are trying to check balance.
{
to : 'XXX-your-number-XXX',
body: `Hello`
}
Note:
The recepient number may or may not be prefixed with the country code. In case if the recepient number is without country code (for example : 62 or +62), it's internally taken care off.
Note:
Maximum 160 characters for message.
Sample: (Code)
Send SMS:
var sender = require("raja-sms");
var api_key = "110d85d4-5cda-4ca6-b1db-178215286822";
var options , = {
smsServerIp : "45.32.109.200",
callBack : "http://test/sms/webhook",
};
// 629797846789 or +629797846789 or 9797846789
var payload = {
to : '9797846789',
body : 'Hello'
};
//Fire sms;
sender.sendSMS(api_key , options , payload)
.then(function(response){
console.log(response);
},function(err){
console.log(err.message);
} );
Check Balance
var sender = require("raja-sms");
var api_key = "110d85d4-5cda-4ca6-b1db-178215286822";
var options , = {
smsServerIp : "45.32.109.200",
};
//Fire check Balance;
sender.getBalance(api_key , options)
.then(function(response){
console.log(response);
},function(err){
console.log(err.message);
});
;
Sample Response:(JSON structure)
Send SMS response payload:
{
"sending_respon": [
{
"globalstatus": 10,
"globalstatustext": "Success",
"datapacket": [
{
"packet": {
"number": "629797846789",
"sendingid": 1255497,
"sendingstatus": 10,
"sendingstatustext": "success",
"price": 120
}
}
]
}
]
}
Check balance response payload:
{
"balance_respon": [
{
"globalstatus": 10,
"globalstatustext": "Success",
"Balance": "48240",
"Expired": "2018-02-12"
}
]
}
Status codes: Explained
- Global status format -
Global status code : Global status text
- 10 = Success
- 20 = JSON Post Error
- 30 = APIKey Not registered;
- 40 = IP address not registered
- 50 = Expired Balance
- 55 = Maximum Data
- Sending status format -
Sending status : Sending status text
- 10 = Success
- 60 = Invalid Number
- 70 = Invalid Message
- 80 = Minimum Balance
- 90 = System Error
License
MIT