Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

URI

Methods

Formats

/phonebook

GET

Returns a list with all the phonebooks. XML: {{<?xml version="1.0" encoding="UTF-8"?>
<phonebooks><phonebook name="phonebook1"/><phonebook name="phonebook2"/></phonebooks>}}

/phonebook/{name}

GET

Returns a list with {name} phonebook entries. CSV "First name","Last name","Number"
XML

/phone

POST

Creates a phone. XML

/auto-attendant

GET

Retrieves the list of auto-attendants configured. XML, JSON

/auto-attendant/specialmode

GET
PUT
DELETE

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
DELETE

PUT - Use the attendant as special attendant; DELETE - TBD

...

URI

Methods

Formats

/my/call/{to}
/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
PUT

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
PUT
DELETE

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

/my/contact-information

GET
PUT

retrieve and change contact info for the userXML,JSON

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

GET

searching user phonebookXML

/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

/my/conferences

GET

returns a list with all conferences for a specific user (enabled, name, description, extension) XML, JSON

Future Services

User ('my') services (those are services needed to implement functionality available through current user portal)

...