# adonis-twilio

> A service provider for twilio package

Latest version **0.1.0** (published 2017-04-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install adonis-twilio
pnpm add adonis-twilio
yarn add adonis-twilio
bun add adonis-twilio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2017-04-20 |
| First published | 2017-04-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.2.4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ahsaan Yousuf |
| Maintainers | ahsankhatri |
| Keywords | sms, twilio, adonis |

## Links

- npm: https://www.npmjs.com/package/adonis-twilio
- Repository: https://github.com/ahsankhatri/adonis-twilio
- Homepage: https://github.com/ahsankhatri/adonis-twilio#readme
- Issues: https://github.com/ahsankhatri/adonis-twilio/issues
- npm.io page: https://npm.io/package/adonis-twilio

## Dependencies (1)

- [twilio](https://npm.io/package/twilio.md) ^2.11.1

## Recent versions

- 0.1.0 (latest) — 2017-04-20
- 0.0.2 — 2017-04-14

## README

# adonis-twilio

[![Version](https://img.shields.io/npm/v/adonis-twilio.svg?style=flat)](https://www.npmjs.com/package/adonis-twilio)
[![Downloads](https://img.shields.io/npm/dt/adonis-twilio.svg?style=flat)](https://www.npmjs.com/package/adonis-twilio)
[![License](https://img.shields.io/npm/l/adonis-twilio.svg?style=flat)](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

---
_Source: https://npm.io/package/adonis-twilio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._