npm:loopback-connector-twilio

README

loopback-connector-twilio

Customizing Twilio configuration for examples

By default, examples from this module assumes the user has a Twillio account. To run the example you will need to provide your accountSid and authToken.

The connector support the following aspects of the Twilio REST API:

Installation

In your LoopBack project:

$ npm install --save loopback-connector-twilio

Using the Connector

To use the connector, define the datasource using the connector in your datasources.json file:

"twilio": {
    "name": "twilio",
    "connector": "loopback-connector-twilio",
    "accountSid": "YOUR_TWILIO_ACCOUNT_SID",
    "authToken": "YOUR_TWILIO_AUTH_TOKEN"
}

Next, attach the created datasource to a model in the model-config.json file:

"Twilio": {
    "dataSource": "twilio",
    "public": true
}

Now, using the created model, you can send an SMS or make a call using the send method of the model:

Twilio.send(options, callback);

Note: options is defined by the JSON objects in the next two sections:

Sending a SMS

{
    type: 'sms',
    to: 'TARGET_PHONE_NUMBER',
    from: 'YOUR_TWILIO_PHONE_NUMBER',
    body: 'TEXT_MESSAGE'
}

Making a Call

{
    type: 'call',
    to: 'TARGET_PHONE_NUMBER',
    from: 'YOUR_TWILIO_PHONE_NUMBER',
    url: 'URL_TO_TwiMIL_FILE'
}

Sending an Email

{
    type: 'email',
    to: 'TARGET_EMAIL',
    from: 'YOUR_EMAIL',
    subject: 'EMAIL SUBJECT',
    text: 'EMAIL BODY AS PLAIN TEXT',
    html: 'EMAIL BODY AS HTML'
}

Running the Example

To run the example in the /example/example.js directory, you must set the following values in the file:

var SID = 'YOUR_TWILIO_ACCOUNT_SID';
var TOKEN = 'YOUR_TWILIO_ACCOUNT_TOKEN';
var SGAPIKEY = 'YOUR_TWILIO_SENDGRIO_API_KEY';
var TO = 'YOUR_TWILIO_TELEPHONE_NUMBER';
var FROM = 'TARGET_PHONE_NUMBER';

Next, from the from the /loopback-connector-twilio/ directory, install the loopback module using the following command:

$ npm install loopback

Finally, run the example app using the following command from the /loopback-connector-twilio/ directory:

$ node ./example/example.js

NOTE: The url property points to an XML file that specifies a TwiMIL command.

Version

2.0.0

License

MIT

Usage no npm install needed!