Tropo WebAPI Node.js Library
Latest commit 0b5b21e Jun 18, 2016 @Colby-6sco Colby-6sco committed on GitHub Add machineDetection, playTones, voice to Transfer
Failed to load latest commit information.
lib Add machineDetection, playTones, voice to Transfer Jun 18, 2016
samples Library update Nov 11, 2013
.DS_Store fix to reflect ring event Apr 28, 2011
LICENSE Added MIT license Oct 1, 2012
package.json updating package version Jul 4, 2012

Tropo WebAPI Node.js Library

A Node.js module for the Tropo WebAPI.


To get started you will first need to have Node.js installed. Howtonode has a good write-up on installing Node.js on Windows, Ubuntu and OSX.

If you have Node.js installed, and are using the Node Package Manager (npm), just do:

~$ npm install tropo-webapi -g

If you install with npm, then you can reference the tropo Node library in your node.js scripts like this:


If you do not have npm installed, then you will then want to create a directory for your project, you may want to use a convention like this:


Add this declaration to your server.js starting file

    var tropowebapi = require('tropo-webapi');


You may then run your script from within the project directory with:

    node server.js

Sample Usage

Generate a JSON Doc

    var tropowebapi = require('tropo-webapi');
    var sys = require('sys');

    var tropo = new tropowebapi.TropoWebAPI(); 

    tropo.say("Hello, World.");


Respond to a Tropo WebAPI Session

    * A very simple node web server that will respond to requests
    * with the Tropo WebAPI JSON version of "Hello, World!" 

    var http = require('http');
    var tropowebapi = require('tropo-webapi');

    var server = http.createServer(function (request, response) {

        // Create a new instance of the TropoWebAPI object.
        var tropo = new tropowebapi.TropoWebAPI(); 
        tropo.say("Hello, World!");

        // Render out the JSON for Tropo to consume.
        response.writeHead(200, {'Content-Type': 'application/json'});

    }).listen(8000); // Listen on port 8000 for requests.


You may run the included samples from within the tropo-webapi-node directory as follows:

    node samples/hello-word-http.js

We have also included several examples for the Express.js Node framework. This may be run from within the tropo-webapi-node library as follows:

    node samples/express/hello-world.js