Home

node-twilio

node-twilio is a Twilio helper library for Node.js.

API Documentation

node-twilio consists of three main parts.

• The High-Level Interface, which presents Twilio as a set of EventEmitter objects and allows simple, powerful, and easy building of Twilio apps.
• The TwiML interface, which makes generating and working with TwiML simple and less error-prone than hand-writing the XML.
• The Lower-Level REST interface, which makes all the requests back and forth with Twilio, and is consumed by The High-Level Interface.

Getting started

First, you must sign up for a Twilio account. From this, you will obtain an Account Sid and an Auth Token. You will use these when instantiating a Twilio object in Node.

Next, you must install node-twilio. See README.md for instructions.

Now you're all set and ready to start using node-twilio to build powerful voice and SMS applications!

Instantiating the Library

var TwilioClient = require('twilio').Client,
      Twiml = require('twilio').Twiml,
      sys = require('sys');

var client = new TwilioClient(MY_ACCOUNT_SID, MY_AUTH_TOKEN, MY_HOSTNAME);

// Let's get a PhoneNumber object
// Note: It is assumed that +16067777777 is a Twilio phone number available from your account
// Another note: You may pass in either a phone number or a phone number sid.
var phone = client.getPhoneNumber('+16067777777');

// Phone.setup() configures the phone number object. It requests the phone number instance
// resource associated with the number and populates an internal data structure representing itself.
// The callback passed in is called when setup completes.
phone.setup(function() {
    // Hey, let's call my parents!
    phone.makeCall('+19058926737', null, function(call) {
        // The callback for makeCall is passed a "call" object.
        // This object is an event emitter.
        call.on('answered', function(reqParams, res) {
            // Here, reqParams is a map of the POST vars Twilio sent when it requested our auto-uri
            // res is a Twiml.Response object.
            // We can "append" Twiml elements to res. Let's append a Say verb element.
            res.append(new Twiml.Say('Hey mom and dad! I hope you are having fun! I love you!'));
            res.send();
     });
});

That's the very basics. Read further in the documentation for more.

Try starting at The High-Level Interface, and also make sure to read The TwiML interface, as it's definitely useful. If you're interested in more details (and with them, flexibility and power), check out The Lower-Level REST interface.