You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 8
Next »
At the heart of open source is customization, and at the heart of customization is Web Service APIs. Because of the variety of software languages used to build sipXcom and the number of embedded open source applications in sipXcom there are several different web service protocols and authentication schemes available.
Web APIs are typically used:
- to integrate with other systems. For example integration with a given company's internal user management system.
- to integrate with other applications. For example MS Outlook(tm) toolbar addons.
- internally inside sipXcom when two services on potentially two different servers to communicate with each other.
Having complete APIs are a very important goal of sipXcom and so their feature set expand with each new release.
List of REST APIs
You can see all REST APIs by accessing URL:
https://YOUR_SIPXECS_INSTALL/sipxconfig/api?_wadl
The returned XML will have all of the available REST calls:
<grammars/>
<resource path="/users/">...</resource>
<resource path="/my/user/">...</resource>
<resource path="/userGroups/">...</resource>
<resource path="/phones/">...</resource>
<resource path="/phoneGroups/">...</resource>
<resource path="/phones/{phoneId}/lines">...</resource>
<resource path="/ftp/">...</resource>
<resource path="/servers/">...</resource>
<resource path="/registrations/">...</resource>
<resource path="/ivr/">...</resource>
<resource path="/orbits/">...</resource>
<resource path="/pagegroups/">...</resource>
<resource path="/imbot/">...</resource>
<resource path="/restserver/">...</resource>
<resource path="/cdrs/">...</resource>
<resource path="/proxy/">...</resource>
<resource path="/registrar/">...</resource>
<resource path="/saa/">...</resource>
<resource path="/mwi/">...</resource>
<resource path="/dns/">...</resource>
<resource path="/moh/">...</resource>
<resource path="/my/moh/">...</resource>
<resource path="/my/greetings/">...</resource>
<resource path="/gateways/">...</resource>
<resource path="/schedules/">...</resource>
<resource path="/rules/">...</resource>
</resources>
</application>
The following is the older Web Service API Doc needs to be converted to Wiki Format (each section a new page?)
Download current Web Service API Doc
Tried importing the Word doc and it was a bit of a mess with respect to headers.