Page History

...

Resource URI: /my/forward
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves user call forwarding XML, JSON (without schedule)
HTTP Method: PUT
Modifies user call forwarding XML, JSON (without schedule)
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/callfwd
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves user call forwarding scheme, with the schedule.
Example: XML format
<callsequence>
<rings>
<ring>
<expiration>30</expiration>
<type>If no response</type>
<enabled>true</enabled>
<number>333</number>
</ring>
<ring>
<expiration>30</expiration>
<type>At the same time</type>
<enabled>true</enabled>
<number>232</number>
</ring>
</rings>
<expiration>20</expiration>
<withVoicemail>true</withVoicemail>
</callsequence>
JSON format
{"callsequence": {

...

{
"expiration": 30,
"type": "If no response",
"enabled": true,
"number": "333"
},
{
"expiration": 30,
"type": "At the same time",
"enabled": true,
"number": "232"
}
],
"expiration": 20,
"withVoicemail": true
}}
HTTP Method: PUT
Modifies user call forwarding scheme.

curl -v -k -X PUT -H "Content-Type: application/json" -d '{"expiration":20,"rings":[{"expiration":30,"type":"If no response","enabled":true,"number":"5551212"}]}' https://201:password@192.168.1.14/sipxconfig/rest/my/callfwd

Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/callfwdsched
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes:
Error 422 (When schedule save/update failed)
Error 403 (on PUT or DELETE and id not specified)
HTTP Method: GET
Retrieves call forwarding schedules
Example for GET/PUT: JSON format only

...

Resource URI: /my/callfwdsched/{id}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves call forwarding schedules
Example: JSON format only
id=3

...

Resource URI: /my/activecdrs
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves user active calls in XML or JSON format
Example: XML format
<cdrs>
<cdr>
<from>2011</from>
<from-aor>"2011" <sip:2011@Uniteme.ezuce.com></from-aor>
<to>32011</to>
<to-aor><sip:32011@Uniteme.ezuce.com></to-aor>
<direction>INCOMING</direction>
<recipient>32011</recipient>
<internal>false</internal>
<type>Unknown</type>
<start-time>1400239363000</start-time>
<duration>45976</duration>
</cdr>
</cdrs>scheduledDay":7}],"scheduleId":3,"name":"Sunday"}
JSON format

...

Resource URI: /my/voicemail/pin/{pin}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: Error 400 - on PUT, when the new {pin} cannot be saved
HTTP Method: GET
Retrieves call forwarding schedules
Example: JSON format only
id=3

...

Resource URI: /my/vmprefs
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves call forwarding schedules.
Example: JSON format only for GET/PUT
{"voicemailPermission":true,"emailFormat":"FULL","altEmailFormat":null,"greeting":"STANDARD","emailAttachType":"YES","emailIncludeAudioAttachment":true,"altEmail":null,"altEmailAttachType":null,"altEmailIncludeAudioAttachment":false,"email":"aaa@bbb"}
HTTP Method: PUT
Saves user voicemail settings
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/voicemail/attendant
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves the personals' attandant settings
Example: JSON format only for GET/PUT
{
"personalAttendantPermission":true,
"language":null,
"operator":null,
"menu":{},
"overrideLanguage":false,
"depositVM":true,
"playVMDefaultOptions":true
}
HTTP Method: PUT
Updates the personal attendants' settings
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/phonebook
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Status Values:
Specific Response Codes:
HTTP Method: GET
Retrieves the personals' attandant settings
Example: XML format
<phonebook>
<entry>
<first-name>John</first-name>
<last-name>Smith</last-name>
<number>200</number>
<contact-information>
<homeAddress/>
<officeAddress/>
<imId>jhons</imId>
<imDisplayName>John Smith</imDisplayName>
<avatar>
https://john.work-ezuce.ro/sipxconfig/rest/avatar/200
</avatar>
</contact-information>
</entry>
<entry>
<first-name>Mike</first-name>
<last-name>Doe</last-name>
<number>201</number>
<contact-information>
<homeAddress/>
<officeAddress/>
<imId>miked</imId>
<imDisplayName>Mike Doe</imDisplayName>
<avatar>
https://mike.work-ezuce.ro/sipxconfig/rest/avatar/201
</avatar>
</contact-information>
</entry>
</phonebook>u
JSON format

...

Resource URI: /my/pagedphonebook?start={start-row}&end={end-row}"
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Phonebook representation, page by page, returns users from start-row to end-row. Useful for large size phonebooks (thousands of users)
Example: XML format
<phonebook>
<size>5</size>
<filtered-size>5</filtered-size>
<start-row>1</start-row>
<end-row>2</end-row>
<show-on-phone>n/a</show-on-phone>
<google-domain>gmail.com</google-domain>
<entries>
<entry>
<id>-1</id>
<first-name>John</first-name>
<last-name>Smith</last-name>
<number>201</number>
<contact-information>
<homeAddress/>
<officeAddress/>
<imId>georgen</imId>
<imDisplayName>John Smith</imDisplayName>
<avatar>
https://john.work-ezuce.ro/sipxconfig/rest/avatar/201
</avatar>
</contact-information>
</entry>
</entries>
</phonebook>
JSON format
{"phonebook": {
"size": 1,
"filteredsize": 1,
"startrow": 0,
"endrow": 1,
"showonphone": "n/a",
"googledomain": "gmail.com",

...

Resource URI: /my/phonebook/entry/{entryId}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: Error 747 - when entryId is duplicated during save (POST)
HTTP Method: GET
Retrieves all the entries from the private phone book.
HTTP Method: PUT
Changes entries in private phone book
<entry>
<firstname>name</firstname>
<lastname>lastName</lastname>
<number>200</number>
<contactinformation>
<jobTitle>title</jobTitle>
<companyName>company</companyName>
<homeAddress>
<street>street</street>
</homeAddress>
<officeAddress>
<zip>1234</zip>
</officeAddress>
</contactinformation>
</entry>
Example JSON
{"entry": {
"firstname": "name",
"lastname": "lastName",
"number": "200",
"contactinformation": {
"jobTitle": "title",
"companyName": "company",
"homeAddress": {
"street": "street"
},
"officeAddress": {
"zip": "1234"
}
}
}}
HTTP: POST
Ceates a new phone book entry.
HTTP Method: DELETE
Deletes the entriy with the specified ID from the private phone book .
Unsupported HTTP Method: N/A

...

Resource URI: /my/search/phonebook?query={search-term}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Searches through all the information in the phone book. A search-term can be a value of any user field like first name, last name, extension etc
Example: XML format
<phonebook>
<entry>
<first-name>FirstName1</first-name>
<last-name>LastName1</last-name>
<number>200</number>
<contact-information/>
</entry>
<entry>
<first-name>FirstName2</first-name>
<last-name>LastName2</last-name>
<number>201</number>
<contact-information/>
</entry>
</phonebook>
JSON format

...

Resource URI: /my/contact-information
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves the entries from the private phone book
Example: XML format
<contact-information>
 <jobTitle>Data Entry Assistant</jobTitle>
 <jobDept>Data Management Services</jobDept>
 <companyName>Museum of Science</companyName>
 <homeAddress>
   <city>NY</city>
 </homeAddress>
 <officeAddress>
   <street>1 Science Park</street>
   <city>Boston</city>
   <country>US</country>
   <state>MA</state>
   <zip>02114</zip>
 </officeAddress>
 <branchAddress/>
 <imId>myId</imId>
 <imDisplayName>myId</imDisplayName>
 <emailAddress>john.doe@example.com</emailAddress>
 <useBranchAddress>false</useBranchAddress>
 <salutation>Prof</salutation>
 <twiterName>Twitter</twiterName>
 <linkedinName>Linkedin</linkedinName>
 <facebookName>Facebook</facebookName>
 <xingName>Xing</xingName>
 <timestamp>0</timestamp>
 <enabled>true</enabled>
 <ldapManaged>false</ldapManaged>
 <firstName>John</firstName>
 <lastName>Doe</lastName>
</contact-information>
JSON format:
{"contact-information": {
 "jobTitle": "Data Entry Assistant",
 "jobDept": "Data Management Services",
 "companyName": "Museum of Science",
 "homeAddress": {
   "city": "NY"
 },
 "officeAddress": {
   "street": "1 Science Park",
   "city": "Boston",
   "country": "US",
   "state": "MA",
   "zip": "02114"
 },
 "branchAddress": {},
 "imId": "myId",
 "imDisplayName": "myId",
 "emailAddress": "john.doe@example.com",
 "useBranchAddress": false,
 "salutation": "Prof",
 "twiterName": "Twitter",
 "linkedinName": "Linkedin",
 "facebookName": "Facebook",
 "xingName": "Xing",
 "timestamp": 0,
 "enabled": true,
 "ldapManaged": false,
 "firstName": "John",
 "lastName": "Doe"
}}
HTTP Method: PUT
Updates user contact details.
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/im/prefs
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Status Values:
Specific Response Codes:
HTTP Method: GET
Rertrieves instant messaging preferences
Example: JSON for GET/PUT
{"statusCallInfo":false,"otpMessage":"Onthe phone","voicemailOnDnd":true,"statusPhonePresence":true}
Return Values: list of settings for IM
HTTP Method: PUT
Saves the modified IM preferences
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/imbot/prefs
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Status Values:
Specific Response Codes:
HTTP Method: GET
Rertrieves My Buddypreferences
Example: JSON for GET/PUT
{"confExit":true,"vmBegin":true,"vmEnd":true,"confEnter":true}
HTTP Method: PUT
Saves the modified IM preferences
Return Values: list of settings for My Buddy
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/speeddial
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Return Values: N/A
Status Values: list of settings for the speed dial functionality
Specific Response Codes:
HTTP Method: GET
Rertrieves the speed dial preferences
Example: JSON for GET/PUT

...

Resource URI: /my/conferences
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Status Values: list with all conferences for a specific user
Specific Response Codes:
HTTP Method: GET
Returns a list with all conferences for a specific user (enabled, name, description, extension)
Example: XML format
<conferences>
<conference>
<enabled>true</enabled>
<name>myConf</name>
<description>description</description>
<extension>22123</extension>
<accessCode>555</accessCode>
</conference>
</conferences>
JSON format

...

Resource URI: /my/conferencedetails/{confName}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes:
Error 404 - when {confName} not found
Error 403 - when authenticated user is not owner of {confName}
Error 406 - when {confName} is found but not active (no participant in conference)
HTTP Method: GET
Returns conference details including members and details about members that are participants in conference XML, JSON
If the 'confName' does not exist or the conference is not active (no participants) then an error is returned
Example: XML format
<conference>
<extension>555</extension>
<description>desc</description>
<locked>false</locked>
<members>
<member>
<id>1</id>
<name>200</name>
<imId>200im</imId>
<uuid>33ee33ee</uuid>
<volumeIn>0</volumeIn>
<volumeOut>0</volumeOut>
<energyLevel>30</energyLevel>
<canHear>true</canHear>
<canSpeak>true</canSpeak>
</member>
<member>
<id>1</id>
<name>201</name>
<imId>201im</imId>
<uuid>333eee333</uuid>
<volumeIn>0</volumeIn>
<volumeOut>0</volumeOut>
<energyLevel>30</energyLevel>
<canHear>true</canHear>
<canSpeak>false</canSpeak>
</member>
</members>
</conference>
JSON format
{"conference": {
"extension": "555",
"description": "desc",
"locked": false,

...

Resource URI: /my/conferences/
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes:
HTTP Method: GET
Gets user conferences settings for all user owned conferences
Example: XML format
<conferences>
<conference>
<enabled>true</enabled>
<name>myConf</name>
<description>description</description>
<extension>22123</extension>
<accessCode>555</accessCode>
</conference>
</conferences>
JSON format

...

Resource URI: /my/conferences/{name}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Status Values: N/A
Specific Response Codes: N/A
HTTP Method: GET
gets user conference details given conference name 'name'
Example: XML format for GET/PUT
<setting>
<enabled>true</enabled>
<name>MirceaConf</name>
<autorecorded>true</autorecorded>
<quickstart>true</quickstart>
<video>false</video>
<sendActiveVideoOnly>false</sendActiveVideoOnly>
<maxMembers>0</maxMembers>
<moh>FILES_SRC</moh>
<moderatedRoom>false</moderatedRoom>
<publicRoom>true</publicRoom>
</setting>
Example: JSON format for GET/PUT
{"setting": {
"enabled": true,
"name": "MirceaConf",
"autorecorded": true,
"quickstart": true,
"video": false,
"sendActiveVideoOnly": false,
"maxMembers": 0,
"moh": "FILES_SRC",
"moderatedRoom": false,
"publicRoom": true
}}
HTTP Method: PUT
Saves user conference details given conference name 'name'
Unsupported HTTP Method: POST, DELETE

...

Resource URI: /my/faxprefs
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Gets user fax extension and Direct Inward Dialing (DID) number.
Example: JSON
{"extension":"454","did":"66"}
HTTP Method: PUT
Saves user conference details given conference name 'name'
Unsupported HTTP Method: PUT, POST, DELETE

...

Resource URI: /my/logindetails
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves login detail
Example: XML format
<login-details>
<userName>200</userName>
<imId>mirceac</imId>
<ldapImAuth>false</ldapImAuth>
<sipPassword>GQjEXWCbU2hQ</sipPassword>
</login-details>
JSON format
{"login-details": {
"userName": "200",
"imId": "mirceac",
"ldapImAuth": false,
"sipPassword": "GQjEXWCbU2hQ"
}}
Unsupported HTTP Method: PUT, POST, DELETE

...

Resource URI: /my/faxprefs
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Return Values: list with details
Status Values: N/A
Specific Response Codes:
HTTP Method: GET
Retrieves login details as above and in addition user entered password and host names where instant messaging server is running (Uniteme only).
Example: XML format
<login-details>
<userName>200</userName>
<imId>mirceac</imId>
<ldapImAuth>false</ldapImAuth>
<sipPassword>GQjEXWCbU2hQ</sipPassword>
<pin>11111111</pin>
<im-locations>
<im-location>
<fqdn>mircea.work-ezuce.ro</fqdn>
</im-location>
</im-locations>
</login-details>
JSON format
{"login-details": {
"userName": "200",
"imId": "mirceac",
"ldapImAuth": false,
"sipPassword": "GQjEXWCbU2hQ",
"pin": "11111111",

...