Configuration Checklist

Use the checklist below to make sure you have set up all of the systems and resources you need to integrate phone features using our API. Tasks are listed in the order they should be performed.

Visual spacer

Check Off These Items Before You Start:

1. Set Up a Webserver

2. Define Settings for Your App

3. Add Phone Numbers and Extensions

4. Add Greetings and Hold Music

5. Build the Queues You Need

6. Set Routes for Your Extensions

7. Build the Menus You Need

To understand how greetings, menus, queues and routes work together, see How Do Our Features Work Together? Visual spacer


1. Set Up a Webserver

If you will be making asynchronous requests to the Phone.com API, you need to set up a webserver to receive notifications and HTTP events. If your application will receive SMS messages and phone calls you must also set up a webserver.

You may also want to set up a backup server in the event your primary webserver cannot be reached.

Learn More: Systems and Requirements | Configuring Your Application


2. Define Settings for Your App

Before making an API request, you must define settings for your application in your Phone.com API Developer account. These include URLs for your application and fallback webservers, as well as choosing the API key and API password that you will use in your API requests.

Learn More: Configuring Your Application


3. Add Phone Numbers and Extensions

To use the Phone.com API, you will need to set up one or more phone numbers to use in your application. You can also add any number of extensions to function as endpoints for your calls or SMS messages.

Note: It is important to set up extensions, as you will use them to define routing options for your phone numbers. See 6. Set Routes for Your Extensions below.

Learn More: Setting Up Phone Numbers and Extensions


4. Add Greetings and Hold Music

(Optional)

When callers reach your phone number, they should hear a greeting that presents menu options. When callers are routed to a call queue, you can also provide hold music for them to listen to while they wait for a queue member to answer. If greetings or hold music are something you anticipate needing, it is best to create and upload them before you configure queues, routes or menus.

Learn More: Managing Greetings and Hold Music | Using the API to Upload a New Greeting | API Resource: /media


5. Build the Queues You Need

(Optional)

If you want to direct callers to different departments in your organization, you need to create queues for each of those departments, adding members to the queues, and setting options for greetings, hold music, routing and call monitoring.

Learn More: Creating a New Queue Using the /queues API Service | Using Telephony Toolkit Settings to Set Up Greetings, Menus, Routes and Queues | API Resource: /queues


6. Set Routes for Your Extensions

Regardless of the kind of application you plan to build, it’s likely you will need to define routes for incoming calls and SMS messages, directing them to your app.

Learn More: Routing Calls and SMS Messages to Your Application | Creating a New Route Using the /routes API Service | API Resource: /routes


7. Build the Menus You Need

(Optional)

If you want to present callers with a greeting announcing your routing options, you need to build the menus that define those options. Menus work with greetings on the one hand, and routes on the other to direct callers to the options they select.

Learn More: Creating a New Menu Using the /menus API Service | Using Telephony Toolkit Settings to Set Up Greetings, Menus, Routes and Queues | API Resource: /menus


Learn More: