https://github.com/pitops/budgetsms-node
A wrapper for budgetSMS for use with NodeJS
https://github.com/pitops/budgetsms-node
budgetsms budgetsms-node library node sms-gateway
Last synced: about 2 months ago
JSON representation
A wrapper for budgetSMS for use with NodeJS
- Host: GitHub
- URL: https://github.com/pitops/budgetsms-node
- Owner: pitops
- License: mit
- Created: 2019-01-13T10:46:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-01T03:34:12.000Z (over 5 years ago)
- Last Synced: 2025-03-24T01:18:36.936Z (about 1 year ago)
- Topics: budgetsms, budgetsms-node, library, node, sms-gateway
- Language: JavaScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# budgetSMS-node
A wrapper for budgetSMS for use with NodeJS.
## Setup
```bash
npm i budgetsms-node
```
## How to use
### Initialize
```javascript
const BudgetSMS = new BudgetSMSAPI({
username: process.env.BUDGET_SMS_USERNAME,
userid: process.env.BUDGET_SMS_USER_ID,
handle: process.env.BUDGET_SMS_HANDLE
})
```
### Send SMS
```javascript
BudgetSMS.from('InfoSMS')
.to('123456789')
.message('Hello world')
.send()
.then(json => console.log(json))
.catch(error => console.error(error))
```
## For testing your solution use `test` instead
```javascript
BudgetSMS.from('InfoSMS')
.to('123456789')
.message('Hello world')
.test()
.then(json => console.log(json))
.catch(error => console.error(error))
```
## Error codes
You can use this [page](https://www.budgetsms.net/sms-http-api/error-code/) for the meaning of the various error codes.