-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# fast-2-sms@1.0.0 | ||
[](https://npmjs.org/package/fast-2-sms) [](https://bundlephobia.com/result?p=fast-2-sms) [](https://travis-ci.org/raxraj/fast2sms#master) [](https://coveralls.io/github/raxraj/fast2sms) [](https://david-dm.org/raxraj/fast2sms) [](https://david-dm.org/raxraj/fast2sms#info=devDependencies) | ||
|
||
The Module to send Message using FAST2SMS.com node JS API. | ||
|
||
|
||
|
||
## Installation | ||
Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already. | ||
|
||
```sh | ||
npm install fast-2-sms --save | ||
``` | ||
|
||
This package is provided in these module formats: | ||
|
||
- CommonJS | ||
|
||
## Usage | ||
|
||
```sh | ||
const fast2sms = require('fast-2-sms') | ||
|
||
var options = {authorization = YOUR_API_KEY , message : 'YOUR_MESSAGE_HERE' , numbers : ['9999999999','8888888888']} | ||
This field is optional, it will use "0" as default value or you can set to "1" for sending flash message. | ||
fast2sms.sendMessage(options) | ||
|
||
``` | ||
|
||
Other than Above You may also use following options for more control. | ||
|
||
```sh | ||
|
||
You may also set the other FAST2SMS options | ||
method - Method for request (Default : POST) | ||
sender_id - A custom name for SMS sender (Default: FSTSMS) | ||
language - english / unicode (Unicode supports other languages such as Hindi) (Default: english) | ||
route - p for promotional and t for transactional (Default: p) | ||
flash - This field is optional, it will use "0" as default value or you can set to "1" for sending flash message. | ||
|
||
``` | ||
|
||
|
||
|
||
|
||
## Dependencies | ||
|
||
- [unirest](https://github.com/Mashape/unirest-nodejs): Simplified, lightweight HTTP client library | ||
|
||
|
||
## Dev Dependencies | ||
|
||
None | ||
|
||
## License | ||
[MIT]() |