Node-RED Call Control for Twilio® TwiML® platforms

This repository contains a collection of nodes which implement a Twilio compliant API.

This is a community project.

Twilio and TwiML are registered trademarks of Twilio and/or its affiliates. Other names may be trademarks of their respective owners.

Automat Berlin GmbH as well as the authors of this module are not affiliated with, nor endorsed by, nor connected in any way to Twilio Inc. or any of its affiliates.

Quickstart

You can get hands-on experience with Node-RED and Twilio nodes by deploying them to Heroku. You only need a free account (no credit card required).

Note: The 'Deploy to Heroku' button will not work properly if your browser is removing the Referer HTTP header from the request.

Installation

Prerequisite: You need to have a running Node-RED instance. If you do not have it installed yet, read the Node-RED Getting Started guide.

Install the last released version from the Node-RED dashboard

The easiest way to install Twilio nodes is to use the Manage palette option in the Node-RED menu (in the top right corner of its dashboard). Switch to the Install tab and search for @automat-berlin/node-red-contrib-twilio. There should be only one result. Click the install button next to it.

Installation from the source code

First, clone this repository. Optionally switch to the desired branch.

Next, go to the Node-RED install directory, typically ~/.node-red, and install the cloned package there.

cd ~/.node-red/
npm install <path-to-cloned-repository>

Configuration

You should be aware of how to configure Node-RED (read the docs here).

The following instructions assume that you are using the settings.js file for the configuration (found in the user directory or specified with -s command-line argument).

Set baseUrl for StatusCallback

The base URL will be used to create an absolute StatusCallback URL (read more about callback requests here).

Find the functionGlobalContext object and add the baseUrl property with the base URL of your Node-RED deployment.

    ...
    functionGlobalContext: {
        baseUrl: 'http://example.com'
    },
    ...

Tests

First, go to the repository's main directory and install all dependencies:

npm install

Then to run all tests use this command:

npm test

Contributing

We welcome all contributions. Please read our contributing guidelines.

Contact us if you have any questions via email at [email protected] or create an issue.

Contact

This repository is owned and maintained by Automat Berlin GmbH.

Twilio® and TwiML® are registered trademarks of Twilio and/or its affiliates.

License

The code in this repository is released under the MIT license. See LICENSE for details.