https://github.com/bsgworld/bsg-nodejs
The open source Node.js client for BSG's REST API. SMS, Viber, HLR services
https://github.com/bsgworld/bsg-nodejs
bsg nodejs-sms sms sms-api sms-gateway sms-messages sms-nodejs sms-provider sms-service viber-api
Last synced: 13 days ago
JSON representation
The open source Node.js client for BSG's REST API. SMS, Viber, HLR services
- Host: GitHub
- URL: https://github.com/bsgworld/bsg-nodejs
- Owner: bsgworld
- License: bsd-2-clause
- Created: 2017-02-14T08:22:31.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T08:55:30.000Z (over 1 year ago)
- Last Synced: 2024-06-07T10:18:46.384Z (over 1 year ago)
- Topics: bsg, nodejs-sms, sms, sms-api, sms-gateway, sms-messages, sms-nodejs, sms-provider, sms-service, viber-api
- Language: JavaScript
- Homepage: https://bsg.world/developers/
- Size: 13.7 KB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BSG API. Free SMS API - Node.js
This repository contains the open source Node.js client for BSG API.
## Requirements
- [Sign up](https://app.bsg.world/auth/signup?utm_source=github&utm_medium=referral&utm_campaign=nodejs) for a free account
- Get api key [here](https://app.bsg.world/integration/remote?utm_source=github&utm_medium=referral&utm_campaign=nodejs)
- Go through the [API documentation](https://bsg.world/documentations/rest-api/sms-api/sending-sms/?utm_source=github&utm_medium=referral&utm_campaign=nodejs)
## Installation
`npm install bsg-nodejs`
Usage
-----
```javascript
var bsg = require( 'bsg' )( '' );
bsg.createHLR(
{
msisdn: '380972920000',
reference: 'extid1',
tariff: '0',
callback_url: 'http://someurl.com/callback/?id=12345'
}
).then(
HLR => console.log( "HLR created:", HLR ),
error => console.log( "HLR creation failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.createSMS(
{
destination: "phone",
originator:"alpha name",
body:"message text",
msisdn:"380972000000",
reference:"ext_id_16",
validity:"1",
tariff:"0"
}
).then(
SMS => console.log( "SMS created:", SMS ),
error => console.log( "SMS creation failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.createViber(
{
tariff:0,
validity:1,
messages:[
{
to:[
{
msisdn:380972920000,
reference:"ext_id_19"
}
],
text:"My Viber messages is shinier than your SMS messages",
alpha_name:"BSG",
is_promotional:false,
options:{
viber:{
img:"http://mysite.com/logo.png",
caption:"See Details",
action:"http://mysite.com/"
}
}
}
]
}
).then(
viber => console.log( "Viber created:", viber ),
error => console.log( "Viber creation failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getBalance().then(
balance => console.log( "Balance request completed:", balance ),
error => console.log( "Balance request failed", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getHLR(
{
reference: 'extid1'
}
).then(
HLR => console.log( "HLR retrieved:", HLR ),
error => console.log( "HLR retrieval failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getHLRPrices().then(
prices => console.log( "HLR prices retrieved:", prices ),
error => console.log( "HLR prices retrieval failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getSMS(
{
reference: 'ext_id_16'
}
).then(
SMS => console.log( "SMS retrieved:", SMS ),
error => console.log( "SMS retrieval failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getSMSPrices().then(
prices => console.log( "SMS prices retrieved:", prices ),
error => console.log( "SMS prices retrieval failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getViber(
{
reference: 'ext_id_19'
}
).then(
viber => console.log( "Viber retrieved:", viber ),
error => console.log( "Viber retrieval failed:", error )
);
```
```javascript
var bsg = require( 'bsg' )( '' );
bsg.getViberPrices().then(
prices => console.log( "Viber prices retrieved:", prices ),
error => console.log( "Viber prices retrieval failed:", error )
);
```
Take a look into 'examples' folder for complete list of available calls