Get Started

Not sure where to begin? You came to the right page.

What is Switchvox?

Switchvox is an IP PBX phone system for small and medium businesses. Switchvox is easy to use, full of helpful features, and costs less than a traditional PBX. And of course it includes Switchvox Extend, a toolset that lets you integrate Switchvox with your other business applications.

Go to the Switchvox Website...

The Switchvox Extend toolset lets you integrate your Switchvox IP PBX with Web-based applications, so you can build a whole new level of communication services for your business.


What comes first?

Before diving into code samples, here are some things to consider:

What do you want to build?

It helps to have a plan. What is your application going to do? Are you putting a click-to-call button on your website? Integrating Switchvox with your product database so you can provide better customer service? Whatever you decide to do, take the time to think it through.

Which tools should you use?

Switchvox Extend is a set of tools that let you interact with Switchvox and your callers. You may want to use one or all of these tools, depending on what you are trying to accomplish. Check out the Wiki's overview of each tool:

XML API

IVR-Web Integration

Event Notifications

Switchboard Panels

Do you have the experience you need?

The Switchvox Extend toolset lets you integrate Switchvox with your applications. To do that, you are going to need a moderate level of software development experience, and of course you will need to manage your own applications. Our tools will be easy to use if you have already done Web-based software development, and are familiar with a common language such as

PERL

PHP

Ruby

JavaScript

Python

C#

Did someone already write code that you can use?

Check out the Client Libraries; we've already done some of the work! Or, there may be a tutorial that explains something similar to what you are doing, that might save you some time. And, you can always use the Forums to see if other developers are thinking about the same things that you are.



What Next?

Now that you know what you're doing, what else do you need? Everyone has their own software development practices, but there are some issues to keep in mind when you are working with Switchvox:

Make good use of the Test Suite.

The Test Suite creates a request and collects a response for each of the Extend API method calls. You can choose to work in XML or JSON, and you can send the requests to our demo Switchvox or to your own Switchvox.

Include a version number on your API calls, and be sure that you are running the latest version of the Switchvox PBX software.

For details on versioning your API calls, see the wiki page Constructing Requests. To update your Switchvox PBX software, go to Machine Admin > Updates in the Admin Tool Suite, and apply any updates that are available.

Handle network access and permissions issues.

Your application and Switchvox need to be able to communicate. If you want to exchange files, you'll need to correctly set up file transfers and permissions. Be sure that the Switchvox Access Control lets your application have access to the Admin and/or User API services.

Tell us about your Switchvox Application!

We'd really like to hear about what you're doing. Tell us how Switchvox Extend let you improve your customer service, or automate a business process, or just add some fun to your day!