Kurze Beschreibung über die REST-Schnittstelle.

generelle RESTful-URL Struktur von SipXecs:

https://host.example.com:8443/sipxconfig/rest

Ein Beispiel, wie man die Inhalte vom Phonebook sales in CSV Format ausgeben kann.

curl –insecure –basic -u superadmin [https://]{host}:8443/sipxconfig/rest/phonebook/sales

Um einen Anruf zu initialisieren:

curl –insecure -X PUT [https://]{user}:{password}@{host}:8443/sipxconfig/rest/call/{number}

Dieser HTTP PUT Aufruf zum SipXecs wird einen Anruf vom {user} zu {number} initiieren. Dafür ist die autorisierte user Berechtigung benötigt. Es funktioniert genauso wie das Click-to-Call Funktion beim User-Portal, das user’s Telefone wird zuerst klingeln und sobald es geantwortet wird, ruft es die {number} weiter an.

Um eine Anruf Weiterleitung einzustellen:

curl –insecure -X PUT [https://]{user}:{password}@{host}:8443/sipxconfig/rest/my/forward/ –data-binary @{file.xml}

Dieser HTTP PUT Aufruf benötigt noch eine XML-Datei um die Weiterleitung einzustellen. Die Datei spezifiziert die Nummer der Weiterleitung und sonstige Werte. Die Datei soll so aussehen:

<call-sequence>
<rings>
<ring>
<expiration>20</expiration>
<type>If no response</type>
<enabled>true</enabled>
<number>100</number>
</ring>
</rings>
<expiration>23</expiration>
</call-sequence>

Mit der Nutzung von HTTP GET mit dem selben URL lässt die gespeicherte Weiterleitung ausgeben.
Außerdem wird einen neuen Feld <withVoicemail> zugefügt, die Werte davon kann zu true oder false gesetzt werden für die Erlaubnis von Voicemail.

<call-sequence>
<rings>
<ring>
<expiration>20</expiration>
<type>If no response</type>
<enabled>true</enabled>
<number>100</number>
</ring>
</rings>
<expiration>23</expiration>
<withVoicemail>true</withVoicemail>
</call-sequence>

Weitere Information findet man unter: Configuration RESTful Service