Extend API Core Overview

From SwitchvoxExtendAPI

The Extend API Core Methods lets a developer perform a variety of tasks and query a ton of information from their Switchvox PBX. This may include getting a list of all the extensions on your PBX, updating a global IVR variable, or even originating a call between two numbers all through the API. To get a full list of all the methods with descriptions visit the Methods section under the Core Interface.

What exactly is the Core Interface

The Core Interface is a simple XML web service that uses digest authentication for authorization. You pass in XML requests and the Core Interface will pass back an XML response.

Connecting to the Core Interface

The Core Interface can be accessed through an easy URL:

	https://YOUR.PBX.IP/xml

Test in your Browser

To see if you can connect to your Extend Core API, just type the above URL in your browser. If have recently logged into your web admin suite then you will already have the proper cookies set and it won't prompt you for a username / password. However, if you are not logged in, then you will get the following prompt.

You are getting this prompt because the API uses digest authentication (read more about Authentication here) and the api needs to authenticate who you are. If you type in your admin name and admin password then you will be able to use all the functionality of the API. If you use an extension and password then you will be able to use all the user functionality of the API.

So after you type in a valid name and password into the popup and hit enter you will see an XML response in your browser. The XML response will most likely contain an error letting you know you that your request xml was empty, but that is fine since we were just testing for connectivity. If you didn't get any XML response you might need to check your firewall or the Access Control section on your Switchvox PBX.

Sample XML response:

Next Steps

Now that you have verified that you can connect to the Extend Core API, you can try a couple of different things.

1. Learn about Constructing_Requests Constructing Requests

2. Test sample requests and responses through a live system using our Core Test Suite

3. Read the [WGET and Extend API Tutorial.]

4. Check out our Client Libraries and start coding in your favorite programming language.