Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration; user services table formatted + minor changes || added activegreeting rest info

...

General URL structure

Common prefix:

Panel

{{

noformat

No Format
nopaneltrue
https://host.example.com:8443/sipxconfig/rest

}}

Note: how to see inside the SSL with Wireshark is described here SipX_ConfigServer_Troubleshooting#Using_Wireshark_to_see_inside_the_box

...

Accessible for all users:URIMethodsFormats|

URI

...

panel PUT panel

/my/forward | GETPUT |

/my/phonebook |

/my/phonebook/entry/{entryId} | GETPUTDELETE |

/my/contact-information | GETPUT |

/my/search/phonebook?query={search-term} |

Methods

Formats

/my/call/{to}
/call/{to}

Panel

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.

Panel

 

 

panel

/my/voicemail/pin/{pin}

|

PUT

|

changes user voicemail PIN

|

 

 

Panel

GET
PUT

retrieves (GET) or changes (PUT) user call forwardingXML,JSON

Panel

 

 

panel

/my/feed/voicemail/{folder}

|

GET

|

voicemail folder presented as RSS feed

|

 

 

Panel

GET |

JSON, XMLphonebook representation

 

 

 

Panel

GET
PUT
DELETE

retrieves (GET), changes (PUT) and deletes (DELETE) entries in private phonebookXMLJSONpanel

 

 

Panel

GET
PUT

retrieve and change contact info for the userXML,JSON

Panel

 

 

Panel

GET |

searching user phonebookXML

Panel

 

 

/my/mailbox/{user}/preferences/activegreeting
/my/mailbox/{user}/preferences/activegreeting/{greeting}

GET
PUT

retrieves and sets active greeting setting for a specific user
GET: XML, plain text (one of none, standard, outofoffice, extendedabsence)
PUT: plain text (one of none, standard, outofoffice, extendedabsence); an error 500 will be returned if the greeting is not one of the 4 strings

Adding new Services

sipXconfig used the RESTlet API to add RESTful services

...