An open API service indexing awesome lists of open source software.

https://github.com/minusinfinite/smseveryone-node

Unoffical SMSEveryone API Wrapper for Node
https://github.com/minusinfinite/smseveryone-node

Last synced: 4 months ago
JSON representation

Unoffical SMSEveryone API Wrapper for Node

Awesome Lists containing this project

README

          

# smseveryone-node

Unoffical SMSEveryone API Wrapper for NodeJS

## Installation

Use the package manager of your choice

```shell

pnpm add smseveryone-node

```

Import the package into your project

```js

import {SMSEveryone} from 'smseveryone-node'

```

## Documentation

Official API Documentation -

### Authentication

```js

const sendSMS = new SMSEveryone('username','password')

```

### Send and SMS Campaign

```js

sendSMS.sms({
originator:"AplhaTag",
destinations:["phonenumbers"],
message:"Hello, from SMS Everyone module test",
action:"create"})
.then(r => console.log(r))
.catch(e => console.error(e))

```

or using async and try..catch

### Endpoints Supported

- [Campaign Request](https://www.smseveryone.com.au/restapi#comp-kd6my2uy) - Send or Schedule an SMS
- [Delivery Receipts Request](https://www.smseveryone.com.au/restapi#comp-kd85w97c) - Check Deliverys
- [Replies Request](https://www.smseveryone.com.au/restapi#comp-kd6tcvxv) - Get Replies
- [Optouts Request](https://www.smseveryone.com.au/restapi#comp-kd8342y8) - Manage Optopts
- [List Request](https://www.smseveryone.com.au/restapi#comp-kdgug91j) - Manage Lists for bulk SMSs
- [Add Credit Rejest](https://www.smseveryone.com.au/restapi#comp-kz4t16xe) - Add Credits, if approved