Phone API Guides

Getting Started with the Phone API

This guide is an overview of Digium Phone app development: the process of building an app, reviewing and testing it on the phone, and the basic development tools.

What You Need First

Digium Phone dedicated for development, on a trusted network

Digium Phone firmware version 1.3 or later on your phone (download)

Want to get calls in and our of your phone?  If you've not already done so, you might want to connect it to Switchvox or AsteriskNOW.

Building and Reviewing a Custom App

Browse the API Reference and the Demos sections to familarize yourself with the phone API.

Write your phone app in JavaScript.

Write your app.json file, ensuring it has all the required information.

Zip your app's JavaScript file and app.json file together, naming the zip file in a way that helps you remember what the app does. If your app uses any images or language files, put them in this zip file also.

Enable App Development on your Digium Phone.

Add your app's zip file to the phone using the phone's app development tools (web page or the CGI).

View the Debug Log to be sure you don't miss any problems. See util.debug for more information.

Start your app, and run through its features.  

Repeat as necessary. When you make changes, remember to zip the files again, upload the revised zip file, view the log, and start your app.