Overview

The Tropo REST API allows you to configure & control your Tropo applications. There are three types of activities you can do with the REST API.

Provisioning

Using the Applications, Addresses, and Exchanges APIs 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 programmatically provision applications and numbers.

Sessions

The Sessions API is used to start a Tropo 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.

Signals

The Signals API allows you to send Events to your running Tropo sessions, injecting 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).