Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greensms-io/greensms-node
Node.js GREENSMS API client: SMS, Call, Voice, VK, WhatsApp, Viber
https://github.com/greensms-io/greensms-node
2fa 2fa-codes 2fa-security 2factor call calling calling-codes sms sms-api sms-messages sms-service viber viber-api vk vk-api voice whatsapp-api
Last synced: about 1 month ago
JSON representation
Node.js GREENSMS API client: SMS, Call, Voice, VK, WhatsApp, Viber
- Host: GitHub
- URL: https://github.com/greensms-io/greensms-node
- Owner: greensms-io
- Created: 2020-10-17T16:44:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-20T15:52:45.000Z (about 1 year ago)
- Last Synced: 2024-09-27T05:01:59.412Z (about 2 months ago)
- Topics: 2fa, 2fa-codes, 2fa-security, 2factor, call, calling, calling-codes, sms, sms-api, sms-messages, sms-service, viber, viber-api, vk, vk-api, voice, whatsapp-api
- Language: JavaScript
- Homepage: https://api.greensms.ru
- Size: 468 KB
- Stars: 8
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# greensms-node
[](https://nodei.co/npm/greensms/)
[](https://www.codacy.com/gh/greensms-ru/greensms-node/dashboard?utm_source=github.com&utm_medium=referral&utm_content=greensms-ru/greensms-node&utm_campaign=Badge_Grade)
## Documentation
The documentation for the GREENSMS API can be found [here][apidocs].
## Installation
```bash
npm install greensms --save
```
## Sample Usage
Check out these [code examples](examples) in JavaScript and TypeScript to get up and running quickly.
```javascript
const GreenSMS = require("greensms");
// Register at my.greeensms.ru first
const client = new GreenSMS({ user: "test", pass: "test" });
client.sms
.send({
to: "71231234567",
txt: "Message to deliver",
})
.then((response) => {
console.log("Request ID: %s", response.request_id);
})
.catch((err) => {
console.error(err);
});
```
### Environment Variables
`greensms-node` supports credential storage in environment variables. If no credentials are provided following env vars will be used: `GREENSMS_USER`/`GREENSMS_PASS` OR `GREENSMS_TOKEN`.
### Token Auth
```javascript
const GreenSMS = require("greensms");
const client = new GreenSMS({ token: "token" });
client.account
.balance()
.then((response) => {
console.log("Balance ", response.balance);
})
.catch((err) => {
console.error(err);
});
```
### Callback Example
```javascript
const GreenSMS = require("greensms");
// Register at my.greeensms.ru first
const client = new GreenSMS({ user: "test", pass: "test" });
function cb(err, response) {
console.error("Error ", err);
console.log("Response", response);
}
greenSmsInstance.account.balance(cb);
```
## Compatibility
`greensms-node` is compatible with Node.js 12+ and tested until 19.x.
## Methods
- You can either use username/password combination or auth token to create an object with constructor
- All methods support Promises, Async/Await and Callbacks.
- Each API Function is available as `MODULE.FUNCTION()`
- Parameters for each API can be referred from [here][apidocs]
- Response keys by default are available in `snake_case`. If you want to use `camelCase`, then pass `camelCaseResponse: true`, in the constructor
## Handling Exceptions
- Exceptions for Promise are caught in the catch block.
- For Async/Await, you can catch the error with `try/catch` block
- Each Error consists of `error`, `code`, `message`, `errorType` fields and extends the default javascript `Error` class
## Getting help
If you need help installing or using the library, please contact us: [[email protected]](mailto:[email protected]).
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
## Contributing
Bug fixes, docs, and library improvements are always welcome. Please refer to our [Contributing Guide](CONTRIBUTING.md) for detailed information on how you can contribute.
If you're not familiar with the GitHub pull request/contribution process, [this is a nice tutorial](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
### Getting Started
If you want to familiarize yourself with the project, you can start by [forking the repository](https://help.github.com/articles/fork-a-repo/) and [cloning it in your local development environment](https://help.github.com/articles/cloning-a-repository/). The project requires [Node.js](https://nodejs.org) to be installed on your machine.
After cloning the repository, install the dependencies by running the following command in the directory of your cloned repository:
```bash
npm install
```
You can run the existing tests to see if everything is okay by executing:
```bash
npm test
```
[apidocs]: https://api.greensms.ru/