https://github.com/smsglobal/smsglobal-node
The SMSGlobal Node library provides convenient access to the SMSGlobal rest API from node applications.
https://github.com/smsglobal/smsglobal-node
node node-library node-module nodejs nodejs-library sms smsglobal
Last synced: 9 days ago
JSON representation
The SMSGlobal Node library provides convenient access to the SMSGlobal rest API from node applications.
- Host: GitHub
- URL: https://github.com/smsglobal/smsglobal-node
- Owner: smsglobal
- License: mit
- Created: 2020-09-04T02:45:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-11-11T03:35:28.000Z (2 months ago)
- Last Synced: 2025-11-11T05:28:47.410Z (2 months ago)
- Topics: node, node-library, node-module, nodejs, nodejs-library, sms, smsglobal
- Language: JavaScript
- Homepage:
- Size: 52.7 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SMSGlobal node SDK
[](https://codecov.io/gh/smsglobal/smsglobal-node)
[](https://www.npmjs.com/package/smsglobal)
[](https://www.npmjs.com/package/smsglobal)
[](https://www.npmjs.com/package/smsglobal)
The SMSGlobal Node library provides convenient access to the SMSGlobal REST API from node applications.
Sign up for a [free SMSGlobal account](https://www.smsglobal.com/mxt-sign-up/?utm_source=dev&utm_medium=github&utm_campaign=node_sdk) today and get your API Key from our advanced SMS platform, MXT. Plus, enjoy unlimited free developer sandbox testing to try out your API in full!
## Example
Check out the [code examples](examples)
## SMSGlobal rest API credentials
Rest API credentials can be provided in the SMSGlobal client or node environment variables. The credential variables are `SMSGLOBAL_API_KEY` and `SMSGLOBAL_API_SECRET`
## Installation
```
npm install --save smsglobal
```
## Usage
* Require `smsglobal` in your file
```
const apiKey = 'YOUR_API_KEY';
const apiSecret = 'YOUR_API_SECRET';
var smsglobal = require('smsglobal')(apiKey, secret);
```
> All method return promise if no callback is given
### To send a sms
```js
var payload = {
origin: 'from number',
destination: 'destination',
message: 'This is a test message'
}
smsglobal.sms.send(payload, function (error, response) {
console.log(response);
});
```
### To fetch a list outgoing sms
```js
var promise = smsglobal.sms.getAll();
promise
.then(function(response) {
console.log(response)
})
.catch(function(error){
console.log(error)
});
```
### To fetch an outgoing sms by id
```js
var id = 'outgoing-sms-id';
var promise = smsglobal.sms.get(id);
promise
.then(function(response) {
console.log(response)
})
.catch(function(error){
console.log(error)
});
```
### To fetch a list incoming sms
```js
var promise = smsglobal.sms.incoming.getAll();
promise
.then(function(response) {
console.log(response)
})
.catch(function(error){
console.log(error)
});
```
### To fetch an incoming sms by id
```js
var id = 'incoming-sms-id';
var promise = smsglobal.sms.incoming.get(id);
promise
.then(function(response) {
console.log(response)
})
.catch(function(error){
console.log(error)
});
```
### To send an OTP
```js
var payload = {
origin: 'from number',
message: '{*code*} is your SMSGlobal verification code.',
destination: 'destination'
};
// {*code*} placeholder is mandatory and will be replaced by an auto generated numeric code.
smsglobal.otp.send(payload, function(error, response) {
if (response) {
console.log(response);
}
if (error) {
console.log(error);
}
});
```
*Success response object*
```js
{
statusCode: 200,
status: 'OK',
data: {
requestId: '404372541683676561917558',
destination: '61400000000',
validUnitlTimestamp: '2020-11-18 17:08:14',
createdTimestamp: '2020-11-18 16:58:14',
lastEventTimestamp: '2020-11-18 16:58:14',
status: 'Sent'
}
}
```
*Error response object in the case of validation error*
```js
{
statusCode: 400,
status: 'Bad Request',
data: {
errors: {
message: {
errors: [
'Message template should contain a placeholder for code i.e. {*code*}.'
]
}
}
}
}
```
### To cancel an OTP request
The OTP request can be cancelled if it's not expired and verified yet. It can be done by either using `requestId` or `destination number`. The followings are examples of each method:
```js
var id = 'otp-request-id'; // requestId received upon sending an OTP
var promise = smsglobal.otp.cancelByRequestId(id)
promise.then((response) => {
console.log(response)
}).catch((err) => {
console.log(error)
});
```
```js
var destination = 'destination-number';
var promise = smsglobal.otp.cancelByDestination(id)
promise.then((response) => {
console.log(response)
}).catch((err) => {
console.log(error)
});
```
*Success response object*
```js
{
statusCode: 200,
status: 'OK',
data: {
requestId: '404372541683676561917558',
destination: '61400000000',
validUnitlTimestamp: '2020-11-18 17:08:14',
createdTimestamp: '2020-11-18 16:58:14',
lastEventTimestamp: '2020-11-18 16:58:14',
status: 'Cancelled'
}
}
```
### To verify an OTP code entered by your user
The OTP code entered by your user can be verified by either using `requestId` or `destination number`. The followings are examples of each method:
```js
var id = 'otp-request-id'; // requestId received upon sending an OTP
var code = 'otp-code'; // input code entered by your user
smsglobal.otp.verifyByRequestId(id, code, function(error, response) {
if (response) {
console.log(response);
}
if (error) {
console.log(error);
}
});
```
```js
var destination = 'destination-number';
var code = 'otp-code'; // input code entered by your user
smsglobal.otp.verifyByDestination(id, code, function(error, response) {
if (response) {
console.log(response);
}
if (error) {
console.log(error);
}
});
```
*Success response object*
```js
{
statusCode: 200,
status: 'OK',
data: {
requestId: '404372541683676561917558',
destination: '61400000000',
validUnitlTimestamp: '2020-11-18 17:08:14',
createdTimestamp: '2020-11-18 16:58:14',
lastEventTimestamp: '2020-11-18 16:58:14',
status: 'Verified'
}
}
```
## Running tests
Run the tests:
```
npm test
```
To run test with code coverage report
```
npm run mocha-only
```
## Available REST API Resources
* Sms
* Sms Incoming
* OTP (beta)
# Reference
[REST API Documentation](https://www.smsglobal.com/rest-api/?utm_source=dev&utm_medium=github&utm_campaign=node_sdk)
For any query [contact us](https://www.smsglobal.com/contact/?utm_source=dev&utm_medium=github&utm_campaign=node_sdk)