General URL structure
Common prefix:
| Panel | ||||||
|---|---|---|---|---|---|---|
|
Testing the services
Here is an example of how to print the content of a phonebook named sales to stdout in CSV format
| Panel |
|---|
curl --insecure --basic -u superadmin [https://]{host}:8443/sipxconfig/rest/phonebook/sales |
...
| Panel |
|---|
curl --insecure -X PUT [https://]{user}:{password}@{host}:8443/sipxconfig/rest/call/{number} |
...
| Panel |
|---|
curl --insecure -X PUT [https://]{user}:{password}@{host}:8443/sipxconfig/rest/my/forward/ --data-binary @{file.xml} |
HTTP PUT to service URL will cause sipXconfig to place a callforward to a number with specs in the xml file.
A xml file should look like:
| Panel |
|---|
<call-sequence> |
HTTP GET to service URL will return the saved callforwarding scheme. In addition, a new field is added: <withVoicemail>
The value of this field is true if the user voicemail permission is set to true, false if voicemail permission is set to false
| Panel |
|---|
<call-sequence> |
...
URI | Methods | Formats |
|---|---|---|
/phonebook | GET | Returns a list with all the phonebooks. XML: {{<?xml version="1.0" encoding="UTF-8"?> |
/phonebook/{name} | GET | Returns a list with {name} phonebook entries. CSV |
/phone | POST | Creates a phone. XML |
/auto-attendant | GET | |
/auto-attendant/specialmode | GET | GET retrieves the use the special auto attendant status(true/false). PUT will set it to true, DELETE will set it to false. XML, JSON |
/auto-attendant/{attendant}/special | PUT | PUT - Use the attendant as special attendant; DELETE - TBD |
| /activecdrs/{user} | GET | GET - Retrieve active calls for given user, sample output <cdrs> |
User services
Accessible for all users:
URI | Methods | Formats |
|---|---|---|
/my/call/{to} | PUT | Initiates the call from the user to {to} address.PUT method requires non empty body which is ignored.Supported as GET for clients that do not handle PUT. |
/my/voicemail/pin/{pin} | PUT | changes user voicemail PIN |
/my/forward | GET | retrieves (GET) or changes (PUT) user call forwardingXML,JSON |
/my/feed/voicemail/{folder} | GET | voicemail folder presented as RSS feed |
/my/phonebook | GET | JSON, XMLphonebook representation |
/my/phonebook/entry/{entryId} | GET | retrieves (GET), changes (PUT) and deletes (DELETE) entries in private phonebookXMLJSON |
/my/contact-information | GET | |
/my/search/phonebook?query={search-term} | GET | searching user phonebookXML |
/my/mailbox/{user}/preferences/activegreeting | GET | retrieves and sets active greeting setting for a specific user |
/my/conferences | GET | returns a list with all conferences for a specific user |
/my/activecdrs | GET | returns a list with all active calls (ongoing) for a specific user in XML or JSON format |
/my/logindetails | GET | returns username and im ID for a specific user in XML or JSON format. To be used when alias is provided in authentication details |
Sample php Click to Call Code:
| Code Block |
|---|
<?php
$to="101"; //Number to dial
$from="5001"; //userid in sipx
$pass="1234"; //sipx pin (NOT SIP password)
//replace sipx.gcgov.local with your sipx server
$url = "http://sipx.gcgov.local:6667/callcontroller/".$from."/".$to."?isForwardingAllowed=true";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, $from.":".$pass);
$result = curl_exec($ch);
curl_close($ch);
?>
|
...