https://github.com/ahsankhatri/adonis-twilio
AdonisJS (NodeJS MVC Framework) Addon Provider for Twilio (SMS Service)
https://github.com/ahsankhatri/adonis-twilio
adonis adonis-framework adonisjs nodejs twilio
Last synced: about 1 year ago
JSON representation
AdonisJS (NodeJS MVC Framework) Addon Provider for Twilio (SMS Service)
- Host: GitHub
- URL: https://github.com/ahsankhatri/adonis-twilio
- Owner: ahsankhatri
- License: mit
- Created: 2017-04-13T16:48:33.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-20T15:52:43.000Z (about 9 years ago)
- Last Synced: 2025-04-01T23:42:49.191Z (about 1 year ago)
- Topics: adonis, adonis-framework, adonisjs, nodejs, twilio
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# adonis-twilio
[](https://www.npmjs.com/package/adonis-twilio)
[](https://www.npmjs.com/package/adonis-twilio)
[](https://www.npmjs.com/package/adonis-twilio)
[Twilio](https://github.com/twilio/twilio-node) Provider for AdonisJs framework.
## Installation
In order to use adonis-twilio
```
npm install adonis-twilio --save
```
## Setup
Once you have installed the provider from the [npm](https://npmjs.org/packages/adonis-twilio), make sure to follow the below steps to setup the provider.
##### bootstrap/app.js
```javascript
const providers = [
...,
'adonis-twilio/providers/TwilioProvider'
]
```
Also, for registering commands.
##### bootstrap/app.js
```javascript
const aceProviders = [
...,
'adonis-twilio/providers/CommandsProvider'
]
const commands = [
...,
'Adonis/Commands/Twilio:Config'
]
```
Also, it is a good practice to setup an alias to avoid typing the complete namespace.
##### bootstrap/app.js
```javascript
const aliases = {
...,
Twilio: 'Adonis/Addons/Twilio'
}
```
Then, for generating a config file.
```bash
./ace twilio:config
```
## Configuration
Adonis Twilio configuration file located at `config/twilio.js` and set your environment variables in `.env` with following.
```
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
TWILIO_FROM=+15005550006
```
## Usage
Load the module first
```javascript
const Twilio = use('Adonis/Addons/Twilio')
```
##### Send SMS
```javascript
Twilio.sendMessage('+14108675309', 'Hello from Node', function(err, response) {
console.log( err, response );
}
```
##### Send MMS
```javascript
Twilio.sendMessage('+14108675309', 'Hello from Node', 'http://cdn.memegenerator.co/images/200x/42.jpg', function(err, response) {
console.log( err, response );
}
```
##### Make a Call
```javascript
Twilio.makeCall('+14108675309', 'http://www.example.com/twiml.php', function(err, response) {
console.log( err, response );
}
```
## Changelog
[CHANGELOG](CHANGELOG.md)
## Credits
Thanks to the community of [AdonisJs](http://www.adonisjs.com/).
## Copyright and License
Copyright (c) 2016 [Ahsaan Muhammad Yousuf](http://ahsaan.me/), [MIT](LICENSE) License