NodeJS SDK for the nomado API
Introduction
nomado is a telephony and SMS solution for businesses and private customers. Our goal is to provide super user-friendly tools to meet your growing needs of nomadism.
This package provides a client to access the nomado API.
Table of Contents
Installation
npm install nomado
Quickstart
You should first get a free nomado account on my.nomado.eu/join.
Below is a quick example for initializing the library and sending a SMS.
const nomadoClient = ; const USERNAME = 'username';const PASSWORD = 'password'; const nomado = USERNAME PASSWORD; const smsOptions = to: '3245678901' message: 'Hello world' unicode: false; nomadosms ;
Documentation
The nomadoClient
class provides the public interfaces to access the nomado API
SMS
OTP
Calls
HLR
Account
Authentication
First, initialize the library with your nomado credentials.
const nomado = USERNAME PASSWORD;
Now, you can start sending requests to the API.
Responses
Every call will return a promise that will be resolved (or rejected) with an object containing the API response code and the data.
// Result object: code: 200 reason: "" //in case of error data: {}
SMS
Send
Send a SMS to one or multiple numbers.
nomadosms; // example response code: 200 data: callerID: 'NOMADO' text: 'Bonjour le monde' unicode: 0 '3245678901': ... '3245678902': ... cost: 016 total_sms: 2
If you are sending unicode SMS, don't forget to turn on the unicode
flag, otherwise encoding problems may occur.
OTP
Sending 2FA code via SMS to your users without the hassle.
Send
nomadootp
In the template, {{CODE}}
will be replaced by the generated 2FA code.
Verify
Let's check the code entered by your user.
nomadootp // expected response code: 200 data: verify: true
Once the code has been verified, it becomes invalidated.
Calls
Make
Makes a call to a telephone line or number. When it answers, makes a second call to a number, bridging both calls together.
nomadocalls; // example response code: 200
HLR
Make HLR queries to any mobile number.
Fetch
nomadohlr; // example response code: 200 data: '3245678901': ... '3245678902': ... valid_numbers: 2 cost: 005
Validate
Free query to validate mobile phone numbers and get short information
nomadohlr; // example response code: 200 data: Status: 'Valid' Region: 'BE' ...
Account
Easy way to check your current balance
Get balance
nomadoaccount; // example response code: 200 data: balance: '95.740418'
Contributing
You are welcome to contribute in several ways like creating new features, fixing bugs, improving documentation, translating etc... More information in CONTRIBUTING.md.
Support
We are a small team dedicated to offer you the best support because we want to satisfy you. For any problem or question, feel free to contact us.