nimbasms-node
A NodeJS module for communicating with Nimba SMS API.
Usage
Installation
npm install nimbasms
Check balance
const { Client } = require('nimbasms/client');
const config = {
SERVICE_ID = 'XXXXXXXXXXX',
SECRET_TOKEN = 'YYYYYYYYYYYYYYYYYYY',
}
const client = new Client(config)
client.accounts.get()
.then(account => {
console.log(`My Account balance: ${account['balance']}`);
})
.catch(error => {
console.log(error);
})
Groups
const { Client } = require('nimbasms/client');
const config = {
SERVICE_ID = 'XXXXXXXXXXX',
SECRET_TOKEN = 'YYYYYYYYYYYYYYYYYYY',
}
const client = new Client(config)
client.groups.list()
.then(groups => {
console.log(`There are ${groups.count} groups.`);
})
.catch(error => {
console.log(error);
})
Sendernames
const { Client } = require('nimbasms/client');
const config = {
SERVICE_ID = 'XXXXXXXXXXX',
SECRET_TOKEN = 'YYYYYYYYYYYYYYYYYYY',
}
const client = new Client(config)
client.sendernames.list()
.then(sendernames => {
console.log(`There are ${sendernames.count} sendernames.`);
for(let sendername of sendernames.results) {
console.log(sendername)
}
})
.catch(error => {
console.log(error);
})
Create Contact
const { Client } = require('nimbasms/client');
const config = {
SERVICE_ID = 'XXXXXXXXXXX',
SECRET_TOKEN = 'YYYYYYYYYYYYYYYYYYY',
}
const client = new Client(config)
client.contacts.list()
.then(contacts => {
console.log(`There are ${contacts.results.length} contacts.`);
for(let contact of contacts.results) {
console.log(contact);
}
})
.catch(error => {
console.log(error);
})
const body = {
numero: '224XXXXXXXXX'
}
client.contacts.create(body)
.then(contact => {
console.log(`A contact has been added : `, contact);
})
.catch(error => {
console.log(error);
});
const body = {
numero: '224XXXXXXXXX',
name: 'Foo',
groups: ['API', 'Facebook Client'],
}
client.contacts.create(body)
.then(contact => {
console.log(`A contact has been added :`, contact);
})
.catch(error => {
console.log(error);
});
Messages
const { Client } = require('nimbasms/client');
const config = {
SERVICE_ID = 'XXXXXXXXXXX',
SECRET_TOKEN = 'YYYYYYYYYYYYYYYYYYY',
}
const client = new Client(config)
client.messages.list()
.then(messages => {
console.log(`There are ${messages.count} messages in your account.`);
})
.catch(error => {
console.log(error);
});
client.messages.list({limit: 10})
.then(messages => {
console.log('Here are the last 10 messages in your account:')
for( message of messages.results){
console.log(message)
}
})
.catch(error => {
console.log(error);
});
const body = {
to: ['6XXXXXXXXX'],
message: 'Hello from Nimba SMS !',
sender_name: 'YYYYYYYYYY',
}
client.messages.create(body)
.then(message => {
console.log(`A new message has been sent : `, message);
})
.catch(error => {
console.log(error);
});
const messageId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
client.messages.get(messageId)
.then(message => {
console.log('Got one message : ', message)
})
.catch(error => {
console.log(error);
});
Verifications
const { Client } = require('nimbasms/client');
const config = {
SERVICE_ID = 'XXXXXXXXXXX',
SECRET_TOKEN = 'YYYYYYYYYYYYYYYYYYY',
}
const client = new Client(config)
const verification = {
to: "+123456789",
message: "Your verification code is: <1234>",
expiry_time: 5,
};
client.verifications.create(verification)
.then(response => {
console.log("A verification request is issued: ", response);
})
.catch(error => {
console.log(error);
});
const verificationParams = {
verificationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
code: "YYYY",
};
client.verifications.verify(verificationParams)
.then(response => {
console.log(response);
})
.catch(error => {
console.log(error);
})
Credit
Nimba SMS