Tropo REST API - Configure & Control your Tropo Apps

After you've written a Tropo application with our Scripting or Web API, the Tropo REST API lets you configure and control those applications through the use of RESTful methods. This includes the ability to create new Tropo apps, add phone numbers to them, delete applications, and more:


Using the REST API, you can create/delete applications, add/remove addresses (phone and SMS numbers, tokens), or view available exchanges (area codes and their associated regions). This largely duplicates the features found in the Account section of this web site - but where the account section delivers a visual interface for such tasks, the Tropo REST API lets you do these things programmatically. For provisioning examples, go here.


The REST API also has the ability to fire off a session based on an external event, like when a user clicks on a link on a web site or as part of some larger work flow. Tropo uses the REST API to kick off an “outbound session” and outbound sessions are a blank slate. Your script can place a call, send an SMS or even call routines available on the Internet – like scheduling a TiVo recording. For session examples, go here.


Events allow you to inject information into the application from the outside, which is then used to interrupt a specific Tropo method or methods. The following methods can be interrupted:

    • call
    • say
    • ask
    • record
    • conference
    • transfer
    • wait

Each method can be assigned a "signal", which can then be used by the REST API to send an interrupt (both conference and transfer require the "terminator" parameter to be set in order for signaling as well). For event examples, go here

Check out "How It Works" next.