Send SMS(s), query their delivery reports and sending history in nodejs using infobip JSON API.
Note:! It strongly recommend using the E.164 number formatting when sending SMS(s)
$ npm install bipsms --saveFirstly, you'll need a valid Infobip account.
To send single SMS to single destination, instantiate bipsms with your account details then invoke sendSingleSMS(sms,callback(error,response)) where
sms- is an sms to senderror- is any error encountered when sending SMS(s)response- is a response of sent SMS(s)
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
//prepare sms
var sms = {
from: 'InfoSMS',
to: '41793026727',
text: 'Test SMS.'
};
//send SMS
transport.sendSingleSMS(sms, function(error, response) {
expect(error).to.be.null;
expect(response).to.exist;
expect(response.messages).to.exist;
});To send single SMS to multiple destination, instantiate bipsms with your account details then invoke sendSingleSMS(sms,callback(error,response)) where
sms- is an sms to senderror- is any error encountered when sending SMS(s)response- is a response of sent SMS(s)
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
//prepare SMS
var sms = {
from: 'InfoSMS',
to: [
'41793026727',
'41793026834'
],
text: 'Test SMS.'
};
//send SMS
transport.sendSingleSMS(sms, function(error, response) {
expect(error).to.be.null;
expect(response).to.exist;
expect(response.messages).to.exist;
});To send multiple SMS, instantiate bipsms with your account details then invoke sendMultiSMS(sms,callback(error,response)) where
sms- is a collection of SMS(s) to senderror- is any error encountered when sending SMS(s)response- is a response of sent SMS(s)
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
//prepare sms(s) to send
var sms = {
messages: [{
from: 'InfoSMS',
to: [
'41793026727',
'41793026731'
],
text: 'May the Force be with you!'
}, {
from: '41793026700',
to: '41793026785',
text: 'A long time ago, in a galaxy far, far away.'
}]
};
//send sms(s)
transport.sendMultiSMS(sms, function(error, response) {
expect(error).to.be.null;
expect(response).to.exist;
expect(response.messages).to.exist;
});To send fully featured textual SMS, instantiate bipsms with your account details then invoke sendFeaturedSMS(sms,callback(error,response)) where
sms- is a fully featured textual SMS(s) to senderror- is any error encountered when sending SMS(s)response- is a response of sent SMS(s)
Example
var Transport = require('bipsms');
var transport = new Transport({ username: '<username>', password: '<password>' });
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
//prepare featured sms(s) to send
var sms = {
bulkId: 'BULK-ID-123-xyz',
messages: [{
from: 'InfoSMS',
destinations: [{
to: '41793026727',
messageId: 'MESSAGE-ID-123-xyz'
}, {
to: '41793026731'
}],
text: 'Mama always said life was like a box of chocolates.',
notifyUrl: 'http://www.example.com/sms/advanced',
notifyContentType: 'application/json',
callbackData: 'There\'s no place like home.'
}]
};
//send featured sms(s)
transport.sendFeaturedSMS(sms, function(error, response) {
expect(error).to.be.null;
expect(response).to.exist;
expect(response.messages).to.exist;
});To obtain SMS(s) delivery reports, instantiate bipsms with your account details then invoke getDeliveryReports(options,callback(error,logs)) where
options- are valid request parameters to be supplied on the requesterror- is any error encountered during requesting SMS(s) sent delivery reportdeliveryReport- is SMS(s) sent delivery reports
Note!: Delivery reports can only be retrieved one time. Once you retrieve a delivery report, you will not be able to get the same report again by using this endpoint.
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getDeliveryReports(function(error, deliveryReport) {
expect(error).to.be.null;
expect(deliveryReport).to.exist;
expect(deliveryReport.results).to.exist;
});var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getDeliveryReports({
bulkId: '<bulkId>'
},function(error, deliveryReport) {
expect(error).to.be.null;
expect(deliveryReport).to.exist;
expect(deliveryReport.results).to.exist;
});To obtain SMS(s) sent history(log), instantiate bipsms with your account details then invoke getSentSMSLogs(options,callback(error,logs)) where
options- are valid request parameters to be supplied on the requesterror- is any error encountered during requesting SMS(s) sent history/logslogs- is SMS(s) sent history / logs
Note!: SMS logs are available for the last 48 hours!
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getSentSMSLogs(function(error, logs) {
expect(error).to.be.null;
expect(logs).to.exist;
expect(logs.results).to.exist;
});var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getSentSMSLogs({
bulkId: '<bulkId>'
},function(error, logs) {
expect(error).to.be.null;
expect(logs).to.exist;
expect(logs.results).to.exist;
});To obtain received SMS(s), instantiate bipsms with your account details then invoke getReceivedSMS(options,callback(error,receivedSMS)) where
options- are valid request parameters to be supplied on the requesterror- is any error encountered during requesting received SMS(s)receivedSMS- are SMS(s) received
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getReceivedSMS(function(error, receivedSMS) {
expect(error).to.be.null;
expect(receivedSMS).to.exist;
expect(receivedSMS.results).to.exist;
});var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getReceivedSMS({
limit: '<limit>'
},function(error, receivedSMS) {
expect(error).to.be.null;
expect(receivedSMS).to.exist;
expect(receivedSMS.results).to.exist;
});To obtain received SMS(s) logs, instantiate bipsms with your account details then invoke getReceivedSMSLogs(options,callback(error,logs)) where
options- are valid request parameters to be supplied on the requesterror- is any error encountered during requesting received SMS(s) logslogs- are SMS(s) received logs
Note!: Received messages logs are available for the last 48 hours!
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getReceivedSMSLogs(function(error, logs) {
expect(error).to.be.null;
expect(logs).to.exist;
expect(logs.results).to.exist;
});var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
transport.getReceivedSMSLogs({
limit: '<limit>'
},function(error, logs) {
expect(error).to.be.null;
expect(logs).to.exist;
expect(logs.results).to.exist;
});To obtain your account balance, instantiate bipsms with your account details and invoke getBalance(callback(error,balance)) where
error- is any error encountered during requesting account balancebalance- is a balance object withbalanceandcurrencyas its properties.
var Transport = require('bipsms');
var transport = new Transport({username:'<username>',password:'<password>'});
//or use Fake Transport for non production environment
var transport = new Transport({fake:true});
//then request your account balance
transport.getBalance(function(error, balance) {
expect(error).to.be.null;
expect(balance).to.exist;
expect(balance.balance).to.equal(5);
expect(balance.currency).to.equal('EUR');
});-
Clone this repository
-
Install all development dependencies
$ npm install- Then run unit test
$ npm testMake sure you have put your details in test/intergration/intergration.json. Use this template
{
"account": {
"username": "<name>",
"password": "<password>"
},
"from": "<sender id>",
"singleSingleSMS": {
"single": {
"to": "<number>"
},
"multi": {
"to": ["<number>", "<number>"]
}
},
"sendMultiSMS": {
"to": ["<number>", "<number>"]
}
}then run intergration test task as
$ grunt intergrationFork this repo and push in your ideas and do not forget to add a bit of test(s) of what value you adding.
The MIT License (MIT)
Copyright (c) 2015 lykmapipo & Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.