https://github.com/ghasedakapi/ghasedak-node
Ghasedak sms webservice for nodejs
https://github.com/ghasedakapi/ghasedak-node
nodejs sms-api sms-sdk
Last synced: 3 months ago
JSON representation
Ghasedak sms webservice for nodejs
- Host: GitHub
- URL: https://github.com/ghasedakapi/ghasedak-node
- Owner: ghasedakapi
- License: mit
- Created: 2017-11-28T07:25:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-08T15:34:13.000Z (about 4 years ago)
- Last Synced: 2025-10-06T14:53:21.537Z (8 months ago)
- Topics: nodejs, sms-api, sms-sdk
- Language: JavaScript
- Homepage: https://ghasedak.me/nodejs
- Size: 20.5 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Ghasedak sms webservice package for nodejs.
## install
You can simply install and use ghasedak nodejs library from npm:
```sh
npm install --save ghasedak
```
or from yarn:
```sh
yarn install ghasedak
```
## usage
Import `ghasedak` package:
```javascript
const Ghasedak = require("ghasedak");
```
You need a [Ghasedak](https://ghasedak.me) account. Register and get your API key.
Create an instance from `Ghasedak` class with your API key:
```javascript
let ghasedak = new Ghasedak(
"3ef8539ba50c06b2a11d674c8a7ded7d7360d7b090b5146ff0761e8d9927bd31"
);
```
Send a single sms:
```javascript
ghasedak.send({
message: "Hello World!",
receptor: "09xxxxxxxxx",
linenumber: "xxxxxxxx",
});
```
Send a group massages:
```javascript
ghasedak.bulk({
message: "Hello World!",
receptor: "09xxxxxxxxx",
linenumber: "xxxxxxxx",
senddate: "1644732815",
});
```
get the status of massages:
```javascript
ghasedak.status({
id: "2914845496",
type: "1",
});
```
Send a verification massages:
```javascript
ghasedak.verification({
receptor: "09xxxxxxxxx",
type: "1",
template: "Your Template",
param1: "xxx",
});
```
:)
##
## license
Released under the BSD-3-Clause-Clear License.