Skip to end of metadata
Go to start of metadata
  1. Several configuration APIs allow you to manage the system, users, devices and features.

Configuration APIs exist in both SOAP and REST protocol formats and are mutually exclusive of each other. It is however possible to use both formats in conjunction depending on what you are aiming to achieve.
Not all of what is available from the Configuration Administration Web interface or the User Web Portal is available for extensions using web services. If an API does not exist, you have the possibility to create one to suit your needs.
If expanding the API is not an option for you and you need access to certain functionality, sipXecs offers you the possibility to manage that. The majority of the administration and user interfaces in sipXecs have unit tests that automate link clicks, form submissions and button presses using a standard HTML parsing library. Most programming languages have similar libraries often based on the cURL package (for example: php_curl). This method does not require you to find a parsing library that interprets JavaScript.
In addition, the HTML that is returned makes common use of the HTML ID attribute to uniquely identifiable key parts of the page to the unit tests. These same IDs can be found by XPath or even XML DOM navigation parsing libraries fairly easily.
If you decide to go this route, consider expanding on the Web Service APIs as well and submitting your changes back to sipXecs upstream. Web pages are subject to change and do not constitute a stable API like the Web Service APIs would.
The result of the queries are description in JSON and/or XML format.

3.1 Configuration REST API

The configuration APIs based on a REST design are:

  • Administration services, available to users with administration rights.
  • User services, available to all users.

3.1.1 Administration Services

The following resources for the Configuration API are only available for users with administration rights:

  • Phonebook
  • Phone
  • Auto Attendant (AA)
  • User
  • Permissions
  • Branch
  • User Groups

The following resources for the Configuration API are available starting with V14.10:

  • Gateways
  • IVR
  • DNS
  • Message Waiting Indication (MWI)
  • Phone Groups
  • Music on Hold (MOH)
  • Registrations
  • Page groups
  • Park orbit
  • Call Data Record (CDR)
  • Proxy
  • My buddy
  • Registrar










Phone Book

View list of phone books

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

Property

Description

Phone books

The phone book name.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves a list with all the phone books saved in the database.
Example: XML format
{{<phonebooks>
<phonebook name="phonebook1"/>
<phonebook name="phonebook2"/>
</phonebooks>}}
Unsupported HTTP Methods: POST, PUT, DELETE

View phone book entries

Resource URI: /phonebook/{name}
Default Resource Properties:

Property

Description

first name

First name of the phone book entry.

last Name

Last name of the phone book entry.

number

Number associated to the phone book entry.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves a list with all the phone book entries saved in the database.
Example: CSV format
"First name","Last name","Number"
Return Values: list with the names of the phone book entries
Unsupported HTTP Methods: POST, PUT, DELETE

Phone

Create a phone

Resource URI: /phones
Default Resource Properties:

Property

Description

serialNumber

The serial number of the phone.

model

Phone model.

description

Short description provided by the user.

Specific Response Codes: N/A
HTTP Method: GET
Examples: XML format
<phones>
<phone>
<serialNumber>000000c0ffee</serialNumber>
<model>testPhoneModel</model>"<description>Phone 1 - YES</description>
</phone>
<phone>
<serialNumber>000000c0ffee</serialNumber>
<model>testPhoneModel</model>"
<description>NO - duplicate serial number</description> </phone>
</phones>
JSON format
{
"phones": {

"phone": [


{
"serialNumber": "000000c0ffea",
"model": "testPhoneModel",
"description": "Phone 1 - YES"
},
{
"serialNumber": "000000c0ffeb",
"model": "testPhoneModel",
"description": "NO - duplicate serial number"
}
]}
}
HTTP Method: POST
Creates a new phone.
Unsupported HTTP Methods: PUT, DELETE

Retrieve phone profile

Resource URI: /phones/{serialNumber}/profile/{name}
Default Resource Properties: N/A
Specific Response Codes: Error 404 when {serialNumber} or {name} not found.
HTTP Method: GET
Retrieves phone profile representation given phone serial number and file name
Unsupported HTTP Methods: POST, PUT, DELETE

View phone models

Available in 14 starting with 14.10

  1. Resource URI: /phones/models
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. modelId
                1. Model unique identification number
    1. label

    Model label.

  4. Filtering Parameters:
    1. Parameter
    1. Description
    1. page
    1. Required. The requested page size
    1. pagesize
    1. Required. The number of results to be displayed per page.
    1. sortdir
    1. Optional. Forward/reverse
    1. sortby
    1. Optional. Name/description
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list with all the phone models available in the system.
        1. Example: XML format
  8. <Models><Model><modelId>SPA501G</modelId><label>Cisco SPA501G</label></Model><Model><modelId>SPA502G</modelId><label>Cisco SPA502G</label></Model><Models>
    1. JSON format
  9. {"models":[{"modelId":"SPA501G","label":"Cisco SPA501G","vendor":null,"versions":null},{"modelId":"SPA502G","label":"Cisco SPA502G","vendor":null,"versions":null}]}

  10. HTTP Method: PUT

Updates the settings of the gateway. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the gateway.

  1. Unsupported HTTP Method: POST

View or create a phone

Available in 14 starting with 14.10

  1. Resource URI: /phones
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. ID

    Phone unique identification number.

    1. serialNo

    Phone serial number.

    1. description

    Short description provided by the user.

    1. label

    Label of the phone model.

    1. vendor

    Vendor of the phone model.

    1. lines

    Lines associated with the phone ID.

    1. ID

    Model unique identification number.

    1. uri

    The URI for the OpenUC instance.

    1. user

    User name.

    1. userID

    User unique identification number.

    1. displayName

    The display name for the user.

    1. password

    The password associated with the user.

    1. registrationServer

    Name of the registration server.

    1. lines

    Lines associated with the model ID.

    1. id

    Group ID.

    1. name

    Name of the group.

    1. description

    Short description provided by the user.

    1. weight

     

  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieves all phones.
        1. Example: XML format
  7. ><Phones>
  8. <Phone>
  9. <id>1</id>
  10. <serialNo>111111111111</serialNo>
  11. <description>desc</description>
  12. <Model>
  13. <modelId>counterpathCMCEnterprise
  14. </modelId>
  15. <label>Bria 3.x</label>
  16. <vendor>Counterpath</vendor>
  17. </Model><Lines><Line><id>1</id>
  18. <uri>"banaanab"<sip:200@workezuce.ro></uri>
  19. <user>200</user>
  20. <userId>200</userId>
  21. <displayName>bana anab</displayName>
  22. <password>123</password>
  23. <registrationServer>work-ezuce.ro</registrationServer>
  24. </Line></Lines>
  25. <Groups><Group>
  26. <id>13</id>
  27. <name>bria</name>
  28. <description>desc</description>
  29. <weight>3</weight>
  30. </Group></Groups>
  31. </Phone></Phones>
    1. JSON format
  32. {"phones":[{"id":1,"serialNo":"111111111111","deviceVersion":null,"description":"desc","model":{"modelId":"counterpathCMCEnterprise","label":"Bria 3.x","vendor":"Counterpath","versions":null},"lines":[{"id":1,"uri":"\"bana anab\"<sip:200@work-ezuce.ro>","user":"200","userId":"200","extension":null,"displayName":"bana anab","password":"123","registrationServer":"work-ezuce.ro","registrationServerPort":null,"voicemail":null}],"groups":[{"id":13,"name":"bria","description":"desc","weight":3,"count":null}]}]}

  33. HTTP Method: POST
  34. Creates a new phone.
  35. Unsupported HTTP Method: PUT, DELETE


View or modify a phone

Available in 14 starting with 14.10

  1. Resource URI: /phones/{phoneId}
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. Phone
    1. The phones related information is similar to the one described under /phones and phones/models
  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieve details for the phone with the specified phone ID or MAC.
        1. Example: XML format
  7. <Phone>
  8. <id>6</id>
  9. <serialNo>0004f26ad217</serialNo>
  10. <deviceVersion>polycom4.1.5</deviceVersion>
  11. <description>Auto-provisioned ID: F58 Version: 5.1.1.2990</description>
  12. <Model>
  13. <modelId>polycomVVX600</modelId>
  14. <label>Polycom VVX 600</label>
  15. <vendor>Polycom</vendor>
  16. <Versions>
  17. <Version>polycom4.1.X</Version>
  18. <Version>polycom4.1.2</Version>
  19. <Version>polycom4.1.3</Version>
  20. <Version>polycom4.1.5</Version>
  21. <Version>polycom4.1.6</Version>
  22. <Version>polycom5.0.0</Version>
  23. <Version>polycom5.0.1</Version>
  24. <Version>polycom5.0.2</Version>
  25. </Versions>
  26. </Model>
  27. <Lines>
  28. <Line>
  29. <id>9</id>
  30. <uri>sip:300@dlu.ezuce.ro</uri>
  31. <user>300</user>
  32. <userId>300</userId>
  33. <password>123</password>
  34. <registrationServer>dluca.ezuce.ro</registrationServer>
  35. <registrationServerPort>0</registrationServerPort>
  36. </Line>
  37. </Lines>
  38. </Phone>
    1. JSON format
  39. {
  40. id: 6
  41. serialNo: "0004f26ad217"
  42. deviceVersion: "polycom4.1.5"
  43. description: "Auto-provisioned ID: F58 Version: 5.1.1.2990 "
  44. model: {
  45. modelId: "polycomVVX600"
  46. label: "Polycom VVX 600"
  47. vendor: "Polycom"
  48. versions: [8]

  49. 0: "polycom4.1.X"
  50. 1: "polycom4.1.2"
  51. 2: "polycom4.1.3"
  52. 3: "polycom4.1.5"
  53. 4: "polycom4.1.6"
  54. 5: "polycom5.0.0"
  55. 6: "polycom5.0.1"
  56. 7: "polycom5.0.2"
  57. -
  58. }-
  59. lines: [1]

  60. 0: {
  61. id: 9
  62. uri: "sip:300@dlu.ezuce.ro"
  63. user: "300"
  64. userId: "300"
  65. extension: null
  66. displayName: null
  67. password: "123"
  68. registrationServer: "dlu.ezuce.ro"
  69. registrationServerPort: "0"
  70. voicemail: null
  71. }-
  72. -
  73. groups: null
  74. }
  75. HTTP Method: PUT
  76. Modify the phone with the specified phone ID or MAC.
  77. HTTP Method: DELETE
  78. Delete the phone with the specified phone ID or MAC.
  79. Unsupported HTTP Method: POST


View or delete phones from groups

Available in 14 starting with 14.10

  1. Resource URI: /phones/{phoneId}/groups
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. id
    1. Group unique identification number.
    1. name

    Group name.

    1. description

    Short description provided by the user.

    1. weight

     

  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieve the group/s for the specified phone ID.
        1. Example: XML format
  7. <Groups>
  8. <Group>
  9. <id>7</id>
  10. <name>SSComm</name>
  11. <description>desc</description>
  12. <weight>2</weight>
  13. </Group>
  14. </Groups>
    1. JSON format
  15. {
  16. groups: [1]

  17. 0: {
  18. id: 7
  19. name: "SSComm"
  20. description: "desc"
  21. weight: 2
  22. count: null
  23. }-
  24. -
  25. }
  26. HTTP Method: DELETE
  27. Delete the groups for the specified phone ID.
  28. Unsupported HTTP Method: POST, PUT


Delete or add phones in groups

Available in 14 starting with 14.10

  1. Resource URI: /phones/{phoneId}/groups/{groupName}
  2. Default Resource Properties: N/A
  3. Specific Response Codes: N/A
  4. HTTP Method: POST
  5. Add a phone in the specified group name.
        1. Example: N/A
  6. HTTP Method: DELETE
  7. Delete a phone from the specified group name.
  8. Unsupported HTTP Method: GET, PUT


View group settings

Available in 14 starting with 14.10

  1. Resource URI: /phones/{phoneId}/settings/{settingPath}
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
                  1. Setting path.
    1. type

    Setting type. Possible values are string or boolean.

    1. value

     

    1. defaultValue

    Default value.

    1. label

    Label setting.

    1. description

    Short description provided by the user.

  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieve the setting or settings from the group from the specified path.
        1. Example: XML format
  7. <Setting>
  8. <path>lcl/datetime/date.format</path>
  9. <type>string</type>
  10. <value>D,Md</value>
  11. <defaultValue>D,Md</defaultValue>
  12. <label>Format</label>
  13. <description>Controls the format of the date string (D = day of week, d = day of the month, M = month), e.g. D,dM = "Thursday, 3 July" or "Md,D = July 3, Thursday". The field may contain 0, 1 or 2 commas, which can occur only between characters and only one at a time i.e. 'D,,dM' is illegal.</description>
  14. </Setting>
    1. JSON format
  15. {
  16. path: "lcl/datetime/date.format"
  17. type: "string"
  18. options: null
  19. value: "D,Md"
  20. defaultValue: "D,Md"
  21. label: "Format"
  22. description: "Controls the format of the date string (D = day of week, d = day of the month, M = month), e.g. D,dM = "Thursday, 3 July" or "Md,D = July 3, Thursday". The field may contain 0, 1 or 2 commas, which can occur only between characters and only one at a time i.e. 'D,,dM' is illegal."
  23. }
  24. HTTP Method: PUT
  25. Update the setting or settings from the group from the specified path.
  26. HTTP Method: DELETE
  27. Delete the setting or settings from the group from the specified path.
  28. Unsupported HTTP Method: POST


Delete or add lines to a phone ID

Available in 14 starting with 14.10

  1. Resource URI: /phones/{phoneId}/lines
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. id
      1. Line unique identification number
    1. uri

    URI for the line

    1. user

    User name.

    1. userId

    User unique identification number.

    1. password

    User password.

    1. registrationServer

    Name of the registration server.

    1. registrationServerPort

    Number of the registration server port.

  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieve the lines for the phone with the specified ID.
        1. Example: XML format
  7. <Lines>
  8. <Line>
  9. <id>9</id>
  10. <uri>sip:300@dlu.ezuce.ro</uri>
  11. <user>300</user>
  12. <userId>300</userId>
  13. <password>123</password>
  14. <registrationServer>dlu.ezuce.ro</registrationServer>
  15. <registrationServerPort>0</registrationServerPort>
  16. </Line>
  17. </Lines>
    1. JSON format
  18. {
  19. lines: [1]

  20. 0: {
  21. id: 9
  22. uri: "sip:300@dluca.ezuce.ro"
  23. user: "300"
  24. userId: "300"
  25. extension: null
  26. displayName: null
  27. password: "123"
  28. registrationServer: "dluca.ezuce.ro"
  29. registrationServerPort: "0"
  30. voicemail: null
  31. }-
  32. -
  33. }
  34. HTTP Method: POST
  35. Add a new line for the phone with the specified ID.
  36. HTTP Method: DELETE
  37. Delete the setting or settings from the group from the specified path.
  38. Unsupported HTTP Method: PUT


View or modify group settings

Available in 14 starting with 14.10

  1. Resource URI: /phones/{phoneId}/lines/{lineId}/settings/{settingPath}
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
      1. Setting path.
    1. type

    Setting type.

    1. description

    Short description provided by the user.

  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieve the group setting or settings, from the specified path.
        1. Example: XML format
  7. <Setting>
  8. <path>line-dialplan/digitmap/digitmap</path>
  9. <type>string</type>
  10. <description>When present, this attribute overrides the global dial plan defined Phone's Dial Plan settings</description>
  11. </Setting>
    1. JSON format
  12. {
  13. path: "line-dialplan/digitmap/digitmap"
  14. type: "string"
  15. options: null
  16. value: null
  17. defaultValue: null
  18. label: null
  19. description: "When present, this attribute overrides the global dial plan defined Phone's Dial Plan settings"
  20. }
  21. HTTP Method: PUT
  22. Modify the group setting or settings, from the specified path.
  23. HTTP Method: DELETE
  24. Delete the group setting or settings, from the specified path.
  25. Unsupported HTTP Method: POST


Auto Attendant (AA)

View AA list

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

Property

Description

autoattendant

The items displayed in the list.

name

Auto attendant name.

systemId

System ID

specialSelected

Determines whether the AA is active or not.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves the list of auto-attendants configured.
Examples: XML format
<autoAttendant>
<name>Operator</name>
<systemId>operator</systemId>
<specialSelected>false</specialSelected>
</autoAttendant>
<autoAttendant>
<name>After hours</name>
<systemId>afterhour</systemId>
<specialSelected>false</specialSelected>
</autoAttendant>
</autoAttendants>
JSON format
{

"autoAttendants": [


{"name": "Operator",
"systemId": "operator",
"specialSelected": false},
{
"name": "After hours",
"systemId": "afterhour",
"specialSelected": false}
]}
Unsupported HTTP Methods: POST, PUT, DELETE

View or modify AAs special mode

Resource URI: /auto-attendant/specialmode
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Property

Description

specialMode

The status of the AAs' special mode. Displays True if the AA is on and False if the AA is off.

Specific Response Codes: N/A
HTTP Method: GET
Displays if the auto attendant is activated or not.
Examples: XML format
<specialAttendant>
<specialMode>true</specialMode>
</specialAttendant>
JSON format
{"specialAttendant": {
"specialMode": true}}
HTTP Method: PUT
The status is set to TRUE and the special mode is activated.
HTTP Method: DELETE
The status is set to FALSE and the special mode is deactivated.
Unsupported HTTP Method: POST

Activate special mode for AA

Resource URI: /auto-attendant/special
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

SpecialMode

The status of the AA. Displays True if it is enabled or False if it is disabled.

Specific Response Codes: N/A
HTTP Method: GET
Displays if the auto attendant is activated or not.
Examples: XML format
<specialAttendant>
<specialMode>true</specialMode>
</specialAttendant>
JSON format
{"specialAttendant": {
"specialMode": true}}
HTTP Method: PUT
The status is set to True and the special mode is activated.
HTTP Method: DELETE
The status is set to False and the special mode is deactivated.
Unsupported HTTP Method: POST

Set an AA as special

Resource URI: /auto-attendant/{attendant}/special
Default Resource Properties: N/A
Specific Response Codes:
Error 400 - when {attendant} not found on PUT/DELETE (update/delete)
Error 409 - when special mode is true on DELETE
HTTP Method: PUT
The auto attendant is special.
HTTP Method: DELETE
The attendant does not have the special feature.
Unsupported HTTP Method: GET, POST

Enable an AA

Resource URI: /auto-attendant/livemode/{code}
Default Resource Properties: N/A
Specific Response Codes:
HTTP Method: PUT
The auto attendant with the specified code is enabled. Note that the code represents the phone's extension.
HTTP Method: DELETE
The auto attendant with the specified code is disabled. Note that the code represents the phone's extension.
Unsupported HTTP Method: GET, POST

User

View avatar information

Resource URI: /avatar/{user}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Retrieves avatar content for the specified user.
Example: N/A
Unsupported HTTP Method: POST, PUT, DELETE

View or modify users

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

Property

Description

ID

Unique identification number of the user. If specified, the Branch property must be left blank.

username

Alias of the user

lastName

Last name of the user.

firstName

First name of the user.

pin

Users' PIN.

sipPassword

SIP password associated with the users.

groups

The group the user is part of.

branch

Branch unique identification number. If specified, the ID property must be left blank.

aliases

The alias the users are part of.


Filtering Parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Required. Forward/reverse. If it is the only parameter used, it defaults to Name.

sortby

Required. Name/description

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all users. Parameters to specify sorting are optional, but you should use both if you want sorting. If you only use the "sortdir" parameter, it defaults to "name".
Example: XML format
<user>
<metadata>
<totalResults>2</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>2</resultsPerPage>
</metadata>
 <id>21</id>
 <userName>208</userName>
 <lastName>Zor-El</lastName>
 <firstName>Kara</firstName>
 <pin></pin>
 <sipPassword>208</sipPassword>
 <groups>
   <group>
     <id>5</id>
     <name>JusticeLeague</name>
     <description>Superheroes of America</description>
   </group>
 </groups>
 <branch>
   <id>1</id>
   <name>HallOfJustice</name>
   <description>API Testing</description>
 </branch>
 <aliases>
   <alias>
     <alias>supergirl</alias>
   </alias>
   <alias>
     <alias>kara</alias>
   </alias>
 </aliases>
</user>
JSON format
{"user": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

"users": [


{
"id": 10,
"userName": "205",
"pin": "",
"sipPassword": "",

"groups": [


{
"id": 9,
"name": "IMGroup"
}
],

"aliases": [


]
},
{
"id": 11,
"userName": "206",
"pin": "",
"sipPassword": "",

"groups": [


],

"aliases": [


]
}
]
}}
HTTP Method: PUT
Adds a new user. Notes:

  • The ID is auto-generated and any value will be ignored.
  • If the Pin is empty the current PIN value will be preserved.
  • The Branch, Groups and Aliases elements are optional.

Unsupported HTTP Method: POST, DELETE

View or modify a user ID

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

Property

Description

user

The user setting related information is similar to the one described under /user.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on user with the specified ID
Example: XML format
<user>
<id>10</id>
<userName>205</userName>
<pin />
<sipPassword />
<groups>
<group>
<id>9</id>
<name>IMGroup</name> </group>
</groups>
<aliases /> </user>
JSON format
{"user": {
"id": 10,
"userName": "205",
"pin": "",
"sipPassword": "",

"groups": [


{
"id": 9,
"name": "IMGroup"
}
],

"aliases": [


]
}}
HTTP Method: PUT
Updates user with specified ID. Uses same XML as for creation. After an update the response data will contain an ID element with the "id" value of the item affected.
HTTP Method: DELETE
Removes user with the specified ID.
Unsupported HTTP Method: POST

View permissions for all users

Resource URI: /user-permission
Default Resource Properties: N/A
Filtering Parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse

sortby

Optional. Name/description

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all users and their permission settings.
Unsupported HTTP Method: POST, PUT, DELETE

View or modify permissions for a user ID

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

Property

Description

id

The user ID. The value is auto-generated and any value is ignored.

lastName

The last name of the user.

firstName

The first name of the user.

permissions

List of permissions

setting

List of settings.

name

Name of the setting.

value

Displays the status of the permission: Enabled or Disabled. It will be missing (empty) if the permission is set to the default and has never been changed.

defaultValue

The default value: True of False. for information only. It does not need to be provided and will be ignored.
Not all permissions need to be updated at once. They can be listed individually or in subgroups.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on user with the specified id and its permissions.
Example: XML format
<user>
<id>30</id>
<lastName>Fury</lastName>
<firstName>Nick</firstName>
<permissions>
<setting>
<name>900Dialing</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>AutoAttendant</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>ExchangeUMVoicemailServer</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>FreeswitchVoicemailServer</name>
value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>InternationalDialing</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LocalDialing</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LongDistanceDialing</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Mobile</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>RecordSystemPrompts</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>TollFree</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Voicemail</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>music-on-hold</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>perm_3</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_4</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_7</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>personal-auto-attendant</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>subscribe-to-presence</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>superadmin</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>tui-change-pin</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
</permissions>
</user>
HTTP Method: PUT
Sets permission values for a user.
Unsupported HTTP Method: POST, DELETE

Permissions

View or create permissions

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

Property

Description

totalResults

Total number of results

currentPage

The page you are currently viewing.

totalPages

Number of total pages.

resultsPerPage

Number of permissions displayed on each page

name

Name of the permission.

label

Alternative name of the description.

defaultValue

Default value. Displays True if it is enabled or False if it is disabled.

type

 

builtIn

 


Filtering Parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse.

sortby

Optional. Name/description.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves a list with all permissions and information on all permissions.
Example: XML format
<permissions>
<metadata>
<totalResults>18</totalResults>
<currentPage>1</currentPage>
<totalPages>18</totalPages>
<resultsPerPage>1</resultsPerPage>
</metadata>
<permissions>
<permission>
<name>900Dialing</name>
<label>900Dialing</label>
<defaultValue>false</defaultValue>
<type>CALL</type>
<builtIn>true</builtIn>
</permission>
</permissions>
</permissions>
HTTP Method: PUT
Adds a new permission. You must specify a body representing a new permission using the following template:
<permission>
<name>perm_7</name>
<label>API Create</label>
<description>Created through API 2</description>
<defaultValue>true</defaultValue>
<type>CALL</type>
<builtIn>false</builtIn>
</permission>
Where the name, type and builtIn elements are system generated.
Note that all new permissions are non-built-in Call permissions.
Unsupported HTTP Method: POST, DELETE

View or modify a permission ID

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

Property

Description

permission

The permissions related information is similar to the one described under /permission.

Specific Response Codes: Error 400 - when {name} not found or invalid
HTTP Method: GET
Retrieves information on the permission with the specified ID.
Example: XML format
<permission>
<name>900Dialing</name>
<label>900Dialing</label>
<defaultValue>false</defaultValue>
<type>CALL</type>
<builtIn>true</builtIn>
</permission>
JSON format
{"permission": {
"name": "900Dialing",
"label": "900Dialing",
"defaultValue": false,
"type": "CALL",
"builtIn": true
}}
HTTP Method: PUT
Updates permission with the specified ID. Uses same XML as for creation.
HTTP Method: DELETE
Removes permission with the specified ID.
Unsupported HTTP Method: POST

Branch

View or modify branches

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

Property

Description

totalResults

The total number of results.

currentPage

Number of the current page.

totalPages

The number of total pages.

resultPerPage

Number of results per page.

ID

Unique identification number of the branch.

name

Branch name.

description

Short description provided by the user.

address

Address of the branch.

ID

Name of the street.

street

Number of the street.

city

Name of the city.

country

Name of the country.

state

Name of the state.

ZIP

ZIP code number.

officeDesignation

 

address

Office address.

phoneNumber

Branch phone number.

faxNumber

 

Specific Response Codes: Error 400 (wrong id when update branch).
HTTP Method: GET
Retrieves a list with the branches saved in the system
Example: XML format
<branch>
<metadata>
<totalResults>1</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>1</resultsPerPage>
</metadata>
<branches>
<branch>
<id>1</id>
<name>Branch1</name>
<description>desc</description>
<address>
<id>1</id>
<street>fifteen</street>
<city>Los Angeles</city>
<country>U.S.A.</country>
<state>California</state>
<zip>8080</zip>
<officeDesignation>mmm</officeDesignation>
</address>
<phoneNumber>121231</phoneNumber>
<faxNumber>11221</faxNumber>
</branch>
</branches>
</branch>

https://\[server\]/sipxconfig/rest/branch?sortdir=forward&sortby=description&page=1&pagesize=1


HTTP Method: PUT
Adds a new branch. The ID is auto-generated and any value is ignored:
<branch>
<id>1</id>
<name>HallOfJustice</name>
<description>API Testing</description>
<address>
<id>3</id>
<street>1 Justice Way</street>
<city>Smallville</city>
<country>United States</country>
<state>MidAmerica</state>
<zip>55555</zip>
<officeDesignation>stop</officeDesignation>
</address>
<phoneNumber>555-HERO</phoneNumber>
</branch>
Unsupported HTTP Method: POST, DELETE

View or modify a branch ID

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

Property

Description

branch

The branch related information is similar to the one described under /branch.

Specific Response Codes: Error 400 (wrong id when update branch)
HTTP Method: GET
Retrieves information on the branch with the specified ID.
Example: XML format
<branch>
<id>1</id>
<name>MyBranch</name>
<description>desc</description>
<address>
<id>1</id>
<street>Street1</street>
<city>Boston</city>
<country>USA</country>
<state>MA</state>
<zip>808080</zip>
</address>
</branch>
JSON format
{"branch": {
"id": 1,
"name": "MyBranch",
"description": "desc",
"address": {
"id": 1,
"street": "Street1",
"city": "Boston",
"country": "USA",
"state": "MA",
"zip": "808080"
}
}}
HTTP Method: PUT
Updates branch with the specified ID. Uses the same XML as for creation.
HTTP Method: DELETE
Removes branch with the specified ID.
Unsupported HTTP Method: POST

User groups

View or modify user groups

Resource URI: /user-group
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

id

Unique identification number of the user group.

name

Name of the user group.

Filtering Parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse

sortby

Optional. Name/description

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all the user groups.
Example: XML format

https://\[server\]/sipxconfig/rest/user-group?sortdir=forward&sortby=description&page=1&pagesize=1


<user-group>
<metadata>
<totalResults>7</totalResults>
<currentPage>1</currentPage>
<totalPages>7</totalPages>
<resultsPerPage>1</resultsPerPage>
</metadata>
<groups>
<group>
<id>19</id>
<name>ldap_imports</name>
</group>
</groups>
</user-group>
JSON format
{"usergroup": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

"groups": [


{
"id": 5,
"name": "administrators",
"description": "Users with superadmin privileges"
},
{
"id": 9,
"name": "IMGroup"
}
]
}}
HTTP Method: PUT
Adds a new user group. The "id" is auto-generated and any value is ignored. The "branch" element is optional.
<userGroup>
<id>5</id>
<name>JusticeLeague</name>
<description>Superheroes Unlimited</description>
<branch>
<id>1</id>
<name>HallOfJustice</name>
<description>Hall of Superheroes</description>
<address>
<id>3</id>
<street>1 Justice Way</street>
<city>Smallville</city>
<country>United States</country>
<state>MidAmerica</state>
<zip>55555</zip>
<officeDesignation>MailStop</officeDesignation>
</address>
<phoneNumber>555-HERO</phoneNumber>
</branch>
</userGroup>
Unsupported HTTP Method: POST, DELETE

View or modify a user group ID

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

Property

Description

totalResults

Number of total results.

currentPage

Number of the current page.

totalPages

Number of total pages.

resultsPerPage

Number of results per page.

group

Heading with details on the user group.

id

Group ID.

name

Group name.

description

Short description of the group

Specific Response Codes: Error 400 - when {id} is invalid or not found
HTTP Method: GET
Retrieves information on the user group with the specified ID.
Example: XML format
<user-group>
<metadata>
<totalResults>2</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>2</resultsPerPage>
</metadata>
<groups>
<group>
<id>5</id>
<name>administrators</name>
<description>Users with superadmin privileges</description>
</group>
<group>
<id>9</id>
<name>IM-Group</name>
</group>
</groups>
</user-group>
JSON format
{"user-group": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

"groups": [


{
"id": 5,
"name": "administrators",
"description": "Users with superadmin privileges"
},
{
"id": 9,
"name": "IM-Group"
}
]
}}
HTTP Method: PUT
Updates group with the specified ID. Uses the same XML as for creation.
HTTP Method: DELETE
Removes branch with the specified ID.
Unsupported HTTP Method: POST

View or modify user group permissions

Resource URI: /user-group-permission
Default Resource Properties: N/A
Filtering parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse

sortby

Optional. Name/description

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all user groups and their permission settings.
Unsupported HTTP Method: POST, PUT, DELETE

View or modify permissions for a group ID

Resource URI: /user-group-permission/{id}
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

id

Group unique identification number.

name

Group name.

description

Short description provided by the user.

name

Permission name.

value

Displays True if it is enabled or False if it is disabled.

defaultValue

Default value.

Filtering parameters:

Parameter

Description

page

Required. The requested page size.

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse.

sortby

Optional. Name/description.

Specific Response Codes: Error 400 - when {id} is invalid or not found.
HTTP Method: GET
Retrieves information on user group with the specified ID and its permissions.
Example: XML format
<group>
<id>5</id>
<name>JusticeLeague</name>
<description>Superheroes of America</description>
<permissions>
<setting>
<name>900Dialing</name>
<value>ENABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>AutoAttendant</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>ExchangeUMVoicemailServer</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>FreeswitchVoicemailServer</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>InternationalDialing</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LocalDialing</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LongDistanceDialing</name>
<value>DISABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Mobile</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>RecordSystemPrompts</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>TollFree</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Voicemail</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>music-on-hold</name>
<value>DISABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>perm_3</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_4</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_7</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>personal-auto-attendant</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>subscribe-to-presence</name>
<value>DISABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>superadmin</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>tui-change-pin</name>
<defaultValue>true</defaultValue>
</setting>
</permissions>
</group>
HTTP Method: PUT
Sets permission values for a user group. Notes:

  • The ID is auto-generated and any value will be ignored
  • The Setting element must contain a value element.
  • The Value must be set to either Enable or Disable. The Value element is blank if the permission is set to the default and has never been changed.
  • The defaultValue is for information only and is read-only.
  • Not all permissions need to be updated at once. They can be listed individually or in subgroups.

Unsupported HTTP Method: POST, DELETE

Gateways

  1. Available in 14 starting with 14.10

View all gateways

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateways
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. id

    Gateway unique identification number.

    1. name

    Gateway name.

    1. description

    Short description provided by the user.

    1. model

    The model related information is similar to the one described under /model.

    1. enabled

    Displays True if it is enabled or False if it is disabled.

    1. address

    Gateway address.

    1. addressPort

    Address port number.

    1. outboundPort

    Outbound port number.

    1. addressTransport

     

    1. shared

     

    1. useInternalBridge

    Displays True if it is enabled or False if it is disabled.

    1. anonymus

    Displays True if it is enabled or False if it is disabled.

    1. ignoreUserInfo

     

    1. transformUserExtensions

     

    1. keepDigits

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all the gateways in the database.
          1. Example: XML version
          2. <Gateways><Gateway>
          3. <id>%s</id>
          4. <name>myGateway</name>"
          5. "<description>myDesc</description>
          6. <Model><modelId>acmeGatewayStandard</modelId>"
          7. "<label>Acme1000</label>
          8. <vendor>acme</vendor>
          9. </Model>
          10. <enabled>true</enabled>
          11. <address>1.1.1.1</address>
            1. <addressPort>0</addressPort>"
          12. "<outboundPort>5060</outboundPort>
          13. <addressTransport>none</addressTransport>"
          14. "<shared>true</shared>
          15. <useInternalBridge>true</useInternalBridge>"
          16. "<CallerAliasInfo><anonymous>false</anonymous>
          17. <ignoreUserInfo>false</ignoreUserInfo>
          18. <transformUserExtension>false</transformUserExtension>
          19. <keepDigits>0</keepDigits>
          20. </CallerAliasInfo>"
          21. "</Gateway></Gateways>"
          22. JSON format
  8. {\"gateways\":[{\"id\":%s,\"name\":\"myGateway\",\"serialNo\":null,\"deviceVersion\":null,\"description\":\"myDesc\","

  9. "\"model\":{\"modelId\":\"acmeGatewayStandard\",\"label\":\"Acme 1000\",\"vendor\":\"acme\","
  10. "\"versions\":null},\"enabled\":true,\"address\":\"1.1.1.1\",\"addressPort\":0,\"outboundAddress\":null,\"outboundPort\":5060,"
  11. "\"addressTransport\":\"none\",\"prefix\":null,\"shared\":true,\"useInternalBridge\":true,\"branch\":null,"
  12. "\"callerAliasInfo\":{\"defaultCallerAlias\":null,\"anonymous\":false,\"ignoreUserInfo\":false,\"transformUserExtension\":false,"
  13. "\"addPrefix\":null,\"keepDigits\":0,\"displayName\":null,\"urlParameters\":null}}]}
  14. Unsupported HTTP Method: PUT, POST, DELETE

Filter gateways by model

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateways/models
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. model
    1. Gateway model.
    1. label
    1. Gateway label.
    1. vendor
    1. Gateway model vendor.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the models of all the gateways in the database.
        1. Example: XML format
  8. "<Models><Model><modelId>acmeGatewayStandard</modelId><label>Acme 1000</label><vendor>acme</vendor></Model>"
  9. "<Model><modelId>genericGatewayStandard</modelId><label>Unmanaged gateway</label></Model>"
  10. "<Model><modelId>sipTrunkStandard</modelId><label>SIP trunk</label></Model></Models>"
  11. JSON format
  12. "{\"models\":[{\"modelId\":\"acmeGatewayStandard\",\"label\":\"Acme 1000\",\"vendor\":\"acme\",\"versions\":null},"

  13. "{\"modelId\":\"genericGatewayStandard\",\"label\":\"Unmanaged gateway\",\"vendor\":null,\"versions\":null},"
  14. "{\"modelId\":\"sipTrunkStandard\",\"label\":\"SIP trunk\",\"vendor\":null,\"versions\":null}]}"
  15. Unsupported HTTP Method: PUT, POST, DELETE


View or modify gateway ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateways/{gatewayId}
  3. Default Resource Properties
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. gateway
    1. The gateway related information is similar to the one described under /gateway.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves information on the gateway with the specified ID.
  8. Example: XML format
  9. <Gateway><id>%s</id><name>myGateway</name><description>myDesc</description>"
  10. "<Model><modelId>acmeGatewayStandard</modelId><label>Acme 1000</label><vendor>acme</vendor></Model>"
  11. "<enabled>true</enabled><address>1.1.1.1</address><addressPort>0</addressPort><outboundPort>5060</outboundPort>"
  12. "<addressTransport>none</addressTransport><shared>true</shared><useInternalBridge>true</useInternalBridge>"
  13. "<CallerAliasInfo><anonymous>false</anonymous><ignoreUserInfo>false</ignoreUserInfo>"
  14. "<transformUserExtension>false</transformUserExtension><keepDigits>0</keepDigits></CallerAliasInfo></Gateway>"
  15. JSON format
  16. "{\"id\":%s,\"name\":\"myGateway\",\"serialNo\":null,\"deviceVersion\":null,\"description\":\"myDesc\","
  17. + "\"model\":{\"modelId\":\"acmeGatewayStandard\",\"label\":\"Acme 1000\",\"vendor\":\"acme\",\"versions\":null},"
  18. "\"enabled\":true,\"address\":\"1.1.1.1\",\"addressPort\":0,\"outboundAddress\":null,\"outboundPort\":5060,"
  19. "\"addressTransport\":\"none\",\"prefix\":null,\"shared\":true,\"useInternalBridge\":true,\"branch\":null,"
  20. "\"callerAliasInfo\":{\"defaultCallerAlias\":null,\"anonymous\":false,\"ignoreUserInfo\":false,"
  21. "\"transformUserExtension\":false,\"addPrefix\":null,\"keepDigits\":0,\"displayName\":null,\"urlParameters\":null}}"
  22. HTTP Method: PUT
  23. Updates gateway with the specified ID. Uses the same XML as for creation.
  24. HTTP Method: POST
          1. Creates new gateway with the specified ID.
  25. HTTP Method: DELETE
  26. Removes gateway with the specified ID.
  27. Unsupported HTTP Method: N/A

View all settings of a gateway ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateways/{gatewayId}/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
              1. Path to the setting.
    1. type

    Setting type. Possible options are string, boolean or enum.

    1. options

    Available setting options.

    1. value

    The current selected option of the setting.

    1. defaultValue

    The default value of the setting.

    1. label

    Setting label.

    1. description

    Short description provided by the user.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the settings for the specified phone models in the gateway ID.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>SIP_general/PRACKMode</path>
  11. <type>enum</type>
  12. <options>
  13. <entry>
  14. <key>2</key>
  15. <value>Required</value>
  16. </entry>
  17. <entry>
  18. <key>1</key>
  19. <value>Supported</value>
  20. </entry>
  21. <entry>
  22. <key>0</key>
  23. <value>Disabled</value>
  24. </entry>
  25. </options>
  26. <value>1</value>
  27. <defaultValue>1</defaultValue>
  28. <label>PRACK Mode</label>
  29. </Setting>
  30. <Setting>
  31. <path>SIP_general/ChannelSelectMode</path>
  32. <type>enum</type>
  33. <options>
  34. <entry>
  35. <key>3</key>
  36. <value>Cyclic Descending</value>
  37. </entry>
  38. <entry>
  39. <key>2</key>
  40. <value>Ascending</value>
  41. </entry>
  42. <entry>
  43. <key>1</key>
  44. <value>Cyclic Ascending</value>
  45. </entry>
  46. <entry>
  47. <key>0</key>
  48. <value>By phone number</value>
  49. </entry>
  50. <entry>
  51. <key>6</key>
  52. <value>Calling Party Number</value>
  53. </entry>
  54. <entry>
  55. <key>5</key>
  56. <value>Number + cyclic Ascending</value>
  57. </entry>
  58. <entry>
  59. <key>4</key>
  60. <value>Descending</value>
  61. </entry>
  62. </options>
  63. <value>1</value>
  64. <defaultValue>1</defaultValue>
  65. <label>Channel Select Mode</label>
  66. </Setting>
  67. <Setting>
  68. <path>SIP_general/EnableEarlyMedia</path>
  69. <type>boolean</type>
  70. <value>1</value>
  71. <defaultValue>1</defaultValue>
  72. <label>Enable Early Media</label>
  73. </Setting>
  74. <Setting>
  75. <path>SIP_general/AssertedIDMode</path>
  76. <type>enum</type>
  77. <options>
  78. <entry>
  79. <key>2</key>
  80. <value>P-Preferred</value>
  81. </entry>
  82. <entry>
  83. <key>1</key>
  84. <value>P-Asserted</value>
  85. </entry>
  86. <entry>
  87. <key>0</key>
  88. <value>Disabled</value>
  89. </entry>
  90. </options>
  91. <value>0</value>
  92. <defaultValue>0</defaultValue>
  93. <label>Asserted ID Mode</label>
  94. <description>The Asserted ID mode defines the header that is used in the generated INVITE request. The header also depends on the calling Privacy: allowed or restricted.</description>
  95. </Setting>
  96. <Setting>
  97. <path>SIP_general/UseTelURIForAssertedID</path>
  98. <type>boolean</type>
  99. <value>0</value>
  100. <defaultValue>0</defaultValue>
  101. <label>Tel URI for Asserted Identity</label>
  102. </Setting>
  103. <Setting>
  104. <path>SIP_general/IsFaxUsed</path>
  105. <type>enum</type>
  106. <options>
  107. <entry>
  108. <key>3</key>
  109. <value>T.38 + Passthru</value>
  110. </entry>
  111. <entry>
  112. <key>2</key>
  113. <value>Passthru (G711)</value>
  114. </entry>
  115. <entry>
  116. <key>1</key>
  117. <value>T.38</value>
  118. </entry>
  119. <entry>
  120. <key>0</key>
  121. <value>No SIP signaling for fax</value>
  122. </entry>
  123. </options>
  124. <value>3</value>
  125. <defaultValue>3</defaultValue>
  126. <label>Fax Signaling</label>
  127. </Setting>
  128. <Setting>
  129. <path>SIP_general/DetFaxOnAnswerTone</path>
  130. <type>enum</type>
  131. <options>
  132. <entry>
  133. <key>1</key>
  134. <value>T.38 on CED</value>
  135. </entry>
  136. <entry>
  137. <key>0</key>
  138. <value>T.38 on Preamble</value>
  139. </entry>
  140. </options>
  141. <value>0</value>
  142. <defaultValue>0</defaultValue>
  143. <label>Detect Fax on Answer Tone</label>
  144. </Setting>
  145. </setting>
    1. JSON format
  146. {
  147. settings:
  148. {
  149. path: "SIP_general/PRACKMode"
  150. type: "enum"
  151. options: {
  152. 0: "Disabled"
  153. 1: "Supported"
  154. 2: "Required"
  155. }-
  156. value: "1"
  157. defaultValue: "1"
  158. label: "PRACK Mode"
  159. description: null
  160. }-
  161. {
  162. path: "SIP_general/ChannelSelectMode"
  163. type: "enum"
  164. options: {
  165. 0: "By phone number"
  166. 1: "Cyclic Ascending"
  167. 2: "Ascending"
  168. 3: "Cyclic Descending"
  169. 4: "Descending"
  170. 5: "Number + cyclic Ascending"
  171. 6: "Calling Party Number"
  172. }-
  173. value: "1"
  174. defaultValue: "1"
  175. label: "Channel Select Mode"
  176. description: null
  177. }-
  178. {
  179. path: "SIP_general/EnableEarlyMedia"
  180. type: "boolean"
  181. options: null
  182. value: "1"
  183. defaultValue: "1"
  184. label: "Enable Early Media"
  185. description: null
  186. }-
  187. {
  188. path: "SIP_general/AssertedIDMode"
  189. type: "enum"
  190. options: {
  191. 0: "Disabled"
  192. 1: "P-Asserted"
  193. 2: "P-Preferred"
  194. }-
  195. value: "0"
  196. defaultValue: "0"
  197. label: "Asserted ID Mode"
  198. description: "The Asserted ID mode defines the header that is used in the generated INVITE request. The header also depends on the calling Privacy: allowed or restricted."
  199. }-
  200. {
  201. path: "SIP_general/UseTelURIForAssertedID"
  202. type: "boolean"
  203. options: null
  204. value: "0"
  205. defaultValue: "0"
  206. label: "Tel URI for Asserted Identity"
  207. description: null
  208. }-
  209. {
  210. path: "SIP_general/IsFaxUsed"
  211. type: "enum"
  212. options: {
  213. 0: "No SIP signaling for fax"
  214. 1: "T.38"
  215. 2: "Passthru (G711)"
  216. 3: "T.38 + Passthru"
  217. }-
  218. value: "3"
  219. defaultValue: "3"
  220. label: "Fax Signaling"
  221. description: null
  222. }-
  223. {
  224. path: "SIP_general/DetFaxOnAnswerTone"
  225. type: "enum"
  226. options: {
  227. 0: "T.38 on Preamble"
  228. 1: "T.38 on CED"
  229. }-
  230. value: "0"
  231. defaultValue: "0"
  232. label: "Detect Fax on Answer Tone"
  233. description: null
  234. }-
  235. {
  236. path: "SIP_general/SIPTransportType"
  237. type: "enum"
  238. options: {
  239. 0: "UDP"
  240. 1: "TCP"
  241. 2: "TLS"
  242. }-
  243. value: "0"
  244. defaultValue: "0"
  245. label: "SIP Transport Type"
  246. description: null
  247. }-
  248. {
  249. path: "SIP_general/LocalSIPPort"
  250. type: "string"
  251. options: null
  252. value: "5060"
  253. defaultValue: "5060"
  254. label: "UDP SIP Port"
  255. description: "UDP Port for SIP signaling"
  256. }-
  257. {
  258. path: "SIP_general/TCPLocalSIPPort"
  259. type: "string"
  260. options: null
  261. value: "5060"
  262. defaultValue: "5060"
  263. label: "TCP SIP Port"
  264. description: "TCP Port for SIP signaling"
  265. }-
  266. {
  267. path: "SIP_general/TLSLocalSIPPort"
  268. type: "string"
  269. options: null
  270. value: "5061"
  271. defaultValue: "5061"
  272. label: "TLS SIP Port"
  273. description: "TLS Port for SIP signaling"
  274. }
  275. }
  276. Unsupported HTTP Method: PUT, POST, DELETE


View or modify a setting for phone models in a gateway ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateways/{gatewayId}/settings/{path:.*}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. gateway
    1. The gateway related information is similar to the one described under /gateway.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve the setting specified in the path for the phone models in the gateway ID.
        1. Example: XML format
  8. <Setting>
  9. <path>SIP_general/EnableEarlyMedia</path>
  10. <type>boolean</type>
  11. <value>1</value>
  12. <defaultValue>1</defaultValue>
  13. <label>Enable Early Media</label>
  14. </Setting>
    1. JSON format
  15. {
  16. path: "SIP_general/EnableEarlyMedia"
  17. type: "boolean"
  18. options: null
  19. value: "1"
  20. defaultValue: "1"
  21. label: "Enable Early Media"
  22. description: null
  23. }
  24. HTTP Method: PUT
    1. Updates the setting specified in the path for the phone models in the gateway ID.PUT data is plain text.
  25. HTTP Method: DELETE
              1. Deletes the setting specified in the path for the phone models in the gateway ID.
  26. Unsupported HTTP Method: POST


View ports for a gateway ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateways/{gatewayId}/ports
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the ports of the gateway with the specified ID.
  8. HTTP Method: PUT
    1. Updates the ports of the gateway with the specified ID. PUT data is plain text.
  9. HTTP Method: DELETE
              1. Deletes the ports of the gateway with the specified ID.
  10. Unsupported HTTP Method: POST


View port settings for a gateway ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /gateway/{gatewayId}/port/{portId}/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. setting
    1. The port setting related information is similar to the one described under /gateway/settings.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. View port settings for the gateway with the specified ID.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>Port/AutomaticDialing</path>
  11. <type>boolean</type>
  12. <value>1</value>
  13. <defaultValue>1</defaultValue>
  14. <label>Automatic Dialing</label>
  15. <description>If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below.</description>
  16. </Setting>
  17. <Setting>
  18. <path>Port/Extension</path>
  19. <type>string</type>
  20. <value>operator</value>
  21. <defaultValue>operator</defaultValue>
  22. <label>Extension</label>
  23. <description>Specify the destination for incoming calls on this PSTN line, such as an auto-attendant, a hunt group, an ACD queue, or any internal extension, user or alias.</description>
  24. </Setting>
  25. </Settings>
    1. JSON format
  26. {
  27. settings: [2]

  28. 0: {
  29. path: "Port/AutomaticDialing"
  30. type: "boolean"
  31. options: null
  32. value: "1"
  33. defaultValue: "1"
  34. label: "Automatic Dialing"
  35. description: "If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below."
  36. }-
  37. 1: {
  38. path: "Port/Extension"
  39. type: "string"
  40. options: null
  41. value: "operator"
  42. defaultValue: "operator"
  43. label: "Extension"
  44. description: "Specify the destination for incoming calls on this PSTN line, such as an auto-attendant, a hunt group, an ACD queue, or any internal extension, user or alias."
  45. }-
  46. -
  47. }
  48. HTTP Method: PUT
    1. Updates the port settings for the gateway with the specified ID. PUT data is plain text.
  49. HTTP Method: DELETE
              1. Deletes the port settings for the gateway with the specified ID.
  50. Unsupported HTTP Method: POST

    1. View or modify port settings
  51. Available in 14 starting with 14.10
  52. Resource URI: /gateway/{gatewayId}/port/{portId}/settings/{path:.*}
  53. Default Resource Properties:
  54. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. setting
    1. The port setting related information is similar to the one described under /gateway/settings.
  55. Specific Response Codes: N/A
  56. HTTP Method: GET
  57. Retrieves the port settings of the gateway with the specified ID.
        1. Example: XML format
  58. <Setting>
  59. <path>Port/AutomaticDialing</path>
  60. <type>boolean</type>
  61. <value>1</value>
  62. <defaultValue>1</defaultValue>
  63. <label>Automatic Dialing</label>
  64. <description>If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below.</description>
  65. </Setting>
    1. JSON format
  66. {
  67. path: "Port/AutomaticDialing"
  68. type: "boolean"
  69. options: null
  70. value: "1"
  71. defaultValue: "1"
  72. label: "Automatic Dialing"
  73. description: "If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below."
  74. }
  75. HTTP Method: PUT

Updates the settings of the port. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the port.

  1. Unsupported HTTP Method: POST


IVR

  1. Available in 14 starting with 14.10

View IVR settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /ivr/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
              1. Path to the setting.
    1. type

    Setting type. Possible options are string, boolean or enum.

    1. options

    Available setting options.

    1. value

    The current selected option of the setting.

    1. defaultValue

    The default value of the setting.

    1. label

    Setting label.

    1. description

    Short description provided by the user.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all the IVR settings.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>ivr/log.level</path>
  11. <type>enum</type>
  12. <options>
  13. <entry>
  14. <key>NOTICE</key>
  15. </entry>
  16. <entry>
  17. <key>CRIT</key>
  18. </entry>
  19. <entry>
  20. <key>EMERG</key>
  21. </entry>
  22. <entry>
  23. <key>WARNING</key>
  24. </entry>
  25. <entry>
  26. <key>ERR</key>
  27. </entry>
  28. <entry>
  29. <key>INFO</key>
  30. </entry>
  31. <entry>
  32. <key>ALERT</key>
  33. </entry>
  34. <entry>
  35. <key>DEBUG</key>
  36. </entry>
  37. </options>
  38. <value>NOTICE</value>
  39. <defaultValue>NOTICE</defaultValue>
  40. <label>Logging Level</label>
  41. </Setting>
  42. <Setting>
  43. <path>ivr/audio.format</path>
  44. <type>enum</type>
  45. <options>
  46. <entry>
  47. <key>mp3</key>
  48. </entry>
  49. <entry>
  50. <key>wav</key>
  51. </entry>
  52. </options>
  53. <value>wav</value>
  54. <defaultValue>wav</defaultValue>
  55. <label>Voicemail encoding format</label>
  56. <description>The encoding format to be used for storing voicemails</description>
  57. </Setting>
  58. <Setting>
  59. <path>ivr/record.rate</path>
  60. <type>enum</type>
  61. <options>
  62. <entry>
  63. <key>8000</key>
  64. </entry>
  65. <entry>
  66. <key>16000</key>
  67. </entry>
  68. </options>
  69. <value>8000</value>
  70. <defaultValue>8000</defaultValue>
  71. <label>Record rate</label>
  72. <description>Rate (in Hz) to be used for recording voicemails</description>
  73. </Setting>
  74. <Setting>
  75. <path>ivr/record.time</path>
  76. <type>integer</type>
  77. <value>300</value>
  78. <defaultValue>300</defaultValue>
  79. <label>Time limit</label>
  80. <description>Maximum duration (in seconds) of the voicemail recording.</description>
  81. </Setting>
  82. <Setting>
  83. <path>ivr/fax.format</path>
  84. <type>enum</type>
  85. <options>
  86. <entry>
  87. <key>pdf</key>
  88. </entry>
  89. <entry>
  90. <key>tiff</key>
  91. </entry>
  92. </options>
  93. <value>pdf</value>
  94. <defaultValue>pdf</defaultValue>
  95. <label>Fax Format</label>
  96. <description>The file format for receiving faxes</description>
  97. </Setting>
  98. <Setting>
  99. <path>ivr/ivr.publicHttpPort</path>
  100. <type>integer</type>
  101. <value>8085</value>
  102. <defaultValue>8085</defaultValue>
  103. <label>Public HTTP port</label>
  104. </Setting>
  105. <Setting>
  106. <path>ivr/ivr.httpPort</path>
  107. <type>integer</type>
  108. <value>8086</value>
  109. <defaultValue>8086</defaultValue>
  110. <label>HTTP port</label>
  111. </Setting>
  112. <Setting>
  113. <path>ivr/ivr.voiceMailExpiry</path>
  114. <type>integer</type>
  115. <value>7</value>
  116. <defaultValue>7</defaultValue>
  117. <label>Voice Mail expiration</label>
  118. <description>The number of days a voice mail message in the Trash folder is retained.</description>
  119. </Setting>
  120. <Setting>
  121. <path>ivr/ivr.mwiTimeout</path>
  122. <type>integer</type>
  123. <value>5</value>
  124. <defaultValue>5</defaultValue>
  125. <label>Notify timeout</label>
  126. <description>Time (in seconds) to wait for MWI Notify response</description>
  127. </Setting>
  128. <Setting>
  129. <path>ivr/ivr.updaterConnectTimeoutMS</path>
  130. <type>integer</type>
  131. <value>5000</value>
  132. <defaultValue>5000</defaultValue>
  133. <label>Database Connection timeout</label>
  134. <description>Timeout (in milliseconds) for global database connection.</description>
  135. </Setting>
  136. <Setting>
  137. <path>ivr/ivr.updaterSocketTimeoutMS</path>
  138. <type>integer</type>
  139. <value>5000</value>
  140. <defaultValue>5000</defaultValue>
  141. <label>Database Socket timeout</label>
  142. <description>Timeout (in milliseconds) for global database socket.</description>
  143. </Setting>
  144. </Settings>
    1. JSON format
  145. {
  146. settings:
  147. 0: {
  148. path: "ivr/log.level"
  149. type: "enum"
  150. options: {
  151. NOTICE: null
  152. CRIT: null
  153. EMERG: null
  154. WARNING: null
  155. ERR: null
  156. INFO: null
  157. ALERT: null
  158. DEBUG: null
  159. }-
  160. value: "NOTICE"
  161. defaultValue: "NOTICE"
  162. label: "Logging Level"
  163. description: null
  164. }-
  165. {
  166. path: "ivr/audio.format"
  167. type: "enum"
  168. options: {
  169. mp3: null
  170. wav: null
  171. }-
  172. value: "wav"
  173. defaultValue: "wav"
  174. label: "Voicemail encoding format"
  175. description: "The encoding format to be used for storing voicemails"
  176. }-
  177. {
  178. path: "ivr/record.rate"
  179. type: "enum"
  180. options: {
  181. 8000: null
  182. 16000: null
  183. }-
  184. value: "8000"
  185. defaultValue: "8000"
  186. label: "Record rate"
  187. description: "Rate (in Hz) to be used for recording voicemails"
  188. }-
  189. {
  190. path: "ivr/record.time"
  191. type: "integer"
  192. options: null
  193. value: "300"
  194. defaultValue: "300"
  195. label: "Time limit"
  196. description: "Maximum duration (in seconds) of the voicemail recording."
  197. }-
  198. {
  199. path: "ivr/fax.format"
  200. type: "enum"
  201. options: {
  202. pdf: null
  203. tiff: null
  204. }-
  205. value: "pdf"
  206. defaultValue: "pdf"
  207. label: "Fax Format"
  208. description: "The file format for receiving faxes"
  209. }-
  210. {
  211. path: "ivr/ivr.publicHttpPort"
  212. type: "integer"
  213. options: null
  214. value: "8085"
  215. defaultValue: "8085"
  216. label: "Public HTTP port"
  217. description: null
  218. }-
  219. {
  220. path: "ivr/ivr.httpPort"
  221. type: "integer"
  222. options: null
  223. value: "8086"
  224. defaultValue: "8086"
  225. label: "HTTP port"
  226. description: null
  227. }-
  228. {
  229. path: "ivr/ivr.voiceMailExpiry"
  230. type: "integer"
  231. options: null
  232. value: "7"
  233. defaultValue: "7"
  234. label: "Voice Mail expiration"
  235. description: "The number of days a voice mail message in the Trash folder is retained."
  236. }-
  237. {
  238. path: "ivr/ivr.mwiTimeout"
  239. type: "integer"
  240. options: null
  241. value: "5"
  242. defaultValue: "5"
  243. label: "Notify timeout"
  244. description: "Time (in seconds) to wait for MWI Notify response"
  245. }-
  246. {
  247. path: "ivr/ivr.updaterConnectTimeoutMS"
  248. type: "integer"
  249. options: null
  250. value: "5000"
  251. defaultValue: "5000"
  252. label: "Database Connection timeout"
  253. description: "Timeout (in milliseconds) for global database connection."
  254. }-
  255. {
  256. path: "ivr/ivr.updaterSocketTimeoutMS"
  257. type: "integer"
  258. options: null
  259. value: "5000"
  260. defaultValue: "5000"
  261. label: "Database Socket timeout"
  262. description: "Timeout (in milliseconds) for global database socket."
  263. }-
  264. -
  265. }
  266. HTTP Method: PUT

Updates the settings of the gateway. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the gateway.

  1. Unsupported HTTP Method: POST


View IVR settings from path

  1. Available in 14 starting with 14.10
  2. Resource URI: /ivr/setting/{pathToService}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. setting
    1. The ivr setting related information is similar to the one described under /ivr/settings.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the IVR settings from the specified path.
        1. Example: XML format (The example below used the log.level path)

  8. <Setting>
  9. <path>ivr/log.level</path><type>enum</type><options><entry><key>NOTICE</key></entry><entry><key>CRIT</key></entry><entry><key>EMERG</key></entry><entry><key>WARNING</key></entry><entry><key>ERR</key></entry><entry><key>INFO</key></entry><entry><key>ALERT</key></entry><entry><key>DEBUG</key></entry></options><value>NOTICE</value><defaultValue>NOTICE</defaultValue><label>Logging Level</label></Setting>
    1. JSON format
  10. {"path":"ivr/log.level","type":"enum","options":{"NOTICE":null,"CRIT":null,"EMERG":null,"WARNING":null,"ERR":null,"INFO":null,"ALERT":null,"DEBUG":null},"value":"NOTICE","defaultValue":"NOTICE","label":"Logging Level","description":null}
  11. HTTP Method: PUT

Updates the settings of the IVR. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the gateway.

  1. Unsupported HTTP Method: POST


DNS

  1. Available in 14 starting with 14.10

View DNS settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /dns/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
              1. Path to the setting.
    1. type

    Setting type. Possible options are string, boolean or enum.

    1. options

    Available setting options.

    1. value

    The current selected option of the setting.

    1. defaultValue

    The default value of the setting.

    1. label

    Setting label.

    1. description

    Short description provided by the user.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the settings for all DNSs in the system.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>named-config/forwarders/forwarder_0</path>
  11. <type>string</type>
  12. <value>192.168.1.1</value>
  13. <label>Primary External DNS server</label>
  14. <description>DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8.</description>
  15. </Setting>
  16. <Setting>
  17. <path>named-config/forwarders/forwarder_1</path>
  18. <type>string</type>
  19. <label>Secondary External DNS server</label>
  20. <description>In the event the primary DNS server is unavailable, system will use this server.</description>
  21. </Setting>
  22. <Setting>
  23. <path>named-config/forwarders/forwarder_2</path>
  24. <type>string</type>
  25. <label>Additional External DNS server</label>
  26. </Setting>
  27. <Setting>
  28. <path>named-config/forwarders/forwarder_3</path>
  29. <type>string</type>
  30. <label>Additional External DNS server</label>
  31. </Setting>
  32. <Setting>
  33. <path>named-config/forwarders/forwarder_4</path>
  34. <type>string</type>
  35. <label>Additional External DNS server</label>
  36. </Setting>
  37. <Setting>
  38. <path>acl/ips</path>
  39. <type>string</type>
  40. <value>192.168.1.171,127.0.0.0/8</value>
  41. <defaultValue>192.168.1.171,127.0.0.0/8</defaultValue>
  42. <label>Allow Recursion ACL</label>
  43. <description>Groups of hosts (comma separated values of IP addresses or subnet) allowed to make recursive queries on the nameserver. <br/>Leave empty for allowing all hosts to perform recursive queries on the nameserver.</description>
  44. </Setting>
  45. <Setting>
  46. <path>sys/unmanaged</path>
  47. <type>boolean</type>
  48. <value>0</value>
  49. <defaultValue>0</defaultValue>
  50. <label>Unmanaged Service</label>
  51. <description>Company or ITSP DNS servers to resolve ALL names instead of local DNS servers.</description>
  52. </Setting>
    1. JSON format
  53. {
  54. settings: [11]

  55. 0: {
  56. path: "named-config/forwarders/forwarder_0"
  57. type: "string"
  58. options: null
  59. value: "192.168.1.1"
  60. defaultValue: null
  61. label: "Primary External DNS server"
  62. description: "DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8."
  63. }-
  64. 1: {
  65. path: "named-config/forwarders/forwarder_1"
  66. type: "string"
  67. options: null
  68. value: null
  69. defaultValue: null
  70. label: "Secondary External DNS server"
  71. description: "In the event the primary DNS server is unavailable, system will use this server."
  72. }-
  73. 2: {
  74. path: "named-config/forwarders/forwarder_2"
  75. type: "string"
  76. options: null
  77. value: null
  78. defaultValue: null
  79. label: "Additional External DNS server"
  80. description: null
  81. }-
  82. 3: {
  83. path: "named-config/forwarders/forwarder_3"
  84. type: "string"
  85. options: null
  86. value: null
  87. defaultValue: null
  88. label: "Additional External DNS server"
  89. description: null
  90. }-
  91. 4: {
  92. path: "named-config/forwarders/forwarder_4"
  93. type: "string"
  94. options: null
  95. value: null
  96. defaultValue: null
  97. label: "Additional External DNS server"
  98. description: null
  99. }-
  100. 5: {
  101. path: "acl/ips"
  102. type: "string"
  103. options: null
  104. value: "192.168.1.171,127.0.0.0/8"
  105. defaultValue: "192.168.1.171,127.0.0.0/8"
  106. label: "Allow Recursion ACL"
  107. description: "Groups of hosts (comma separated values of IP addresses or subnet) allowed to make recursive queries on the nameserver. <br/>Leave empty for allowing all hosts to perform recursive queries on the nameserver."
  108. }-
  109. 6: {
  110. path: "sys/unmanaged"
  111. type: "boolean"
  112. options: null
  113. value: "0"
  114. defaultValue: "0"
  115. label: "Unmanaged Service"
  116. description: "Company or ITSP DNS servers to resolve ALL names instead of local DNS servers."
  117. }-
  118. 7: {
  119. path: "sys/unmanaged_servers/unmanaged_0"
  120. type: "string"
  121. options: null
  122. value: null
  123. defaultValue: null
  124. label: "Primary Unmanaged DNS server"
  125. description: "DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8."
  126. }
  127. }
  128. Unsupported HTTP Method: PUT, POST, DELETE


View DNS settings from path

  1. Available in 14 starting with 14.10
  2. Resource URI: /dns/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. setting
    1. The dns setting related information is similar to the one described under /dns/settings.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the DNS settings from the specified path.
        1. Example: XML format
  8. <Setting>
  9. <path>named-config/forwarders/forwarder_3</path>
  10. <type>string</type>
  11. <label>Additional External DNS server</label>
  12. </Setting>
    1. JSON format
  13. {
  14. path: "named-config/forwarders/forwarder_3"
  15. type: "string"
  16. options: null
  17. value: null
  18. defaultValue: null
  19. label: "Additional External DNS server"
  20. description: null
  21. }
  22. HTTP Method: PUT

Updates the settings of the DNS from the specified path. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the DNS from the specified path.

  1. Unsupported HTTP Method: POST

View DNS adviser results

  1. Available in 14 starting with 14.10
  2. Resource URI: /dns/advisor/server/{serverId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. Missing naptr records
    1. List of the missing NAPTR records, if any.
    1. Missing a records

    List of missing A records, if any.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Checks the DNS settings and if the settings are correct, no result is returned. Otherwise, it retrieves the missing configurations.
        1. Example: plain text only
            1. ;; Missing naptr records
            2. ezuce.ro. IN NAPTR \d 0 "s" "SIP+D2U" "" _sip._udp
            3. ezuce.ro. IN NAPTR \d 0 "s" "SIP+D2T" "" _sip._tcp
            4. ;; Missing a records
            5. openuc_1410.ezuce.ro IN A 19.18.1.175
  8. Unsupported HTTP Method: PUT, POST, DELETE


Message Waiting Indication (MWI)

  1. Available in 14 starting with 14.10

View MWI settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /mwi/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
    1. type

     

    1. value

     

    1. defaultValue

     

    1. description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves tall MWI settings.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>status-config/SIP_STATUS_TCP_PORT</path>
  11. <type>integer</type>
  12. <value>5110</value>
  13. <defaultValue>5110</defaultValue>
  14. <label>MWI TCP Port</label>
  15. </Setting>
  16. <Setting>
  17. <path>status-config/SIP_STATUS_UDP_PORT</path>
  18. <type>integer</type>
  19. <value>5110</value>
  20. <defaultValue>5110</defaultValue>
  21. <label>MWI UDP Port</label>
  22. </Setting>
  23. <Setting>
  24. <path>status-config/SIP_STATUS_HTTP_PORT</path>
  25. <type>integer</type>
  26. <value>8100</value>
  27. <defaultValue>8100</defaultValue>
  28. <label>MWI HTTP Port</label>
  29. </Setting>
  30. <Setting>
  31. <path>status-config/SIP_STATUS_LOG_LEVEL</path>
  32. <type>enum</type>
  33. <options>
  34. <entry>
  35. <key>NOTICE</key>
  36. </entry>
  37. <entry>
  38. <key>CRIT</key>
  39. </entry>
  40. <entry>
  41. <key>EMERG</key>
  42. </entry>
  43. <entry>
  44. <key>WARNING</key>
  45. </entry>
  46. <entry>
  47. <key>ERR</key>
  48. </entry>
  49. <entry>
  50. <key>INFO</key>
  51. </entry>
  52. <entry>
  53. <key>ALERT</key>
  54. </entry>
  55. <entry>
  56. <key>DEBUG</key>
  57. </entry>
  58. </options>
  59. <value>NOTICE</value>
  60. <defaultValue>NOTICE</defaultValue>
  61. <label>Logging Level</label>
  62. <description>Handling of SUBSCRIBE/NOTIFY messages for voicemail notification control (MWI)</description>
  63. </Setting>
  64. <Setting>
  65. <path>status-config/SIP_STATUS_MAX_EXPIRES</path>
  66. <type>integer</type>
  67. <label>Max expires</label>
  68. </Setting>
  69. <Setting>
  70. <path>status-config/SIP_STATUS_MIN_EXPIRES</path>
  71. <type>integer</type>
  72. <label>Min expires</label>
  73. </Setting>
  74. <Setting>
  75. <path>resource-limits/fd-soft</path>
  76. <type>integer</type>
  77. <value>32768</value>
  78. <defaultValue>32768</defaultValue>
  79. <label>FD Soft</label>
  80. <description>FD Soft resource limit</description>
  81. </Setting>
  82. <Setting>
  83. <path>resource-limits/fd-hard</path>
  84. <type>integer</type>
  85. <value>65536</value>
  86. <defaultValue>65536</defaultValue>
  87. <label>FD Hard</label>
  88. <description>FD Hard resource limit</description>
  89. </Setting>
  90. <Setting>
  91. <path>resource-limits/core-enabled</path>
  92. <type>boolean</type>
  93. <value>false</value>
  94. <defaultValue>false</defaultValue>
  95. <label>Core Enabled</label>
  96. <description>Core Enabled resource limit</description>
  97. </Setting>
  98. </Settings>
    1. JSON format
  99. {
  100. settings: [9]

  101. 0: {
  102. path: "status-config/SIP_STATUS_TCP_PORT"
  103. type: "integer"
  104. options: null
  105. value: "5110"
  106. defaultValue: "5110"
  107. label: "MWI TCP Port"
  108. description: null
  109. }-
  110. 1: {
  111. path: "status-config/SIP_STATUS_UDP_PORT"
  112. type: "integer"
  113. options: null
  114. value: "5110"
  115. defaultValue: "5110"
  116. label: "MWI UDP Port"
  117. description: null
  118. }-
  119. 2: {
  120. path: "status-config/SIP_STATUS_HTTP_PORT"
  121. type: "integer"
  122. options: null
  123. value: "8100"
  124. defaultValue: "8100"
  125. label: "MWI HTTP Port"
  126. description: null
  127. }-
  128. 3: {
  129. path: "status-config/SIP_STATUS_LOG_LEVEL"
  130. type: "enum"
  131. options: {
  132. NOTICE: null
  133. CRIT: null
  134. EMERG: null
  135. WARNING: null
  136. ERR: null
  137. INFO: null
  138. ALERT: null
  139. DEBUG: null
  140. }-
  141. value: "NOTICE"
  142. defaultValue: "NOTICE"
  143. label: "Logging Level"
  144. description: "Handling of SUBSCRIBE/NOTIFY messages for voicemail notification control (MWI)"
  145. }-
  146. 4: {
  147. path: "status-config/SIP_STATUS_MAX_EXPIRES"
  148. type: "integer"
  149. options: null
  150. value: null
  151. defaultValue: null
  152. label: "Max expires"
  153. description: null
  154. }-
  155. 5: {
  156. path: "status-config/SIP_STATUS_MIN_EXPIRES"
  157. type: "integer"
  158. options: null
  159. value: null
  160. defaultValue: null
  161. label: "Min expires"
  162. description: null
  163. }-
  164. 6: {
  165. path: "resource-limits/fd-soft"
  166. type: "integer"
  167. options: null
  168. value: "32768"
  169. defaultValue: "32768"
  170. label: "FD Soft"
  171. description: "FD Soft resource limit"
  172. }-
  173. 7: {
  174. path: "resource-limits/fd-hard"
  175. type: "integer"
  176. options: null
  177. value: "65536"
  178. defaultValue: "65536"
  179. label: "FD Hard"
  180. description: "FD Hard resource limit"
  181. }-
  182. 8: {
  183. path: "resource-limits/core-enabled"
  184. type: "boolean"
  185. options: null
  186. value: "false"
  187. defaultValue: "false"
  188. label: "Core Enabled"
  189. description: "Core Enabled resource limit"
  190. }-
  191. -
  192. }
  193. Unsupported HTTP Method: PUT, POST, DELETE


View or modify MWI settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /mwi/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. setting
    1. The MWI setting related information is similar to the one described under /mwi/settings.
  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the MWI settings from the specified path.
        1. Example: XML format
  8. <Setting>
  9. <path>status-config/SIP_STATUS_MAX_EXPIRES</path>
  10. <type>integer</type>
  11. <label>Max expires</label>
  12. </Setting>
    1. JSON format
  13. {
  14. path: "status-config/SIP_STATUS_MAX_EXPIRES"
  15. type: "integer"
  16. options: null
  17. value: null
  18. defaultValue: null
  19. label: "Max expires"
  20. description: null
  21. }
  22. HTTP Method: PUT

Updates the settings of the MWI from the specified path. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the MWI from the specified path.

  1. Unsupported HTTP Method: POST


Phone Groups

  1. Available in 14 starting with 14.10

View or create phone groups

  1. Available in 14 starting with 14.10
  2. Resource URI:/phoneGroups
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. id
    1. Group unique identification number.
    1. name

    Group name.

    1. description

    Short description provided by the user.

    1. weight

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all phone groups.
        1. Example: XML format
  8. <Groups>
  9. <Group>
  10. <id>7</id>
  11. <name>SSComm</name>
  12. <description>desc</description>
  13. <weight>3</weight>
  14. </Group>
  15. <Group>
  16. <id>8</id>
  17. <name>ExpertsComm</name>
  18. <description>desc</description>
  19. <weight>4</weight>
  20. </Group>
  21. </Groups>
    1. JSON format
  22. {
  23. groups: [2]

  24. 0: {
  25. id: 7
  26. name: "SSComm"
  27. description: "desc"
  28. weight: 3
  29. count: null
  30. }-
  31. 1: {
  32. id: 8
  33. name: "ExpertsComm"
  34. description: "desc"
  35. weight: 4
  36. count: null
  37. }-
  38. -
  39. }
  40. Unsupported HTTP Method: PUT, POST, DELETE


View or modify phone groups

  1. Available in 14 starting with 14.10
  2. Resource URI: /phoneGroups/{phoneGroupId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the phone group with the specified ID.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <group>
  10. <id>7</id>
  11. <name>SSComm</name>
  12. <description>desc</description>
  13. <weight>3</weight>
  14. </group>
    1. JSON format
  15. {
  16. id: 7
  17. name: "SSComm"
  18. description: "desc"
  19. weight: 3
  20. count: null
  21. }
  22. HTTP Method: PUT

Updates the phone group. PUT data is plain text.
HTTP Method: DELETE
Deletes the phone group.

  1. Unsupported HTTP Method: POST


Move phone group up in a phone group

  1. Available in 14 starting with 14.10
  2. Resource URI: /{groupId}/up
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: PUT

Move the phone group up. PUT data is plain text.

  1. Unsupported HTTP Method: GET, POST, DELETE


Move phone group down in a phone group

  1. Available in 14 starting with 14.10
  2. Resource URI: /{groupId}/down
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: PUT

Move the phone group down. PUT data is plain text.

  1. Unsupported HTTP Method: GET, POST, DELETE

View settings for specific models in a phone group

  1. Available in 14 starting with 14.10
  2. Resource URI: /{groupId}/models
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. modelId
    1. Model ID.
    1. label

    Model label.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all phone models in the specified group ID.
        1. Example: XML format
  8. <Models>
  9. <Model>
  10. <modelId>SPA501G</modelId>
  11. <label>Cisco SPA501G</label>
  12. </Model>
  13. <Model>
  14. <modelId>SPA502G</modelId>
  15. <label>Cisco SPA502G</label>
  16. </Model>
  17. <Model>
  18. <modelId>SPA504G</modelId>
  19. <label>Cisco SPA504G</label>
  20. </Model>
  21. <Model>
  22. <modelId>SPA508G</modelId>
  23. <label>Cisco SPA508G</label>
  24. </Model>
  25. <Model>
  26. <modelId>SPA509G</modelId>
  27. <label>Cisco SPA509G</label>
  28. </Model>
  29. <Model>
  30. <modelId>SPA525G</modelId>
  31. <label>Cisco SPA525G</label>
  32. </Model>
  33. <Model>
  34. <modelId>yealinkPhoneVP530</modelId>
  35. <label>Yealink VP530</label>
  36. <vendor>Yealink</vendor>
  37. <Versions>
  38. <Version>yealink7X</Version>
  39. </Versions>
  40. </Model>
  41. <Model>
  42. <modelId>yealinkPhoneW52</modelId>
  43. <label>Yealink W52</label>
  44. <vendor>Yealink</vendor>
  45. <Versions>
  46. <Version>yealink7X</Version>
  47. </Versions>
  48. </Model>
  49. </Models>
    1. JSON format
  50. {
  51. models:
  52. {
  53. modelId: "SPA501G"
  54. label: "Cisco SPA501G"
  55. vendor: null
  56. versions: null
  57. }-
  58. {
  59. modelId: "SPA502G"
  60. label: "Cisco SPA502G"
  61. vendor: null
  62. versions: null
  63. }-
  64. {
  65. modelId: "SPA504G"
  66. label: "Cisco SPA504G"
  67. vendor: null
  68. versions: null
  69. }-
  70. {
  71. modelId: "SPA508G"
  72. label: "Cisco SPA508G"
  73. vendor: null
  74. versions: null
  75. }-
  76. {
  77. modelId: "SPA509G"
  78. label: "Cisco SPA509G"
  79. vendor: null
  80. versions: null
  81. }-
  82. {
  83. modelId: "SPA525G"
  84. label: "Cisco SPA525G"
  85. vendor: null
  86. versions: null
  87. }-
  88. {
  89. modelId: "aastra53i"
  90. label: "Aastra SIP IP 53i"
  91. vendor: "Aastra"
  92. versions: null
  93. }
  94. {
  95. modelId: "yealinkPhoneVP530"
  96. label: "Yealink VP530"
  97. vendor: "Yealink"
  98. versions: [1]

  99. 0: "yealink7X"
  100. -
  101. }-
  102. {
  103. modelId: "yealinkPhoneW52"
  104. label: "Yealink W52"
  105. vendor: "Yealink"
  106. versions: [1]

  107. 0: "yealink7X"
  108. -
  109. }-
  110. -
  111. }
  112. Unsupported HTTP Method: PUT, POST, DELETE

View or modify all settings for a phone model in a phone group

  1. Available in 14 starting with 14.10
  2. Resource URI: /{groupId}/model/{modelName}/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the phone group with the specified ID.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>System/Restricted_Access_Domains</path>
  11. <type>string</type>
  12. <label>Restricted Access Domains</label>
  13. </Setting>
  14. <Setting>
  15. <path>System/Enable_Web_Server</path>
  16. <type>boolean</type>
  17. <value>yes</value>
  18. <defaultValue>yes</defaultValue>
  19. <label>Enable Web Server</label>
  20. </Setting>
  21. <Setting>
  22. <path>System/HostName</path>
  23. <type>string</type>
  24. <label>HostName</label>
  25. </Setting>
  26. <Setting>
  27. <path>System/Domain</path>
  28. <type>string</type>
  29. <label>Domain</label>
  30. </Setting>
  31. <Setting>
  32. <path>System/Primary_DNS</path>
  33. <type>string</type>
  34. <label>Primary DNS</label>
  35. </Setting>
  36. <Setting>
  37. <path>System/Secondary_DNS</path>
  38. <type>string</type>
  39. <label>Secondary DNS</label>
  40. </Setting>
  41. <Setting>
  42. <path>User/Headset_Volume</path>
  43. <type>integer</type>
  44. <value>10</value>
  45. <defaultValue>10</defaultValue>
  46. <label>Headset Volume</label>
  47. </Setting>
  48. <Setting>
  49. <path>User/LCD_Contrast</path>
  50. <type>integer</type>
  51. <value>8</value>
  52. <defaultValue>8</defaultValue>
  53. <label>LCD Contrast</label>
  54. </Setting>
  55. <Setting>
  56. <path>User/Back_Light_Timer</path>
  57. <type>enum</type>
  58. <options>
  59. <entry>
  60. <key>Always On</key>
  61. </entry>
  62. <entry>
  63. <key>20 s</key>
  64. </entry>
  65. <entry>
  66. <key>no</key>
  67. </entry>
  68. <entry>
  69. <key>10 s</key>
  70. </entry>
  71. </options>
  72. <label>Back Light Timer</label>
  73. </Setting>
  74. </Settings>

    1. JSON format
  75. {
  76. settings:
  77. {
  78. path: "System/Restricted_Access_Domains"
  79. type: "string"
  80. options: null
  81. value: null
  82. defaultValue: null
  83. label: "Restricted Access Domains"
  84. description: null
  85. }-
  86. {
  87. path: "System/Enable_Web_Server"
  88. type: "boolean"
  89. options: null
  90. value: "yes"
  91. defaultValue: "yes"
  92. label: "Enable Web Server"
  93. description: null
  94. {
  95. path: "System/Domain"
  96. type: "string"
  97. options: null
  98. value: null
  99. defaultValue: null
  100. label: "Domain"
  101. description: null
  102. }-
  103. {
  104. path: "System/Primary_DNS"
  105. type: "string"
  106. options: null
  107. value: null
  108. defaultValue: null
  109. label: "Primary DNS"
  110. description: null
  111. }-
  112. {
  113. path: "System/Secondary_DNS"
  114. type: "string"
  115. options: null
  116. value: null
  117. defaultValue: null
  118. label: "Secondary DNS"
  119. description: null
  120. }
  121. {
  122. path: "User/Back_Light_Timer"
  123. type: "enum"
  124. options: {
  125. Always On: null
  126. 20 s: null
  127. no: null
  128. 10 s: null
  129. }-
  130. value: null
  131. defaultValue: null
  132. label: "Back Light Timer"
  133. description: null
  134. }
  135. }
  136. HTTP Method: PUT

Updates the phone group. PUT data is plain text.
HTTP Method: DELETE
Deletes the phone group.

  1. Unsupported HTTP Method: POST

View or modify one setting for a phone model in a phone group

  1. Available in 14 starting with 14.10
  2. Resource URI: /{groupId}/model/{modelName}/settings/{path:.*}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the setting in the specified path.
        1. Example: XML format

  8. <Setting>
  9. <path>System/Restricted_Access_Domains</path>
  10. <type>string</type>
  11. <label>Restricted Access Domains</label>
  12. </Setting>
    1. JSON format
  13. {
  14. path: "System/Restricted_Access_Domains"
  15. type: "string"
  16. options: null
  17. value: null
  18. defaultValue: null
  19. label: "Restricted Access Domains"
  20. description: null
  21. }
  22. HTTP Method: PUT

Updates the setting in the specified path. PUT data is plain text.
HTTP Method: DELETE
Reverts the setting to the default value.

  1. Unsupported HTTP Method: POST


Music on Hold (MOH)

  1. Available in 14 starting with 14.10

View MOH settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /moh/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. dnsManager
    1. Name of the DNS manager.
    1. dnsTestContext

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all MOH settings.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Settings>
  10. <Setting>
  11. <path>moh-config/MOH_SOURCE</path>
  12. <type>enum</type>
  13. <options>
  14. <entry>
  15. <key>FILES_SRC</key>
  16. <value>System Music Directory</value>
  17. </entry>
  18. <entry>
  19. <key>NONE</key>
  20. <value>None</value>
  21. </entry>
  22. <entry>
  23. <key>SOUNDCARD_SRC</key>
  24. <value>Sound Card</value>
  25. </entry>
  26. </options>
  27. <value>FILES_SRC</value>
  28. <defaultValue>FILES_SRC</defaultValue>
  29. <label>Music On Hold Source</label>
  30. <description>Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold.</description>
  31. </Setting>
    1. JSON format
  32. {
  33. settings: [1]

  34. 0: {
  35. path: "moh-config/MOH_SOURCE"
  36. type: "enum"
  37. options: {
  38. FILES_SRC: "System Music Directory"
  39. NONE: "None"
  40. SOUNDCARD_SRC: "Sound Card"
  41. }-
  42. value: "FILES_SRC"
  43. defaultValue: "FILES_SRC"
  44. label: "Music On Hold Source"
  45. description: "Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold."
  46. }-
  47. -
  48. }
  49. Unsupported HTTP Method: PUT, POST, DELETE


View or change MOH settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /moh/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the setting in the specified path.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Setting>
  10. <path>moh-config/MOH_SOURCE</path>
  11. <type>enum</type>
  12. <options>
  13. <entry>
  14. <key>FILES_SRC</key>
  15. <value>System Music Directory</value>
  16. </entry>
  17. <entry>
  18. <key>NONE</key>
  19. <value>None</value>
  20. </entry>
  21. <entry>
  22. <key>SOUNDCARD_SRC</key>
  23. <value>Sound Card</value>
  24. </entry>
  25. </options>
  26. <value>FILES_SRC</value>
  27. <defaultValue>FILES_SRC</defaultValue>
  28. <label>Music On Hold Source</label>
  29. <description>Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold.</description>
  30. </Setting>xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  31. <Models>
  32. <Model>
  33. <modelId>SPA501G</modelId>
  34. <label>Cisco SPA501G</label>
  35. </Model>
  36. <Model>
  37. <modelId>SPA502G</modelId>
  38. <label>Cisco SPA502G</label>
  39. </Model>
  40. <Model>
  41. <modelId>SPA504G</modelId>
  42. <label>Cisco SPA504G</label>
  43. </Model>
  44. <Model>
  45. <modelId>SPA508G</modelId>
  46. <label>Cisco SPA508G</label>
  47. </Model>
  48. <Model>
  49. <modelId>SPA509G</modelId>
  50. <label>Cisco SPA509G</label>
  51. </Model>
  52. <Model>
  53. <modelId>SPA525G</modelId>
  54. <label>Cisco SPA525G</label>
  55. </Model>
  56. <Model>
  57. <modelId>yealinkPhoneVP530</modelId>
  58. <label>Yealink VP530</label>
  59. <vendor>Yealink</vendor>
  60. <Versions>
  61. <Version>yealink7X</Version>
  62. </Versions>
  63. </Model>
  64. <Model>
  65. <modelId>yealinkPhoneW52</modelId>
  66. <label>Yealink W52</label>
  67. <vendor>Yealink</vendor>
  68. <Versions>
  69. <Version>yealink7X</Version>
  70. </Versions>
  71. </Model>
  72. </Models>
    1. JSON format
  73. {
  74. path: "moh-config/MOH_SOURCE"
  75. type: "enum"
  76. options: {
  77. FILES_SRC: "System Music Directory"
  78. NONE: "None"
  79. SOUNDCARD_SRC: "Sound Card"
  80. }-
  81. value: "FILES_SRC"
  82. defaultValue: "FILES_SRC"
  83. label: "Music On Hold Source"
  84. description: "Selects the source of the on hold music. If set to <em>System Music Directory</em> the server will play all the music files from the system directory on a continuous rotating basis. Setting it to <em>Sound Card</em> will stream audio from the local sound card. <em>None</em> option will disable music on hold."
  85. }
  86. HTTP Method: PUT

Updates the setting in the specified path. PUT data is plain text.
HTTP Method: DELETE
Reverts the setting to the default value.

  1. Unsupported HTTP Method: POST


View prompt MOH messages

  1. Available in 14 starting with 14.10
  2. Resource URI: /moh/prompts
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. dnsManager
    1. Name of the DNS manager.
    1. dnsTestContext

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all MOH prompt messages.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Files>
  10. <File>
  11. <name>default.wav</name>
  12. <size>4029662</size>
  13. <path>/var/sipxdata/mediaserver/data/moh/default.wav</path>
  14. </File>
  15. </Files>
    1. JSON format
  16. {
  17. files: [1]

  18. 0: {
  19. type: null
  20. path: "/var/sipxdata/mediaserver/data/moh/default.wav"
  21. name: "default.wav"
  22. size: 4029662
  23. }-
  24. -
  25. }
  26. HTTP Method: POST
        1. Uploads new prompt messages.
  27. Unsupported HTTP Method: PUT, DELETE


Download MOH prompt

  1. Available in 14 starting with 14.10
  2. Resource URI: /moh/prompts/{promptName}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. dnsManager
    1. Name of the DNS manager.
    1. dnsTestContext

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Downloads the MOH prompt messages based on the file name. For example, use /moh/prompts/default.wav.
        1. Example: N/A
  8. HTTP Method: DELETE
        1. Deletes the specified prompt message.
  9. Unsupported HTTP Method: PUT, POST


Stream to MOH prompt

  1. Available in 14 starting with 14.10
  2. Resource URI: /moh/prompts/{promptName}/stream
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Can be called by clients to stream prompts.
    1. Example: N/A
  7. Unsupported HTTP Method: PUT, POST, DELETE


Registrations

  1. Available in 14 starting with 14.10

View all registrations

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrations
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Filtering Parameters:
    1. Parameter
    1. Description
    1. start
    1. Required. The start date?
    1. limit
    1. Required. The maximum number of results to be displayed.
  6. Specific Response Codes: N/A
  7. HTTP Method: GET
  8. Retrieves all registrations in the system.
        1. Example: XML format
  9. <Registrations>
  10. <Registration>
  11. <contact><sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP></contact>
  12. <expires>1414406900</expires>
  13. <identity>300@dlu.ezuce.ro</identity>
  14. <instrument />
  15. <primary>10.5.0.151</primary>
  16. <regCallId>YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU.</regCallId>
  17. <uri><sip:300@dlu.ezuce.ro;transport=TCP></uri>
  18. <secondsToExpire>3885026</secondsToExpire>
  19. <status>active</status>
  20. </Registration>
  21. <Registrations>
  22. <Registration>
  23. <contact><sip:300@12.18.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP></contact>
  24. <expires>4005065</expires>
  25. <identity>403@dlu.ezuce.ro</identity>
  26. <instrument />
  27. <primary>106.5.60.151</primary>
  28. <regCallId>qWErtyu4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU.</regCallId>
  29. <uri><sip:403@dlu.ezuce.ro;transport=TCP></uri>
  30. <secondsToExpire>3885026</secondsToExpire>
  31. <status>active</status>
  32. </Registration>
  33. </Registrations>
  34. </Registrations>
    1. JSON format
  35. {
  36. registrations:
  37. {
  38. secondsToExpire: 3885065
  39. status: "active"
  40. uri: "<sip:300@dlu.ezuce.ro;transport=TCP>"
  41. primary: "10.521.0.751"
  42. expires: 1414406900
  43. identity: "300@dlu.ezuce.ro"
  44. contact: "<sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP>"
  45. instrument: ""
  46. regCallId: "YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU."
  47. }-
  48. -
  49. }
  50. {
  51. registrations:
  52. {
  53. secondsToExpire: 4005065
  54. status: "active"
  55. uri: "<sip:300@dlu.ezuce.ro;transport=TCP>"
  56. primary: "10.521.0.751"
  57. expires: 1414406900
  58. identity: "403@dlu.ezuce.ro"
  59. contact: "<sip:3403@12.18.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP>"
  60. instrument: ""
  61. regCallId: "qWErtyu4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU."
  62. }-
  63. -
  64. }
  65. Unsupported HTTP Method: PUT, POST, DELETE

Filter registrations by users

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrations/user/{userId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. ID
    1. The ID, name or the alias of the user.

     

  5. Specific Response Codes: N/A
  6. Filtering Parameters:
    1. Parameter
    1. Description
    1. start
    1. Required. The start date?
    1. limit
    1. Required. The maximum number of results to be displayed.

  7. HTTP Method: GET
  8. Retrieves registrations for the specified user.
        1. Example: XML format
  9. <Registrations>
  10. <Registration>
  11. <contact><sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP></contact>
  12. <expires>1414406900</expires>
  13. <identity>300@dlu.ezuce.ro</identity>
  14. <instrument />
  15. <primary>10.521.0.751</primary>
  16. <regCallId>YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU.</regCallId>
  17. <uri><sip:300@dlu.ezuce.ro;transport=TCP></uri>
  18. <secondsToExpire>3885026</secondsToExpire>
  19. <status>active</status>
  20. </Registration>
  21. <Registrations>
    1. JSON format
  22. {
  23. registrations:
  24. {
  25. secondsToExpire: 3885065
  26. status: "active"
  27. uri: "<sip:300@dlu.ezuce.ro;transport=TCP>"
  28. primary: "10.521.0.751"
  29. expires: 1414406900
  30. identity: "300@dlu.ezuce.ro"
  31. contact: "<sip:300@192.168.1.75:47745;rinstance=3a3f20073b10f632;transport=TCP>"
  32. instrument: ""
  33. regCallId: "YWQ2ZDQ4NTVhYThiMWM1M2ZkYjQ5ZTIyMTRmODYzZjU."
  34. }-
  35. -
  36. }
  37. {
  38. HTTP Method: DELETE
        1. Stops registrations for the specified user.
  39. Unsupported HTTP Method: PUT, POST


Filter registrations by MAC addresses

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrations/serialNo/{serialId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. Registrations
    1. The number of registrations for the specified serial number.

     


  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves registrations for the specified MAC addresses.
        1. Example: XML format
  8. <Registrations />
    1. JSON format
  9. {
  10. registrations: [0]

  11. }
  12. HTTP Method: DELETE
        1. Stops registrations for the specified MAC addresses.
  13. Unsupported HTTP Method: PUT, POST


Filter registrations by IPs

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrations/ip/{ip}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves registrations for the specified IP.
        1. Example: XML format

    1. JSON format

  8. HTTP Method: DELETE
        1. Stops registrations for the specified IP.
  9. Unsupported HTTP Method: PUT, POST


Filter registrations by call ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrations/callId/{callId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves registrations for the specified call ID.
        1. Example: XML format

    1. JSON format

  8. HTTP Method: DELETE
        1. Stops registrations for the specified call ID.
  9. Unsupported HTTP Method: PUT, POST


Filter registrations by servers

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrations/server/{serverId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve registrations for server based on internal ID or FQDN.
  8. HTTP Method: DELETE
        1. Stops registrations for the specified server.
  9. Unsupported HTTP Method: PUT, POST


Page groups

  1. Available in 14 starting with 14.10

View or create page groups

  1. Available in 14 starting with 14.10
  2. Resource URI: /pagegroups
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. ID
    1. Unique identification number of the page group.
    1. enabeled

    The status of the page group. Displays True if it is enabled or False if it is disabled.

    1. GroupNumber

    Group number.

    1. timeout

    Timeout, measured in seconds.

    1. sound

    Name of the of the file representing the sound to be played.

    1. description

    Short description provided by the user.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves all the page groups defined in the system.
        1. Example: XML format
  8. <Groups>
  9. <Group>
  10. <id>1</id>
  11. <enabled>true</enabled>
  12. <pageGroupNumber>13</pageGroupNumber>
  13. <timeout>60</timeout>
  14. <sound>notice.wav</sound>
  15. <description>Paging group for team WS.</description>
  16. </Group>
  17. <Group>
  18. <id>2</id>
  19. <enabled>true</enabled>
  20. <pageGroupNumber>9</pageGroupNumber>
  21. <timeout>45</timeout>
  22. <sound>notice.wav</sound>
  23. <description>Paging group for team YTM.</description>
  24. </Group>
  25. </Groups>
    1. JSON format
  26. {
  27. groups: [2]

  28. 0: {
  29. enabled: true
  30. id: 1
  31. description: "Paging group for team WS."
  32. timeout: 60
  33. pageGroupNumber: 13
  34. sound: "notice.wav"
  35. users: null
  36. }-
  37. 1: {
  38. enabled: true
  39. id: 2
  40. description: "Paging group for team YTM."
  41. timeout: 45
  42. pageGroupNumber: 9
  43. sound: "notice.wav"
  44. users: null
  45. }-
  46. -
  47. }
  48. HTTP Method: POST
        1. Creates new page group
  49. Unsupported HTTP Method: PUT, DELETE


View or modify page groups based on page group ID

  1. Available in 14 starting with 14.10

Resource URI: /pagegroups/{pagegroupId}

  1. Default Resource Properties:
  2. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. ID
    1. Unique identification number of the page group.
    1. enabeled

    The status of the page group. Displays True if it is enabled or False if it is disabled.

    1. pageGroupNumber

    Page group number.

    1. timeout

    Timeout, measured in seconds.

    1. sound

    Name of the of the file representing the sound to be played.

    1. description

    Short description provided by the user.

  3. Specific Response Codes: N/A
  4. HTTP Method: GET
  5. Retrieves page groups with the specified ID.
        1. Example: XML format
  6. <Group>
  7. <id>1</id>
  8. <enabled>true</enabled>
  9. <pageGroupNumber>13</pageGroupNumber>
  10. <timeout>60</timeout>
  11. <sound>notice.wav</sound>
  12. <description>Paging group for team WS.</description>
  13. </Group>
    1. JSON format
  14. {
  15. enabled: true
  16. id: 1
  17. description: "Paging group for team WS."
  18. timeout: 60
  19. pageGroupNumber: 13
  20. sound: "notice.wav"
  21. users: null
  22. }
  23. }
  24. HTTP Method: PUT
        1. Modifies page groups with the specified ID.
  25. HTTP Method: DELETE
        1. Deletes page groups with the specified ID.

Unsupported HTTP Method: PUT, POST

Manage page groups services

  1. Available in 14 starting with 14.10
  2. Resource URI: /pagegroups/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. path
    1. type

     

    1. value

     

    1. defaultValue

     

    1. label

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves general service options for the page groups in the system.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>page-config/prefix</path>
  11. <type>string</type>
  12. <value>*77</value>
  13. <defaultValue>*77</defaultValue>
  14. <label>Paging prefix</label>
  15. </Setting>
  16. <Setting>
  17. <path>page-config/sip.trace</path>
  18. <type>enum</type>
  19. <options>
  20. <entry>
  21. <key>NONE</key>
  22. </entry>
  23. <entry>
  24. <key>DEBUG</key>
  25. </entry>
  26. <entry>
  27. <key>TRACE</key>
  28. </entry>
  29. </options>
  30. <value>NONE</value>
  31. <defaultValue>NONE</defaultValue>
  32. <label>SIP Trace Level</label>
  33. </Setting>
  34. <Setting>
  35. <path>page-config/sip.tcpPort</path>
  36. <type>integer</type>
  37. <value>5160</value>
  38. <defaultValue>5160</defaultValue>
  39. <label>SIP TCP Port</label>
  40. </Setting>
  41. <Setting>
  42. <path>page-config/sip.udpPort</path>
  43. <type>integer</type>
  44. <value>5160</value>
  45. <defaultValue>5160</defaultValue>
  46. <label>SIP UDP Port</label>
  47. </Setting>
  48. <Setting>
  49. <path>page-config/sip.tlsPort</path>
  50. <type>integer</type>
  51. <value>5161</value>
  52. <defaultValue>5161</defaultValue>
  53. <label>SIP TLS Port</label>
  54. </Setting>
  55. <Setting>
  56. <path>page-config/rtp.port</path>
  57. <type>integer</type>
  58. <value>8500</value>
  59. <defaultValue>8500</defaultValue>
  60. <label>SIP RTP Port</label>
  61. </Setting>
  62. <Setting>
  63. <path>page-config/max.sessions</path>
  64. <type>integer</type>
  65. <value>50</value>
  66. <defaultValue>50</defaultValue>
  67. </Setting>
  68. <Setting>
  69. <path>page-config/log.level</path>
  70. <type>enum</type>
  71. <options>
  72. <entry>
  73. <key>NOTICE</key>
  74. </entry>
  75. <entry>
  76. <key>CRIT</key>
  77. </entry>
  78. <entry>
  79. <key>EMERG</key>
  80. </entry>
  81. <entry>
  82. <key>WARNING</key>
  83. </entry>
  84. <entry>
  85. <key>ERR</key>
  86. </entry>
  87. <entry>
  88. <key>INFO</key>
  89. </entry>
  90. <entry>
  91. <key>ALERT</key>
  92. </entry>
  93. <entry>
  94. <key>DEBUG</key>
  95. </entry>
  96. </options>
  97. <value>NOTICE</value>
  98. <defaultValue>NOTICE</defaultValue>
  99. <label>Log Level</label>
  100. </Setting>
  101. </Settings>
    1. JSON format
  102. {
  103. settings: [8]

  104. 0: {
  105. path: "page-config/prefix"
  106. type: "string"
  107. options: null
  108. value: "*77"
  109. defaultValue: "*77"
  110. label: "Paging prefix"
  111. description: null
  112. }-
  113. 1: {
  114. path: "page-config/sip.trace"
  115. type: "enum"
  116. options: {
  117. NONE: null
  118. DEBUG: null
  119. TRACE: null
  120. }-
  121. value: "NONE"
  122. defaultValue: "NONE"
  123. label: "SIP Trace Level"
  124. description: null
  125. }-
  126. 2: {
  127. path: "page-config/sip.tcpPort"
  128. type: "integer"
  129. options: null
  130. value: "5160"
  131. defaultValue: "5160"
  132. label: "SIP TCP Port"
  133. description: null
  134. }-
  135. 3: {
  136. path: "page-config/sip.udpPort"
  137. type: "integer"
  138. options: null
  139. value: "5160"
  140. defaultValue: "5160"
  141. label: "SIP UDP Port"
  142. description: null
  143. }-
  144. 4: {
  145. path: "page-config/sip.tlsPort"
  146. type: "integer"
  147. options: null
  148. value: "5161"
  149. defaultValue: "5161"
  150. label: "SIP TLS Port"
  151. description: null
  152. }-
  153. 5: {
  154. path: "page-config/rtp.port"
  155. type: "integer"
  156. options: null
  157. value: "8500"
  158. defaultValue: "8500"
  159. label: "SIP RTP Port"
  160. description: null
  161. }-
  162. 6: {
  163. path: "page-config/max.sessions"
  164. type: "integer"
  165. options: null
  166. value: "50"
  167. defaultValue: "50"
  168. label: null
  169. description: null
  170. }-
  171. 7: {
  172. path: "page-config/log.level"
  173. type: "enum"
  174. options: {
  175. NOTICE: null
  176. CRIT: null
  177. EMERG: null
  178. WARNING: null
  179. ERR: null
  180. INFO: null
  181. ALERT: null
  182. DEBUG: null
  183. }-
  184. value: "NOTICE"
  185. defaultValue: "NOTICE"
  186. label: "Log Level"
  187. description: null
  188. }-
  189. -
  190. }
  191. HTTP Method: PUT
        1. Stops registrations for the specified call ID.
  192. HTTP Method: DELETE
        1. Stops registrations for the specified call ID.
  193. Unsupported HTTP Method: PUT, POST


View or create new prompt message

  1. Available in 14 starting with 14.10
  2. Resource URI: /pagegroups/prompts
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list of page groups prompts.
        1. Example: XML format
  8. <Files>
  9. <File>
  10. <name>attention.wav</name>
  11. <size>71796</size>
  12. <path>/var/sipxdata/sipxpage/music/attention.wav</path>
  13. </File>
  14. <File>
  15. <name>TadaTada.wav</name>
  16. <size>70104</size>
  17. <path>/var/sipxdata/sipxpage/music/TadaTada.wav</path>
  18. </File>
  19. <File>
  20. <name>fluffy.wav</name>
  21. <size>100564</size>
  22. <path>/var/sipxdata/sipxpage/music/fluffy.wav</path>
  23. </File>
  24. <File>
  25. <name>notice.wav</name>
  26. <size>34566</size>
  27. <path>/var/sipxdata/sipxpage/music/notice.wav</path>
  28. </File>
  29. <File>
  30. <name>fanfare.wav</name>
  31. <size>34904</size>
  32. <path>/var/sipxdata/sipxpage/music/fanfare.wav</path>
  33. </File>
  34. <File>
  35. <name>reveille.wav</name>
  36. <size>56566</size>
  37. <path>/var/sipxdata/sipxpage/music/reveille.wav</path>
  38. </File>
  39. <File>
  40. <name>nowhearthis.wav</name>
  41. <size>51150</size>
  42. <path>/var/sipxdata/sipxpage/music/nowhearthis.wav</path>
  43. </File>
  44. </Files>
    1. JSON format
  45. {
  46. files: [7]

  47. 0: {
  48. type: null
  49. path: "/var/sipxdata/sipxpage/music/attention.wav"
  50. name: "attention.wav"
  51. size: 71796
  52. }-
  53. 1: {
  54. type: null
  55. path: "/var/sipxdata/sipxpage/music/TadaTada.wav"
  56. name: "TadaTada.wav"
  57. size: 70104
  58. }-
  59. 2: {
  60. type: null
  61. path: "/var/sipxdata/sipxpage/music/fluffy.wav"
  62. name: "fluffy.wav"
  63. size: 100564
  64. }-
  65. 3: {
  66. type: null
  67. path: "/var/sipxdata/sipxpage/music/notice.wav"
  68. name: "notice.wav"
  69. size: 34566
  70. }-
  71. 4: {
  72. type: null
  73. path: "/var/sipxdata/sipxpage/music/fanfare.wav"
  74. name: "fanfare.wav"
  75. size: 34904
  76. }-
  77. 5: {
  78. type: null
  79. path: "/var/sipxdata/sipxpage/music/reveille.wav"
  80. name: "reveille.wav"
  81. size: 56566
  82. }-
  83. 6: {
  84. type: null
  85. path: "/var/sipxdata/sipxpage/music/nowhearthis.wav"
  86. name: "nowhearthis.wav"
  87. size: 51150
  88. }-
  89. -
  90. }
  91. HTTP Method: POST
        1. Uploads new prompt message.
  92. Unsupported HTTP Method: PUT, DELETE


Download page group prompt

  1. Available in 14 starting with 14.10
  2. Resource URI: /pagegroups/prompts/{promptName}
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Downloads prompt messages based on the specified file name.
        1. Example: N/A
  7. HTTP Method: DELETE
        1. Deletes prompt messages based on the specified file name.
  8. Unsupported HTTP Method: PUT, POST


Stream to page group prompt

  1. Available in 14 starting with 14.10
  2. Resource URI: /pagegroups/prompts/{promptName}/stream
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: GET
          1. Example: N/A
  6. Unsupported HTTP Method: PUT, POST, DELETE


Park orbit

  1. Available in 14 starting with 14.10

View system orbits

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Downloads prompt messages based on the specified file name.
        1. Example: XML format
  8. <Orbit><id>%s</id><name>remoteOrbit</name>"
  9. "<enabled>true</enabled><extension>5678</extension><description>remote orbit</description><music>default.wav</music>"
  10. "<server>remote.example.org</server></Orbit>"
    1. JSON format
  11. "{\"orbits\":[{\"id\":%s,\"name\":\"primaryOrbit\",\"enabled\":true,\"extension\":\"1234\","

  12. "\"description\":\"custom orbit\",\"music\":\"default.wav\",\"server\":\"primary.example.org\"}]}"
  13. HTTP Method: POST
        1. Deletes prompt messages based on the specified file name.
  14. Unsupported HTTP Method: PUT, DELETE

View or modify system orbits

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits/{orbitId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves the orbit with the specified ID.
        1. Example: XML format
  8. <Orbits><Orbit><id>%s</id><name>primaryOrbit</name>"
  9. "<enabled>true</enabled><extension>1234</extension><description>custom orbit</description><music>default.wav</music>"
  10. "<server>primary.example.org</server></Orbit>"
  11. "<Orbit><id>%s</id><name>remoteOrbit</name><enabled>false</enabled><extension>5678</extension>"
  12. "<description>remote orbit changed</description><music>default.wav</music><server>primary.example.org</server></Orbit></Orbits>",
    1. JSON format
  13. "{\"orbits\":[{\"id\":%s,\"name\":\"primaryOrbit\",\"enabled\":true,\"extension\":\"1234\","

  14. "\"description\":\"custom orbit\",\"music\":\"default.wav\",\"server\":\"primary.example.org\"},"
  15. "{\"id\":%s,\"name\":\"remoteOrbit\",\"enabled\":false,\"extension\":\"5678\","
  16. "\"description\":\"remote orbit changed\",\"music\":\"default.wav\",\"server\":\"primary.example.org\"}]}",
  17. HTTP Method: PUT
        1. Modifies orbit based with the specified ID.
  18. HTTP Method: DELETE
        1. Deletes orbit based with the specified ID.
  19. Unsupported HTTP Method: PUT, POST


Manage orbit options

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits/{orbitId}/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves service options for the specified orbit ID.
        1. Example: XML format
  8. ><Setting><path>general/parkTimeout</path>"
  9. "<type>integer</type><value>120</value><defaultValue>120</defaultValue><label>Park time-out</label>"
  10. "<description>Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.</description></Setting>"
    1. JSON format
  11. "{\"path\":\"general/parkTimeout\",\"type\":\"integer\",\"options\":null,\"value\":\"120\",\"defaultValue\":\"120\","
  12. "\"label\":\"Park time-out\",\"description\":\"Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.\"}"
  13. HTTP Method: PUT
        1. Modifies service options for the specified orbit ID.
  14. HTTP Method: DELETE
        1. Deletes service options for the specified orbit ID.
  15. Unsupported HTTP Method: PUT, POST


Manage orbit services

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits/{orbitId}/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves general service options.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>general/enableTimeout</path>
  11. <type>boolean</type>
  12. <value>1</value>
  13. <defaultValue>1</defaultValue>
  14. <label>Enable time-out</label>
  15. <description>If enabled, the call will be automatically transfered back to the extension that parked the call once the time specified in Park timeout has elapsed.</description>
  16. </Setting>
  17. <Setting>
  18. <path>general/parkTimeout</path>
  19. <type>integer</type>
  20. <value>120</value>
  21. <defaultValue>120</defaultValue>
  22. <label>Park time-out</label>
  23. <description>Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.</description>
  24. </Setting>
  25. <Setting>
  26. <path>general/multipleCalls</path>
  27. <type>boolean</type>
  28. <value>1</value>
  29. <defaultValue>1</defaultValue>
  30. <label>Allow multiple calls</label>
  31. <description>If checked, more than one call can be parked on the orbit at the same time. Calls are retrieved in the order in which they were parked.</description>
  32. </Setting>
  33. <Setting>
  34. <path>general/allowTransfer</path>
  35. <type>boolean</type>
  36. <value>1</value>
  37. <defaultValue>1</defaultValue>
  38. <label>Allow transfer</label>
  39. <description>If checked, callers put on park are able to transfer the call back to the extension that parked the call by pressing 0. You can configure a different transfer key in the advanced section.</description>
  40. </Setting>
  41. <Setting>
  42. <path>general/transferKey</path>
  43. <type>string</type>
  44. <value>0</value>
  45. <defaultValue>0</defaultValue>
  46. <label>Transfer key</label>
  47. <description>Pressing the transfer key defined here will transfer the call back to the extension that parked the call. Allow transfer has to be enabled.</description>
  48. </Setting>
  49. </Settings>
    1. JSON format
  50. {
  51. settings:
  52. {
  53. path: "general/enableTimeout"
  54. type: "boolean"
  55. options: null
  56. value: "1"
  57. defaultValue: "1"
  58. label: "Enable time-out"
  59. description: "If enabled, the call will be automatically transfered back to the extension that parked the call once the time specified in Park timeout has elapsed."
  60. }-
  61. {
  62. path: "general/parkTimeout"
  63. type: "integer"
  64. options: null
  65. value: "120"
  66. defaultValue: "120"
  67. label: "Park time-out"
  68. description: "Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled."
  69. }-
  70. {
  71. path: "general/multipleCalls"
  72. type: "boolean"
  73. options: null
  74. value: "1"
  75. defaultValue: "1"
  76. label: "Allow multiple calls"
  77. description: "If checked, more than one call can be parked on the orbit at the same time. Calls are retrieved in the order in which they were parked."
  78. }-
  79. {
  80. path: "general/allowTransfer"
  81. type: "boolean"
  82. options: null
  83. value: "1"
  84. defaultValue: "1"
  85. label: "Allow transfer"
  86. description: "If checked, callers put on park are able to transfer the call back to the extension that parked the call by pressing 0. You can configure a different transfer key in the advanced section."
  87. }-
  88. {
  89. path: "general/transferKey"
  90. type: "string"
  91. options: null
  92. value: "0"
  93. defaultValue: "0"
  94. label: "Transfer key"
  95. description: "Pressing the transfer key defined here will transfer the call back to the extension that parked the call. Allow transfer has to be enabled."
  96. }-
  97. -
  98. }<Settings>
  99. <Setting>
  100. <path>general/enableTimeout</path>
  101. <type>boolean</type>
  102. <value>1</value>
  103. <defaultValue>1</defaultValue>
  104. <label>Enable time-out</label>
  105. <description>If enabled, the call will be automatically transfered back to the extension that parked the call once the time specified in Park timeout has elapsed.</description>
  106. </Setting>
  107. <Setting>
  108. <path>general/parkTimeout</path>
  109. <type>integer</type>
  110. <value>120</value>
  111. <defaultValue>120</defaultValue>
  112. <label>Park time-out</label>
  113. <description>Time period in seconds, after which the call is automatically transferred back to the extension that parked the call if time-out is enabled.</description>
  114. </Setting>
  115. <Setting>
  116. <path>general/multipleCalls</path>
  117. <type>boolean</type>
  118. <value>1</value>
  119. <defaultValue>1</defaultValue>
  120. <label>Allow multiple calls</label>
  121. <description>If checked, more than one call can be parked on the orbit at the same time. Calls are retrieved in the order in which they were parked.</description>
  122. </Setting>
  123. <Setting>
  124. <path>general/allowTransfer</path>
  125. <type>boolean</type>
  126. <value>1</value>
  127. <defaultValue>1</defaultValue>
  128. <label>Allow transfer</label>
  129. <description>If checked, callers put on park are able to transfer the call back to the extension that parked the call by pressing 0. You can configure a different transfer key in the advanced section.</description>
  130. </Setting>
  131. <Setting>
  132. <path>general/transferKey</path>
  133. <type>string</type>
  134. <value>0</value>
  135. <defaultValue>0</defaultValue>
  136. <label>Transfer key</label>
  137. <description>Pressing the transfer key defined here will transfer the call back to the extension that parked the call. Allow transfer has to be enabled.</description>
  138. </Setting>
  139. </Settings>
  140. HTTP Method: PUT
        1. Modifies general service options.
  141. HTTP Method: DELETE
        1. Deletes general service options.
  142. Unsupported HTTP Method: PUT, POST

View or create new prompt message

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits/prompts
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list of orbit prompts.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Files>
  10. <File>
  11. <name>default.wav</name>
  12. <size>4029662</size>
  13. <path>/var/sipxdata/parkserver/music/default.wav</path>
  14. </File>
  15. </Files>
    1. JSON format
  16. {
  17. files: [1]

  18. 0: {
  19. type: null
  20. path: "/var/sipxdata/parkserver/music/default.wav"
  21. name: "default.wav"
  22. size: 4029662
  23. }-
  24. -
  25. }
  26. HTTP Method: POST
        1. Uploads new prompt message.
  27. Unsupported HTTP Method: PUT, DELETE


Download orbit prompt

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits/prompts/{promptName}
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Downloads prompt messages based on the specified file name.
        1. Example: N/A
  7. HTTP Method: DELETE
        1. Deletes prompt messages based on the specified file name.
  8. Unsupported HTTP Method: PUT, POST

Stream to orbit prompt

  1. Available in 14 starting with 14.10
  2. Resource URI: /orbits/prompts/{promptName}/stream
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: GET
          1. Example: N/A
  6. Unsupported HTTP Method: PUT, POST, DELETE

Proxy

  1. Available in 14 starting with 14.10

View proxy settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /proxy/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list with all the proxy settings in the system.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Settings>
  10. <Setting>
  11. <path>proxy-configuration/SIPX_PROXY_DEFAULT_SERIAL_EXPIRES</path>
  12. <type>integer</type>
  13. <value>20</value>
  14. <defaultValue>20</defaultValue>
  15. <label>Default Serial Fork Expiration</label>
  16. <description>Number of seconds that each phone in a sequential series is allowed to ring with no answer before the next alternative is tried. The most common case for this is a user with one phone and a voice mailbox - the phone will ring for this many seconds and then roll over to voice mail.</description>
  17. </Setting>
  18. <Setting>
  19. <path>proxy-configuration/SIPX_PROXY_DEFAULT_EXPIRES</path>
  20. <type>integer</type>
  21. <value>300</value>
  22. <defaultValue>300</defaultValue>
  23. <label>Default Expiration</label>
  24. <description>Number of seconds a call is allowed to go unanswered; if this many seconds pass, the call request is returned with an error.</description>
  25. </Setting>
  26. <Setting>
  27. <path>proxy-configuration/SIPX_PROXY_LOG_LEVEL</path>
  28. <type>enum</type>
  29. <options>
  30. <entry>
  31. <key>NOTICE</key>
  32. </entry>
  33. <entry>
  34. <key>CRIT</key>
  35. </entry>
  36. <entry>
  37. <key>EMERG</key>
  38. </entry>
  39. <entry>
  40. <key>WARNING</key>
  41. </entry>
  42. <entry>
  43. <key>ERR</key>
  44. </entry>
  45. <entry>
  46. <key>INFO</key>
  47. </entry>
  48. <entry>
  49. <key>ALERT</key>
  50. </entry>
  51. <entry>
  52. <key>DEBUG</key>
  53. </entry>
  54. </options>
  55. <value>NOTICE</value>
  56. <defaultValue>NOTICE</defaultValue>
  57. <label>Log Level</label>
  58. </Setting>
  59. <Setting>
  60. <path>proxy-configuration/SIPX_PROXY_AUTHENTICATE_ALGORITHM</path>
  61. <type>string</type>
  62. <label>Authenticate Algorithm</label>
  63. <description>The algorithm used in authentication</description>
  64. </Setting>
  65. <Setting>
  66. <path>proxy-configuration/SIPX_PROXY_MAX_FORWARDS</path>
  67. <type>integer</type>
  68. <label>Maximum Forwards</label>
  69. <description>(Max-Forwards header field)Maximum number of hops a request can transit on the way to its destination.</description>
  70. </Setting>
  71. <Setting>
  72. <path>proxy-configuration/SIPX_PROXY_STALE_TCP_TIMEOUT</path>
  73. <type>integer</type>
  74. <label>Stale TCP Timeout</label>
  75. <description />
  76. </Setting>
  77. <Setting>
  78. <path>proxy-configuration/SIPX_PROXY_ENSURE_TCP_LIFETIME</path>
  79. <type>boolean</type>
  80. <value>0</value>
  81. <defaultValue>0</defaultValue>
  82. <label>Ensure TCP Lifetime</label>
  83. <description />
  84. </Setting>
  85. <Setting>
  86. <path>proxy-configuration/SIPX_PROXY_RELAY_ALLOWED</path>
  87. <type>boolean</type>
  88. <value>1</value>
  89. <defaultValue>1</defaultValue>
  90. <label>Allow Non-Local Domain Relay</label>
  91. <description>If checked, proxy can act as a relay for non-local domain transactions. If you are using external phone features for phone lines, you must allow relaying.</description>
  92. </Setting>
  93. </setting>
    1. JSON format
  94. {
  95. settings: [26]

  96. 0: {
  97. path: "proxy-configuration/SIPX_PROXY_DEFAULT_SERIAL_EXPIRES"
  98. type: "integer"
  99. options: null
  100. value: "20"
  101. defaultValue: "20"
  102. label: "Default Serial Fork Expiration"
  103. description: "Number of seconds that each phone in a sequential series is allowed to ring with no answer before the next alternative is tried. The most common case for this is a user with one phone and a voice mailbox - the phone will ring for this many seconds and then roll over to voice mail."
  104. }-
  105. 1: {
  106. path: "proxy-configuration/SIPX_PROXY_DEFAULT_EXPIRES"
  107. type: "integer"
  108. options: null
  109. value: "300"
  110. defaultValue: "300"
  111. label: "Default Expiration"
  112. description: "Number of seconds a call is allowed to go unanswered; if this many seconds pass, the call request is returned with an error."
  113. }-
  114. 2: {
  115. path: "proxy-configuration/SIPX_PROXY_LOG_LEVEL"
  116. type: "enum"
  117. options: {
  118. NOTICE: null
  119. CRIT: null
  120. EMERG: null
  121. WARNING: null
  122. ERR: null
  123. INFO: null
  124. ALERT: null
  125. DEBUG: null
  126. }-
  127. value: "NOTICE"
  128. defaultValue: "NOTICE"
  129. label: "Log Level"
  130. description: null
  131. }-
  132. 3: {
  133. path: "proxy-configuration/SIPX_PROXY_AUTHENTICATE_ALGORITHM"
  134. type: "string"
  135. options: null
  136. value: null
  137. defaultValue: null
  138. label: "Authenticate Algorithm"
  139. description: "The algorithm used in authentication"
  140. }-
  141. 4: {
  142. path: "proxy-configuration/SIPX_PROXY_MAX_FORWARDS"
  143. type: "integer"
  144. options: null
  145. value: null
  146. defaultValue: null
  147. label: "Maximum Forwards"
  148. description: "(Max-Forwards header field)Maximum number of hops a request can transit on the way to its destination."
  149. }-
  150. 5: {
  151. path: "proxy-configuration/SIPX_PROXY_STALE_TCP_TIMEOUT"
  152. type: "integer"
  153. options: null
  154. value: null
  155. defaultValue: null
  156. label: "Stale TCP Timeout"
  157. description: ""
  158. }-
  159. 6: {
  160. path: "proxy-configuration/SIPX_PROXY_ENSURE_TCP_LIFETIME"
  161. type: "boolean"
  162. options: null
  163. value: "0"
  164. defaultValue: "0"
  165. label: "Ensure TCP Lifetime"
  166. description: ""
  167. }-
  168. 7: {
  169. path: "proxy-configuration/SIPX_PROXY_RELAY_ALLOWED"
  170. type: "boolean"
  171. options: null
  172. value: "1"
  173. defaultValue: "1"
  174. label: "Allow Non-Local Domain Relay"
  175. description: "If checked, proxy can act as a relay for non-local domain transactions. If you are using external phone features for phone lines, you must allow relaying."
  176. }
  177. Unsupported HTTP Method: PUT, POST, DELETE

View or modify proxy settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /proxy/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves CDR options for the setting from the specified path.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Setting>
  10. <path>msftxchghack/EXCHANGE_SERVER_FQDN</path>
  11. <type>string</type>
  12. <label>Trusted Microsoft Exchange Server</label>
  13. <description>Fully Qualified Domain Name of Trusted Microsoft Exchange Server</description>
  14. </Setting>
    1. JSON format
  15. {
  16. path: "msftxchghack/EXCHANGE_SERVER_FQDN"
  17. type: "string"
  18. options: null
  19. value: null
  20. defaultValue: null
  21. label: "Trusted Microsoft Exchange Server"
  22. description: "Fully Qualified Domain Name of Trusted Microsoft Exchange Server"
  23. }
  24. HTTP Method: PUT
        1. Modifies proxy options for the setting from the specified path.
  25. HTTP Method: DELETE
        1. Deletes proxy options for the setting from the specified path.
  26. Unsupported HTTP Method: POST


My buddy

  1. Available in 14 starting with 14.10

View My buddy settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /imbot/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list with all the My buddy settings in the system.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Settings>
  10. <Setting>
  11. <path>imbot/log.level</path>
  12. <type>enum</type>
  13. <options>
  14. <entry>
  15. <key>NOTICE</key>
  16. </entry>
  17. <entry>
  18. <key>CRIT</key>
  19. </entry>
  20. <entry>
  21. <key>EMERG</key>
  22. </entry>
  23. <entry>
  24. <key>WARNING</key>
  25. </entry>
  26. <entry>
  27. <key>ERR</key>
  28. </entry>
  29. <entry>
  30. <key>INFO</key>
  31. </entry>
  32. <entry>
  33. <key>ALERT</key>
  34. </entry>
  35. <entry>
  36. <key>DEBUG</key>
  37. </entry>
  38. </options>
  39. <value>NOTICE</value>
  40. <defaultValue>NOTICE</defaultValue>
  41. <label>Logging Level</label>
  42. </Setting>
  43. <Setting>
  44. <path>imbot/_imbot.paUserName</path>
  45. <type>string</type>
  46. <value>mybuddy</value>
  47. <defaultValue>mybuddy</defaultValue>
  48. <label>IM ID</label>
  49. <description>The ID under which ImBot feature is visible in the contact list.</description>
  50. </Setting>
  51. <Setting>
  52. <path>imbot/imbot.paPassword</path>
  53. <type>string</type>
  54. <label>IM password</label>
  55. <description>If IM server is configured to use LDAP you need to assign a dedicated account to play MyBuddy role. Set MyBuddy's password accordingly with LDAP account password. Leave the default password if IM server is not configured to use LDAP.</description>
  56. </Setting>
  57. </Settings>
    1. JSON format
  58. {
  59. settings: [3]

  60. 0: {
  61. path: "imbot/log.level"
  62. type: "enum"
  63. options: {
  64. NOTICE: null
  65. CRIT: null
  66. EMERG: null
  67. WARNING: null
  68. ERR: null
  69. INFO: null
  70. ALERT: null
  71. DEBUG: null
  72. }-
  73. value: "NOTICE"
  74. defaultValue: "NOTICE"
  75. label: "Logging Level"
  76. description: null
  77. }-
  78. 1: {
  79. path: "imbot/_imbot.paUserName"
  80. type: "string"
  81. options: null
  82. value: "mybuddy"
  83. defaultValue: "mybuddy"
  84. label: "IM ID"
  85. description: "The ID under which ImBot feature is visible in the contact list."
  86. }-
  87. 2: {
  88. path: "imbot/imbot.paPassword"
  89. type: "string"
  90. options: null
  91. value: null
  92. defaultValue: null
  93. label: "IM password"
  94. description: "If IM server is configured to use LDAP you need to assign a dedicated account to play MyBuddy role. Set MyBuddy's password accordingly with LDAP account password. Leave the default password if IM server is not configured to use LDAP."
  95. }-
  96. -
  97. }
  98. Unsupported HTTP Method: PUT, POST, DELETE

View or modify My buddy settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /imbot/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves My buddy options for the setting from the specified path.
        1. Example: XML format
  8. <Setting>
  9. <path>imbot/_imbot.paUserName</path>
  10. <type>string</type>
  11. <value>mybuddy</value>
  12. <defaultValue>mybuddy</defaultValue>
  13. <label>IM ID</label>
  14. <description>The ID under which ImBot feature is visible in the contact list.</description>
  15. </Setting>
    1. JSON format
  16. {
  17. path: "imbot/_imbot.paUserName"
  18. type: "string"
  19. options: null
  20. value: "mybuddy"
  21. defaultValue: "mybuddy"
  22. label: "IM ID"
  23. description: "The ID under which ImBot feature is visible in the contact list."
  24. }
  25. HTTP Method: PUT
        1. Modifies My buddy options for the setting from the specified path.
  26. HTTP Method: DELETE
        1. Deletes My buddy options for the setting from the specified path.
  27. Unsupported HTTP Method: POST


Registrar

  1. Available in 14 starting with 14.10

View registrar settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrar/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list with all the registrars' settings in the system.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>registrar-config/SIP_REGISTRAR_TCP_PORT</path>
  11. <type>integer</type>
  12. <value>5070</value>
  13. <defaultValue>5070</defaultValue>
  14. <label>TCP Port</label>
  15. <description />
  16. </Setting>
  17. <Setting>
  18. <path>registrar-config/SIP_REGISTRAR_UDP_PORT</path>
  19. <type>integer</type>
  20. <value>5070</value>
  21. <defaultValue>5070</defaultValue>
  22. <label>UDP Port</label>
  23. <description />
  24. </Setting>
  25. <Setting>
  26. <path>registrar-config/SIP_REGISTRAR_REG_EVENT_PORT</path>
  27. <type>integer</type>
  28. <value>5075</value>
  29. <defaultValue>5075</defaultValue>
  30. <label>Registrar Event Port</label>
  31. <description />
  32. </Setting>
  33. <Setting>
  34. <path>registrar-config/SIP_REGISTRAR_XMLRPC_PORT</path>
  35. <type>integer</type>
  36. <value>5077</value>
  37. <defaultValue>5077</defaultValue>
  38. <label>XMLRPC Port</label>
  39. <description />
  40. </Setting>
  41. <Setting>
  42. <path>registrar-config/_SIP_REGISTRAR_PRESENCE_PORT</path>
  43. <type>integer</type>
  44. <value>9096</value>
  45. <defaultValue>9096</defaultValue>
  46. <label>Presence Port</label>
  47. <description />
  48. </Setting>
  49. <Setting>
  50. <path>resource-limits/core-enabled</path>
  51. <type>boolean</type>
  52. <value>false</value>
  53. <defaultValue>false</defaultValue>
  54. <label>Core Enabled</label>
  55. <description>Core Enabled resource limit</description>
  56. </Setting>
  57. </Settings>
    1. JSON format
  58. {
  59. settings: [35]

  60. 0: {
  61. path: "registrar-config/SIP_REGISTRAR_TCP_PORT"
  62. type: "integer"
  63. options: null
  64. value: "5070"
  65. defaultValue: "5070"
  66. label: "TCP Port"
  67. description: ""
  68. }-
  69. 1: {
  70. path: "registrar-config/SIP_REGISTRAR_UDP_PORT"
  71. type: "integer"
  72. options: null
  73. value: "5070"
  74. defaultValue: "5070"
  75. label: "UDP Port"
  76. description: ""
  77. }-
  78. 2: {
  79. path: "registrar-config/SIP_REGISTRAR_REG_EVENT_PORT"
  80. type: "integer"
  81. options: null
  82. value: "5075"
  83. defaultValue: "5075"
  84. label: "Registrar Event Port"
  85. description: ""
  86. }-
  87. 3: {
  88. path: "registrar-config/SIP_REGISTRAR_XMLRPC_PORT"
  89. type: "integer"
  90. options: null
  91. value: "5077"
  92. defaultValue: "5077"
  93. label: "XMLRPC Port"
  94. description: ""
  95. }-
  96. 4: {
  97. path: "registrar-config/_SIP_REGISTRAR_PRESENCE_PORT"
  98. type: "integer"
  99. options: null
  100. value: "9096"
  101. defaultValue: "9096"
  102. label: "Presence Port"
  103. description: ""
  104. }
  105. Unsupported HTTP Method: PUT, POST, DELETE

View or modify registrar settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /registrar/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves registrars' options for the setting from the specified path.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Setting>
  10. <path>other/SIPX_SEND_TRYING_FOR_NIST</path>
  11. <type>boolean</type>
  12. <value>true</value>
  13. <defaultValue>true</defaultValue>
  14. <label>Send 'Trying' response on registrations</label>
  15. <description>By sending a SIP '100 Trying' response on registrations phones will continue to wait. In HA enviroments you'd prefer phones try another proxy and so you might prefer to disable this.</description>
  16. </Setting>
    1. JSON format
  17. {
  18. path: "other/SIPX_SEND_TRYING_FOR_NIST"
  19. type: "boolean"
  20. options: null
  21. value: "true"
  22. defaultValue: "true"
  23. label: "Send 'Trying' response on registrations"
  24. description: "By sending a SIP '100 Trying' response on registrations phones will continue to wait. In HA enviroments you'd prefer phones try another proxy and so you might prefer to disable this."
  25. }
  26. HTTP Method: PUT
        1. Modifies registrars' options options for the setting from the specified path.
  27. HTTP Method: DELETE
        1. Deletes registrars' options options for the setting from the specified path.
  28. Unsupported HTTP Method: POST


Shared Appearance Agent (SAA)

  1. Available in 14 starting with 14.10

View SAA settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /saa/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list with all the SAA settings in the system.
        1. Example: XML format
  8. <Settings>
  9. <Setting>
  10. <path>openuc-saa-config/server-udp-port</path>
  11. <type>integer</type>
  12. <value>5170</value>
  13. <defaultValue>5170</defaultValue>
  14. <label>UDP Port</label>
  15. </Setting>
  16. <Setting>
  17. <path>openuc-saa-config/server-tcp-port</path>
  18. <type>integer</type>
  19. <value>5170</value>
  20. <defaultValue>5170</defaultValue>
  21. <label>TCP Port</label>
  22. </Setting>
  23. <Setting>
  24. <path>openuc-saa-config/log-level</path>
  25. <type>enum</type>
  26. <options>
  27. <entry>
  28. <key>3</key>
  29. <value>ERR</value>
  30. </entry>
  31. <entry>
  32. <key>2</key>
  33. <value>CRIT</value>
  34. </entry>
  35. <entry>
  36. <key>1</key>
  37. <value>ALERT</value>
  38. </entry>
  39. <entry>
  40. <key>0</key>
  41. <value>EMERG</value>
  42. </entry>
  43. <entry>
  44. <key>7</key>
  45. <value>DEBUG</value>
  46. </entry>
  47. <entry>
  48. <key>6</key>
  49. <value>INFO</value>
  50. </entry>
  51. <entry>
  52. <key>5</key>
  53. <value>NOTICE</value>
  54. </entry>
  55. <entry>
  56. <key>4</key>
  57. <value>WARNING</value>
  58. </entry>
  59. </options>
  60. <value>5</value>
  61. <defaultValue>5</defaultValue>
  62. <label>Log Level</label>
  63. </Setting>
  64. <Setting>
  65. <path>openuc-saa-config/server-min-expires</path>
  66. <type>integer</type>
  67. <value>300</value>
  68. <defaultValue>300</defaultValue>
  69. <label>Minimum Expires</label>
  70. <description>Minimum number of seconds after which the subscribe expires</description>
  71. </Setting>
  72. <Setting>
  73. <path>openuc-saa-config/server-default-expires</path>
  74. <type>integer</type>
  75. <value>3600</value>
  76. <defaultValue>3600</defaultValue>
  77. <label>Default Expires</label>
  78. <description>Default number of seconds after which the subscribe expires</description>
  79. </Setting>
  80. <Setting>
  81. <path>openuc-saa-config/server-max-expires</path>
  82. <type>integer</type>
  83. <value>86400</value>
  84. <defaultValue>86400</defaultValue>
  85. <label>Maximum Expires</label>
  86. <description>Maximum number of seconds after which the subscribe expires</description>
  87. </Setting>
  88. <Setting>
  89. <path>openuc-saa-config/notification-interval</path>
  90. <type>integer</type>
  91. <value>1000</value>
  92. <defaultValue>1000</defaultValue>
  93. <label>Notification Interval</label>
  94. <description>The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers</description>
  95. </Setting>
  96. <Setting>
  97. <path>openuc-saa-config/enable-stack-logs</path>
  98. <type>boolean</type>
  99. <value>false</value>
  100. <defaultValue>false</defaultValue>
  101. <label>Enable Stack Logs</label>
  102. <description>If checked SAA will save in the log file also the logs generated by the internal stack</description>
  103. </Setting>
  104. <Setting>
  105. <path>openuc-saa-config/max-udp-notify-body-size</path>
  106. <type>integer</type>
  107. <value>64512</value>
  108. <defaultValue>64512</defaultValue>
  109. <label>Maximum UDP NOTIFY Body Size</label>
  110. <description>Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers.</description>
  111. </Setting>
  112. <Setting>
  113. <path>openuc-saa-config/max-tcp-notify-body-size</path>
  114. <type>integer</type>
  115. <value>10485760</value>
  116. <defaultValue>10485760</defaultValue>
  117. <label>Maximum TCP NOTIFY Body Size</label>
  118. <description>Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb.</description>
  119. </Setting>
  120. <Setting>
  121. <path>openuc-saa-config/max-notify-resend-interval-sec</path>
  122. <type>integer</type>
  123. <value>300</value>
  124. <defaultValue>300</defaultValue>
  125. <label>Maximum notify resend interval</label>
  126. <description>Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval.</description>
  127. </Setting>
  128. <Setting>
  129. <path>openuc-saa-config/max-instances-per-line</path>
  130. <type>integer</type>
  131. <value>63</value>
  132. <defaultValue>63</defaultValue>
  133. <label>Maximum appearances per line</label>
  134. <description>Maximum number of appearances for a shared line.</description>
  135. </Setting>
  136. <Setting>
  137. <path>openuc-saa-config/max-appearances-per-line</path>
  138. <type>integer</type>
  139. <value>24</value>
  140. <defaultValue>24</defaultValue>
  141. <label>Maximum instances per line</label>
  142. <description>Maximum number of instances for a shared line.</description>
  143. </Setting>
  144. <Setting>
  145. <path>openuc-saa-config/subscription-restart-interval</path>
  146. <type>integer</type>
  147. <value>86400</value>
  148. <defaultValue>86400</defaultValue>
  149. <label>Subscription restart interval</label>
  150. <description>Time in seconds after which SAA client subscriptions are restarted.</description>
  151. </Setting>
  152. <Setting>
  153. <path>resource-limits/fd-soft</path>
  154. <type>integer</type>
  155. <value>32768</value>
  156. <defaultValue>32768</defaultValue>
  157. <label>FD Soft</label>
  158. <description>FD Soft resource limit</description>
  159. </Setting>
  160. <Setting>
  161. <path>resource-limits/fd-hard</path>
  162. <type>integer</type>
  163. <value>65536</value>
  164. <defaultValue>65536</defaultValue>
  165. <label>FD Hard</label>
  166. <description>FD Hard resource limit</description>
  167. </Setting>
  168. <Setting>
  169. <path>resource-limits/core-enabled</path>
  170. <type>boolean</type>
  171. <value>false</value>
  172. <defaultValue>false</defaultValue>
  173. <label>Core Enabled</label>
  174. <description>Core Enabled resource limit</description>
  175. </Setting>
  176. </Settings>
  177. settings: [17]

  178. 0: {
  179. path: "openuc-saa-config/server-udp-port"
  180. type: "integer"
  181. options: null
  182. value: "5170"
  183. defaultValue: "5170"
  184. label: "UDP Port"
  185. description: null
  186. }-
  187. 1: {
  188. path: "openuc-saa-config/server-tcp-port"
  189. type: "integer"
  190. options: null
  191. value: "5170"
  192. defaultValue: "5170"
  193. label: "TCP Port"
  194. description: null
  195. }-
  196. 2: {
  197. path: "openuc-saa-config/log-level"
  198. type: "enum"
  199. options: {
  200. 0: "EMERG"
  201. 1: "ALERT"
  202. 2: "CRIT"
  203. 3: "ERR"
  204. 4: "WARNING"
  205. 5: "NOTICE"
  206. 6: "INFO"
  207. 7: "DEBUG"
  208. }-
  209. value: "5"
  210. defaultValue: "5"
  211. label: "Log Level"
  212. description: null
  213. }-
  214. 3: {
  215. path: "openuc-saa-config/server-min-expires"
  216. type: "integer"
  217. options: null
  218. value: "300"
  219. defaultValue: "300"
  220. label: "Minimum Expires"
  221. description: "Minimum number of seconds after which the subscribe expires"
  222. }-
  223. 4: {
  224. path: "openuc-saa-config/server-default-expires"
  225. type: "integer"
  226. options: null
  227. value: "3600"
  228. defaultValue: "3600"
  229. label: "Default Expires"
  230. description: "Default number of seconds after which the subscribe expires"
  231. }-
  232. 5: {
  233. path: "openuc-saa-config/server-max-expires"
  234. type: "integer"
  235. options: null
  236. value: "86400"
  237. defaultValue: "86400"
  238. label: "Maximum Expires"
  239. description: "Maximum number of seconds after which the subscribe expires"
  240. }-
  241. 6: {
  242. path: "openuc-saa-config/notification-interval"
  243. type: "integer"
  244. options: null
  245. value: "1000"
  246. defaultValue: "1000"
  247. label: "Notification Interval"
  248. description: "The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers"
  249. }-
  250. 7: {
  251. path: "openuc-saa-config/enable-stack-logs"
  252. type: "boolean"
  253. options: null
  254. value: "false"
  255. defaultValue: "false"
  256. label: "Enable Stack Logs"
  257. description: "If checked SAA will save in the log file also the logs generated by the internal stack"
  258. }-
  259. 8: {
  260. path: "openuc-saa-config/max-udp-notify-body-size"
  261. type: "integer"
  262. options: null
  263. value: "64512"
  264. defaultValue: "64512"
  265. label: "Maximum UDP NOTIFY Body Size"
  266. description: "Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers."
  267. }-
  268. 9: {
  269. path: "openuc-saa-config/max-tcp-notify-body-size"
  270. type: "integer"
  271. options: null
  272. value: "10485760"
  273. defaultValue: "10485760"
  274. label: "Maximum TCP NOTIFY Body Size"
  275. description: "Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb."
  276. }-
  277. 10: {
  278. path: "openuc-saa-config/max-notify-resend-interval-sec"
  279. type: "integer"
  280. options: null
  281. value: "300"
  282. defaultValue: "300"
  283. label: "Maximum notify resend interval"
  284. description: "Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval."
  285. }-
  286. 11: {
  287. path: "openuc-saa-config/max-instances-per-line"
  288. type: "integer"
  289. options: null
  290. value: "63"
  291. defaultValue: "63"
  292. label: "Maximum appearances per line"
  293. description: "Maximum number of appearances for a shared line."
  294. }-
  295. 12: {
  296. path: "openuc-saa-config/max-appearances-per-line"
  297. type: "integer"
  298. options: null
  299. value: "24"
  300. defaultValue: "24"
  301. label: "Maximum instances per line"
  302. description: "Maximum number of instances for a shared line."
  303. }-
  304. 13: {
  305. path: "openuc-saa-config/subscription-restart-interval"
  306. type: "integer"
  307. options: null
  308. value: "86400"
  309. defaultValue: "86400"
  310. label: "Subscription restart interval"
  311. description: "Time in seconds after which SAA client subscriptions are restarted."
  312. }-
  313. 14: {
  314. path: "resource-limits/fd-soft"
  315. type: "integer"
  316. options: null
  317. value: "32768"
  318. defaultValue: "32768"
  319. label: "FD Soft"
  320. description: "FD Soft resource limit"
  321. }-
  322. 15: {
  323. path: "resource-limits/fd-hard"
  324. type: "integer"
  325. options: null
  326. value: "65536"
  327. defaultValue: "65536"
  328. label: "FD Hard"
  329. description: "FD Hard resource limit"
  330. }-
  331. 16: {
  332. path: "resource-limits/core-enabled"
  333. type: "boolean"
  334. options: null
  335. value: "false"
  336. defaultValue: "false"
  337. label: "Core Enabled"
  338. description: "Core Enabled resource limit"
  339. }-
  340. -
  341. }
    1. JSON format
  342. {
  343. settings: [17]

  344. 0: {
  345. path: "openuc-saa-config/server-udp-port"
  346. type: "integer"
  347. options: null
  348. value: "5170"
  349. defaultValue: "5170"
  350. label: "UDP Port"
  351. description: null
  352. }-
  353. 1: {
  354. path: "openuc-saa-config/server-tcp-port"
  355. type: "integer"
  356. options: null
  357. value: "5170"
  358. defaultValue: "5170"
  359. label: "TCP Port"
  360. description: null
  361. }-
  362. 2: {
  363. path: "openuc-saa-config/log-level"
  364. type: "enum"
  365. options: {
  366. 0: "EMERG"
  367. 1: "ALERT"
  368. 2: "CRIT"
  369. 3: "ERR"
  370. 4: "WARNING"
  371. 5: "NOTICE"
  372. 6: "INFO"
  373. 7: "DEBUG"
  374. }-
  375. value: "5"
  376. defaultValue: "5"
  377. label: "Log Level"
  378. description: null
  379. }-
  380. 3: {
  381. path: "openuc-saa-config/server-min-expires"
  382. type: "integer"
  383. options: null
  384. value: "300"
  385. defaultValue: "300"
  386. label: "Minimum Expires"
  387. description: "Minimum number of seconds after which the subscribe expires"
  388. }-
  389. 4: {
  390. path: "openuc-saa-config/server-default-expires"
  391. type: "integer"
  392. options: null
  393. value: "3600"
  394. defaultValue: "3600"
  395. label: "Default Expires"
  396. description: "Default number of seconds after which the subscribe expires"
  397. }-
  398. 5: {
  399. path: "openuc-saa-config/server-max-expires"
  400. type: "integer"
  401. options: null
  402. value: "86400"
  403. defaultValue: "86400"
  404. label: "Maximum Expires"
  405. description: "Maximum number of seconds after which the subscribe expires"
  406. }-
  407. 6: {
  408. path: "openuc-saa-config/notification-interval"
  409. type: "integer"
  410. options: null
  411. value: "1000"
  412. defaultValue: "1000"
  413. label: "Notification Interval"
  414. description: "The interval in milliseconds used by SAA to push partial notifications with status updates to subscribers"
  415. }-
  416. 7: {
  417. path: "openuc-saa-config/enable-stack-logs"
  418. type: "boolean"
  419. options: null
  420. value: "false"
  421. defaultValue: "false"
  422. label: "Enable Stack Logs"
  423. description: "If checked SAA will save in the log file also the logs generated by the internal stack"
  424. }-
  425. 8: {
  426. path: "openuc-saa-config/max-udp-notify-body-size"
  427. type: "integer"
  428. options: null
  429. value: "64512"
  430. defaultValue: "64512"
  431. label: "Maximum UDP NOTIFY Body Size"
  432. description: "Maximum body size for a NOTIFY message sent for a subscription done over UDP. By default this is set to 63Kb assuming 1k for SIP headers."
  433. }-
  434. 9: {
  435. path: "openuc-saa-config/max-tcp-notify-body-size"
  436. type: "integer"
  437. options: null
  438. value: "10485760"
  439. defaultValue: "10485760"
  440. label: "Maximum TCP NOTIFY Body Size"
  441. description: "Maximum body size for a NOTIFY message sent for a subscription done over TCP. By default this is set to 10Mb."
  442. }-
  443. 10: {
  444. path: "openuc-saa-config/max-notify-resend-interval-sec"
  445. type: "integer"
  446. options: null
  447. value: "300"
  448. defaultValue: "300"
  449. label: "Maximum notify resend interval"
  450. description: "Maximum value of the interval in seconds used to resend rejected notifies. By default this is set to 300 seconds. <br/>It must be greater than Notification Interval."
  451. }-
  452. 11: {
  453. path: "openuc-saa-config/max-instances-per-line"
  454. type: "integer"
  455. options: null
  456. value: "63"
  457. defaultValue: "63"
  458. label: "Maximum appearances per line"
  459. description: "Maximum number of appearances for a shared line."
  460. }-
  461. 12: {
  462. path: "openuc-saa-config/max-appearances-per-line"
  463. type: "integer"
  464. options: null
  465. value: "24"
  466. defaultValue: "24"
  467. label: "Maximum instances per line"
  468. description: "Maximum number of instances for a shared line."
  469. }-
  470. 13: {
  471. path: "openuc-saa-config/subscription-restart-interval"
  472. type: "integer"
  473. options: null
  474. value: "86400"
  475. defaultValue: "86400"
  476. label: "Subscription restart interval"
  477. description: "Time in seconds after which SAA client subscriptions are restarted."
  478. }-
  479. 14: {
  480. path: "resource-limits/fd-soft"
  481. type: "integer"
  482. options: null
  483. value: "32768"
  484. defaultValue: "32768"
  485. label: "FD Soft"
  486. description: "FD Soft resource limit"
  487. }-
  488. 15: {
  489. path: "resource-limits/fd-hard"
  490. type: "integer"
  491. options: null
  492. value: "65536"
  493. defaultValue: "65536"
  494. label: "FD Hard"
  495. description: "FD Hard resource limit"
  496. }-
  497. 16: {
  498. path: "resource-limits/core-enabled"
  499. type: "boolean"
  500. options: null
  501. value: "false"
  502. defaultValue: "false"
  503. label: "Core Enabled"
  504. description: "Core Enabled resource limit"
  505. }-
  506. -
  507. }
  508. Unsupported HTTP Method: PUT, POST, DELETE

View or modify SAA settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /saa/settings/{settingPath
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves SAA options for the setting from the specified path.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Setting>
  10. <path>openuc-saa-config/subscription-restart-interval</path>
  11. <type>integer</type>
  12. <value>86400</value>
  13. <defaultValue>86400</defaultValue>
  14. <label>Subscription restart interval</label>
  15. <description>Time in seconds after which SAA client subscriptions are restarted.</description>
  16. </Setting>
    1. JSON format
  17. {
  18. path: "openuc-saa-config/subscription-restart-interval"
  19. type: "integer"
  20. options: null
  21. value: "86400"
  22. defaultValue: "86400"
  23. label: "Subscription restart interval"
  24. description: "Time in seconds after which SAA client subscriptions are restarted."
  25. }
  26. HTTP Method: PUT
        1. Modifies SAA options options for the setting from the specified path.
  27. HTTP Method: DELETE
        1. Deletes SAA options options for the setting from the specified path.
  28. Unsupported HTTP Method: POST

REST servers

  1. Available in 14 starting with 14.10

View REST servers settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /restserver/settings
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves a list with all the REST servers settings in the system.
        1. Example: XML format
  8. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  9. <Settings>
  10. <Setting>
  11. <path>rest-config/log.level</path>
  12. <type>enum</type>
  13. <options>
  14. <entry>
  15. <key>NOTICE</key>
  16. </entry>
  17. <entry>
  18. <key>CRIT</key>
  19. </entry>
  20. <entry>
  21. <key>EMERG</key>
  22. </entry>
  23. <entry>
  24. <key>WARNING</key>
  25. </entry>
  26. <entry>
  27. <key>ERR</key>
  28. </entry>
  29. <entry>
  30. <key>INFO</key>
  31. </entry>
  32. <entry>
  33. <key>ALERT</key>
  34. </entry>
  35. <entry>
  36. <key>DEBUG</key>
  37. </entry>
  38. </options>
  39. <value>NOTICE</value>
  40. <defaultValue>NOTICE</defaultValue>
  41. <label>Logging Level</label>
  42. </Setting>
  43. <Setting>
  44. <path>rest-config/sipPort</path>
  45. <type>integer</type>
  46. <value>6050</value>
  47. <defaultValue>6050</defaultValue>
  48. <label>Sip Port</label>
  49. </Setting>
  50. <Setting>
  51. <path>rest-config/httpPort</path>
  52. <type>integer</type>
  53. <value>6667</value>
  54. <defaultValue>6667</defaultValue>
  55. <label>Http Port</label>
  56. </Setting>
  57. <Setting>
  58. <path>rest-config/publicHttpPort</path>
  59. <type>integer</type>
  60. <value>6666</value>
  61. <defaultValue>6666</defaultValue>
  62. <label>Public Http Port</label>
  63. </Setting>
  64. </Settings>
    1. JSON format
  65. {
  66. settings: [4]

  67. 0: {
  68. path: "rest-config/log.level"
  69. type: "enum"
  70. options: {
  71. NOTICE: null
  72. CRIT: null
  73. EMERG: null
  74. WARNING: null
  75. ERR: null
  76. INFO: null
  77. ALERT: null
  78. DEBUG: null
  79. }-
  80. value: "NOTICE"
  81. defaultValue: "NOTICE"
  82. label: "Logging Level"
  83. description: null
  84. }-
  85. 1: {
  86. path: "rest-config/sipPort"
  87. type: "integer"
  88. options: null
  89. value: "6050"
  90. defaultValue: "6050"
  91. label: "Sip Port"
  92. description: null
  93. }-
  94. 2: {
  95. path: "rest-config/httpPort"
  96. type: "integer"
  97. options: null
  98. value: "6667"
  99. defaultValue: "6667"
  100. label: "Http Port"
  101. description: null
  102. }-
  103. 3: {
  104. path: "rest-config/publicHttpPort"
  105. type: "integer"
  106. options: null
  107. value: "6666"
  108. defaultValue: "6666"
  109. label: "Public Http Port"
  110. description: null
  111. }-
  112. -
  113. }
  114. Unsupported HTTP Method: PUT, POST, DELETE

View or modify REST servers settings

  1. Available in 14 starting with 14.10
  2. Resource URI: /restserver/settings/{settingPath}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves REST servers options for the setting from the specified path.
        1. Example: XML format
  8. <Setting>
  9. <path>rest-config/httpPort</path>
  10. <type>integer</type>
  11. <value>6667</value>
  12. <defaultValue>6667</defaultValue>
  13. <label>Http Port</label>
  14. </Setting>
    1. JSON format
  15. {
  16. path: "rest-config/httpPort"
  17. type: "integer"
  18. options: null
  19. value: "6667"
  20. defaultValue: "6667"
  21. label: "Http Port"
  22. description: null
  23. }
  24. HTTP Method: PUT
        1. Modifies REST servers options options for the setting from the specified path.
  25. HTTP Method: DELETE
        1. Deletes REST servers options options for the setting from the specified path.
  26. Unsupported HTTP Method: POST


Schedules

  1. Available in 14 starting with 14.10

View all general schedules

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/general
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve all general schedules.
        1. Example: XML format
  8. "<Schedules><Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
  9. "<workingTime><workingHours><enabled>false</enabled><start>1970-01-01T11:00:00+02:00</start><stop>1970-01-01T20:00:00+02:00</stop><scheduledDay>THURSDAY</scheduledDay>"
  10. "</workingHours></workingTime></Schedule></Schedules>", schedule.getId()), schedules);
    1. JSON format
  11. "{\"schedules\":[{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\","\"workingTime\":{\"workingHours\":[{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"}]}}]}", schedule.getId()), schedules);

  12. Unsupported HTTP Method: POST, PUT, DELETE

View all schedules for a group ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/group/{groupId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve schedules for the specified group ID.
        1. Example: XML format

    1. JSON format

  8. Unsupported HTTP Method: POST, PUT, DELETE

View all schedules for a user ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/user/{userId}/all
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve schedules for the specified user ID.
        1. Example: XML format
  8. <Schedules>
  9. <Schedule>
  10. <id>2</id>
  11. <name>User200</name>
  12. <description>desc</description>
  13. <userId>10</userId>
  14. <groupId>-1</groupId>
  15. <type>user</type>
  16. <workingTime>
  17. <workingHours>
  18. <enabled>false</enabled>
  19. <start>1970-01-01T11:00:00+02:00</start>
  20. <stop>1970-01-01T20:00:00+02:00</stop>
  21. <scheduledDay>WEEKEND</scheduledDay>
  22. </workingHours>
  23. </workingTime>
  24. </Schedule>
  25. <Schedule>
  26. <id>3</id>
  27. <name>Cust</name>
  28. <description>desc</description>
  29. <userId>-1</userId>
  30. <groupId>13</groupId>
  31. <type>group</type>
  32. <workingTime>
  33. <workingHours>
  34. <enabled>false</enabled>
  35. <start>1970-01-01T02:00:00+02:00</start>
  36. <stop>1970-01-01T20:00:00+02:00</stop>
  37. <scheduledDay>FRIDAY</scheduledDay>
  38. </workingHours>
  39. </workingTime>
  40. </Schedule>
  41. </Schedules>
    1. JSON format
  42. {
  43. schedules: [2]

  44. 0: {
  45. id: 2
  46. name: "User200"
  47. description: "desc"
  48. userId: 10
  49. groupId: -1
  50. type: "S"
  51. workingTime: {
  52. workingHours: [1]

  53. 0: {
  54. enabled: false
  55. start: 32400000
  56. stop: 64800000
  57. scheduledDay: "Weekend"
  58. }-
  59. -
  60. }-
  61. }-
  62. 1: {
  63. id: 3
  64. name: "Cust"
  65. description: "desc"
  66. userId: -1
  67. groupId: 13
  68. type: "U"
  69. workingTime: {
  70. workingHours: [1]

  71. 0: {
  72. enabled: false
  73. start: 0
  74. stop: 64800000
  75. scheduledDay: "Friday"
  76. }-
  77. -
  78. }-
  79. }-
  80. -
  81. }
  82. Unsupported HTTP Method: POST, PUT, DELETE


View personal schedules for a user ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/user/{userId}/personal
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve personal schedules for the specified user ID.
        1. Example: XML format
  8. <Schedules>
  9. <Schedule>
  10. <id>2</id>
  11. <name>User200</name>
  12. <description>desc</description>
  13. <userId>10</userId>
  14. <groupId>-1</groupId>
  15. <type>user</type>
  16. <workingTime>
  17. <workingHours>
  18. <enabled>false</enabled>
  19. <start>1970-01-01T11:00:00+02:00</start>
  20. <stop>1970-01-01T20:00:00+02:00</stop>
  21. <scheduledDay>WEEKEND</scheduledDay>
  22. </workingHours>
  23. </workingTime>
  24. </Schedule>
  25. </Schedules>
    1. JSON format
  26. {
  27. schedules: [1]

  28. 0: {
  29. id: 2
  30. name: "User200"
  31. description: "desc"
  32. userId: 10
  33. groupId: -1
  34. type: "S"
  35. workingTime: {
  36. workingHours: [1]

  37. 0: {
  38. enabled: false
  39. start: 32400000
  40. stop: 64800000
  41. scheduledDay: "Weekend"
  42. }-
  43. -
  44. }-
  45. }-
  46. -
  47. }
  48. HTTP Method: POST
  49. Create a personal schedule for the specified user ID.
  50. Unsupported HTTP Method: PUT, DELETE


View description for a schedule ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/{scheduleId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description

     

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. View the description for the specified schedule ID.
        1. Example: XML format
  8. "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
  9. "<Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
  10. "<workingTime><workingHours><enabled>false</enabled><start>1970-01-01T11:00:00+02:00</start><stop>1970-01-01T20:00:00+02:00</stop><scheduledDay>THURSDAY</scheduledDay>"
  11. "</workingHours></workingTime></Schedule>",
  12. schedule.getId()), scheduleXml);
    1. JSON format
  13. "{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\",\"workingTime\":"
  14. + "{\"workingHours\":[{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"}]}}",

  15. HTTP Method: PUT
  16. Update the description for the specified schedule ID.
  17. HTTP Method: DELETE
  18. Delete the description for the specified schedule ID.
  19. Unsupported HTTP Method: POST


Add periods to a schedule ID

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/{scheduleId}/period
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: POST
  6. Create a personal schedule for the specified user ID.
  7. {\"enabled\":false,\"start\":34400000,\"stop\":64800000,\"scheduledDay\":\"Monday\"}"
  8. Unsupported HTTP Method: GET, PUT, DELETE


Delete index periods from a schedule ID?

  1. Available in 14 starting with 14.10
  2. Resource URI: /schedules/{scheduleId}/period/{index}
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: DELETE
  6. Create a personal schedule for the specified user ID.
  7. Unsupported HTTP Method: GET, PUT, DELETE




3.1.2 E911 API

Available in V4.6.0 starting with V4.6.7
The Enhanced 911 (E911) functionality has been implemented for handling emergency situations. Administrators can perform the required set up in order for openUC and Unite users to be able to call the 911 number when needed. The functionality uses location based technology to pin point the location of 911 callers and connect them to the appropriate public resources.
About E911
The system to automatically associates a location with the origin of the call. This location may be a physical address or other geographic reference information such as X/Y map coordinates. In sipXecs, administrators are able to define physical locations and link them to users. Physical locations have a DID/ELIN (Emergency Location Identification Number) that will be sent out to the 911 dispatcher. Based on the called ID sent operators will be able to dispatch emergency services directly to the user's location.
Notes:

  • E911 is a system used only in North America.
  • Calls made to other emergency telephone numbers are not supported.

Using E911 REST API
sipXecs also defines a REST API to perform CRUD operations on the Emergency Resource Location (ERL) table and also to link users to locations. This API may be used by third parties in order to update the ERL data in the PS-ALI database (Private Switch/Automatic Location Identification). It also helps administrators update in bulk the locations table and link users to locations.
The following resources for the E911 API are only available for users with administration rights:
Emergency Resource Location (ERL)

  • View list of ERLs
  • Filter ERLs by ELIN
  • Filter ERLs by user name
  • Filter ERLs by user groups
  • Filter ERLs by the number of assigned phones
  • Update ERLs for one or multiple phones
  • Update ERLs for one or multiple phone groups

Registrations

  • View registrations for an IP
  • View registrations for a Line/Extension

Phones

  • View list of phones
  • View list of phones changed since dd/mm/yy




Emergency Resource Location (ERL)

View list of ERLs

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

Property

Description

elin

ELIN number.

location

Caller location.

addressInfo

Address details.

description

Optional description.

Specific Response Codes: N/A
HTTP Method: GET
Returns a list with all the ERLs defined in the system.
Example: XML format
<e911Locations>
<e911Location>
<elin>12345678</elin>
<location>Building A, Floor 5, Room 1</location>
<addressInfo>23 Merivale Road, Ottawa 90210, Canada, Building A, Floor 5, Room 1</addressInfo>
</e911Location>
<e911Location>
<elin>87654321</elin>
<location>Building A, Floor 5, Room 3</location>
<addressInfo>23 Merivale Road, Ottawa 90210, Canada, Building A, Floor 5, Room 3</addressInfo>
<description>Some optional description</description>
</e911Location>
</e911Locations>
HTTP Method: PUT
Save a list of ERLs.
HTTP Method: POST
Update a list of ERLs.
Unsupported HTTP Method: DELETE

Filter ERLs by ELIN

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

Property

Description

elin

ELIN number.

location

Caller location.

addressInfo

Address details.

description

Optional description.

Specific Response Codes: N/A
HTTP Method: GET
Returns the ERLs with the specified ELIN.
Example: XML format
<e911Location>
<elin>12345678</elin>
<location>Building A, Floor 5, Room 1</location>
<addressInfo>23 Merivale Road, Ottawa 90210, Canada, Building A, Floor 5, Room 1</addressInfo>
<description />
HTTP Method: PUT
Update the ERL with the specified ELIN
HTTP Method: DELETE
Delete the ERL with the specified ELIN
Unsupported HTTP Method: POST

Filter ERLs by user name

Resource URI: /erl/user/{username}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Property

Description

location

 

elin

ELIN number.

addressInfo

 

description

Short description of the ERL.

Specific Response Codes: N/A
HTTP Method: GET
Returns the ERL linked to the user identified by the user name. Data is plain text and represents the ELIN of the ERL.
Example: XML format only
<e911Location>
<location> New York, 14 Wall Street, CM Building, 5th floor </location>
<elin> 444444 </elin>
<addressInfo> 55 Felix Street, New York </addressInfo>
<description> Recommended to use the entrance on the west wing </description>
</e911Location>
HTTP Method: PUT
Update the ERL of the user. PUT data is plain text and represents the ERL, for example, 123456.
HTTP Method: DELETE
Set the user ERL to NONE.
Unsupported HTTP Method: POST

Filter ERLs by user groups

Resource URI: /erl/group/{groupname}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Property

Description

location

 

elin

ELIN number.

addressInfo

 

description

Short description of the ERL.

Specific Response Codes: N/A
HTTP Method: GET
Returns the ERL identified with the user group
Example: XML format
<e911Location>
<location> New York, 23 Broad Street, A&B Building, 6th floor </location>
<elin> 333456 </elin>
<addressInfo> 15 Hills Street, New York </addressInfo>
<description> none </description>
</e911Location>
HTTP Method: PUT
Updates the ERL of the user group
Unsupported HTTP Method: POST

Filter ERLs by the number of assigned phones

Resource URI: /erl/phone/{serial_number}[,{serial_numer2},...]


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

Property

Description

location

 

elin

ELIN number.

addressInfo

 

description

Short description of the ERL.

serial

 

Specific Response Codes: N/A
HTTP Method: GET
Retrieves a list with the locations for the phone/s.
Example: XML format
<e911Locations>
<e911Location>
<location>location1</location>
<elin>11111111</elin>
<addressInfo>address info</addressInfo>
<description/>
<serial>0004f280aaaa</serial>
</e911Location>
<e911Location>
<location>location2</location>
<elin>22222222</elin>
<addressInfo/>
<description>description</description>
<serial>0004f280bbbb</serial>
</e911Location>
</e911Locations>
Unsupported HTTP Method: PUT, POST, DELETE

Update ERLs for one or multiple phones

Resource URI: /erl/phones
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: PUT
update locations for one or multiple phones.
Examples: XML format
<phones>
<phone>
<elin>LOCATION1_ELIN</elin>
<serial>0004f280aaaa</serial>
</phone>
<phone>
<elin>LOCATION2_ELIN</elin>
<serial>0004f280bbbb</serial>
</phone>
</phones>
Specifying an empty ELIN will set the location to NONE
<phones>
<phone>
<elin>LOCATION1_ELIN</elin>
<serial>0004f280yyyy</serial>
</phone>
<phone>
<elin></elin>
<serial>0004f280yyyy</serial>
</phone>
</phones>
Return Values: List with the updated locations. Specifying a wrong ELIN or serial will return a 400 error. The system updates the correct phones with correct data, and provide an error message with the phones that could not be updated.
Unsupported HTTP Method: GET, POST, DELETE

Update ERLs for one or multiple phone groups

Resource URI: /erl/phonegroup/{groupName}
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

location

Physical location of the phone group.

elin

ELIN number.

addressInfo

Address information.

description

Short description.

Specific Response Codes:
HTTP Method: GET
Retrieves locations for phone groups
Example: XML format
<e911Location>
<location>Mike's Office</location>
<elin>11111</elin>
<addressInfo>Str Dr Iacob Felix 55, Bucuresti Sector1</addressInfo>
<description />
</e911Location>
HTTP Method: PUT
Updates locations for phone gropus
HTTP Method: DELETE
Deletes location for phone groups.
Unsupported HTTP Method: POST

Registrations

Filter registrations by IP

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

Property

Description

id

Unique identification number of the

timestamp

 

localAddress

 

identity

 

uri

 

callID

 

contact

 

binding

 

qvalue

 

instanceID

Unique identification number of the instance.

gruu

 

shardID

 

path

 

cseg

 

expirationTime

 

instrument

 

expired

Displays True or False.

Specific Response Codes: N/A
HTTP Method: GET
Returns registrations for the given IP
Example: JSON format only

[ 1]


0: {
_id: {
$oid: "53ece9c9c9dbca3ae42b0c9c"
}
-
timestamp: 1408035273
localAddress: "192.168.2.93/RegDB::_bindingsNameSpace"
identity: "201@ezuce.ro"
uri: "sip:201@ezuce.ro"
callId: "ce9f17b8-f65e3fef-8725ec82@192.168.2.55"
contact: "<sip:201@192.168.2.55;x-sipX-nonat>"
binding: "sip:201@192.168.2.55"
qvalue: ""
instanceId: ""
gruu: ""
shardId: 3
path: ""
cseq: 46
expirationTime: 1408037748
instrument: "0004f2acf001"
expired: false
}
-
Unsupported HTTP Method: PUT, POST, DELETE

Filter registrations for lines

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

Property

Description

id

Unique identification number of the

timestamp

 

localAddress

 

identity

 

uri

 

callID

 

contact

 

binding

 

qvalue

 

instanceID

Unique identification number of the instance.

gruu

 

shardID

 

path

 

cseg

 

expirationTime

 

instrument

 

expired

Determines...Displays True or False.

HTTP Method: GET
Returns registrations for the given Line / Extension
Example: JSON format only

[ 1]


0: {
_id: {
$oid: "53e9fae1981c85c27cb59838"
}
-
instrument: ""
instanceId: ""
callId: "vU6HMrOMktGUJriyZRJuY.RpLxAEiAZ6"
binding: "sip:206@192.168.2.101:49102"
uri: "sip:206@ezuce.ro"
localAddress: ""
shardId: 2
gruu: ""
contact: "<sip:206@192.168.2.101:49102;ob;x-sipX-nonat>"
cseq: 19033
qvalue: ""
timestamp: 1407843041
path: ""
expirationTime: 1407843915
expired: false
identity: "206@ezuce.ro"
}
Unsupported HTTP Method: PUT, POST, DELETE

Filter registrations by mac

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

Property

Description

id

Unique identification number of the

timestamp

 

localAddress

 

identity

 

uri

 

callID

 

contact

 

binding

 

qvalue

 

instanceID

Unique identification number of the instance.

gruu

 

shardID

 

path

 

cseg

 

expirationTime

 

instrument

 

expired

Determines...Displays True or False.

Specific Response Codes: N/A
HTTP Method: GET
Returns registrations for the given Line / Extension
Example: JSON format only

[ 2]


0: {
_id: {
$oid: "53ece9c9c9dbca3ae42b0c9c"
}
-
timestamp: 1408035273
localAddress: "192.168.2.93/RegDB::_bindingsNameSpace"
identity: "201@ezuce.ro"
uri: "sip:201@ezuce.ro"
callId: "ce9f17b8-f65e3fef-8725ec82@192.168.2.55"
contact: "<sip:201@192.168.2.55;x-sipX-nonat>"
binding: "sip:201@192.168.2.55"
qvalue: ""
instanceId: ""
gruu: ""
shardId: 3
path: ""
cseq: 46
expirationTime: 1408037748
instrument: "0004f2acf001"
expired: false
}
Unsupported HTTP Method: PUT, POST, DELETE

Phones

View phones list

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

Property

Description

serial

Serial number of the phone.

elin

ELIN number.

Specific Response Codes: N/A
HTTP Method: GET
Retrieves list of phones
Example: XML format
<phones>
<phone>
<serial>0004f280cdbd</serial>
<elin>33333</elin>
</phone>
<phone>
<serial>123456789129</serial>
<elin>33333</elin>
</phone>
<phone>
<serial>0004f2acf001</serial>
<elin>123111</elin>
</phone>
</phones>
Unsupported HTTP Method: PUT, POST, DELETE

View list of phones that have changed since dd/mm/yy

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

Property

Description

serial

Serial number of the phone.

elin

ELIN number.

Specific Response Codes: N/A
HTTP Method: GET
Retrieve list of phones that have changed since the specified date. The date format is mm/dd/yyyy/hh/mm/ss and represents the following: month/day/year/hour/minutes/seconds with the hour in 24h format
(Example: phones/01242014162700)
Example: XML format
<phones>
<phone>
<serial>0004f280cdbd</serial>
<elin>33333</elin>
</phone>
</phones>
Unsupported HTTP Method: PUT, POST, DELETE

3.1.3 User Services

The following resources for the Configuration API are available for all users:
Calls

  • Initiate calls
  • View or modify calls
  • Call forwarding
  • Call schedules
  • Call forwarding schedule
  • View active calls

Voice mail

  • Change voice mail pin
  • View voice mail folder as RSS feed
  • View or modify voice mail settings
  • View or modify personal attendant settings
  • Set personal attendant settings for operators
  • Reset personal attendant settings

Phone book

  • Export phone book entries
  • Create or delete private phone books
  • View contact name on phones' display
  • Import Google contacts
  • View phone book page by page
  • View or modify users

Preferences

  • View or modify contact information
  • View or modify IM preferences
  • View or modify My Buddy preferences
  • View or modify speed dial preferences
  • Set active greeting

Conferences

  • Filter conferences by user ID
  • View conference details
  • View user conference settings for all users
  • View user conference details


System

  • Change user portal access
  • View fax extension and DID numbers
  • View configuration servers' time
  • View log in details
  • View log in details, password and hosts' server name
  • Keep session alive


Calls

Initiate calls

Resource URI: /my/call/{to}, /call/{to}
Default Resource Properties: N/A
Specific Response Codes: Error 400 (When {to} is not a valid sip uri)
HTTP Method: PUT
PUT method requires non empty body which is ignored. Supported as GET for clients that do not handle PUT.
Unsupported HTTP Method: GET, POST, DELETE

View or modify user call forwarding

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

Property

Description

 

 

 

 

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

View or modify call forwarding

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

Property

Description

Expiration

The time measured in seconds that the phone will ring

Type

Option are:

  • If no response - if the previous call won't respond.
  • In the same time - the number will ring in the same time as the previous true if the ring scheme is enabled the phone number to ring

Enabled

 

number

 

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": {

"rings": [


{
"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.
Unsupported HTTP Method: POST, DELETE

View or modify call forwarding schedules

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

Property

Description

Expiration

The time measured in seconds that the phone will ring

Type

Option are:

  • If no response - if the previous call won't respond.
  • In the same time - the number will ring in the same time as the previous true if the ring scheme is enabled the phone number to ring

enabled

 

number

 

scheduleID

The schedule ID to be applied for the specified ring.

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

{"expiration":20,"rings":[{"expiration":30,"type":"If no response","enabled":true,"number":"11112","scheduleId":1},{"expiration":30,"type":"At the same time","enabled":true,"number":"444333","scheduleId":2}],"withVM":true}


HTTP Method: PUT
Saves call forwarding schedules (includes schedule ID)
Unsupported HTTP Method: POST, DELETE

View or modify a schedule ID

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

Property

Description

description

Short description of the schedule.

periods

The start and the end dates of the period. The format is hours/minutes

scheduleId

The ID of the schedule

name

Alternative name of the schedule

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

{"description":"Desc","periods":[{"start":{"hrs":9,"min":0},"end":{"hrs":18,"min":0},"scheduledDay":7}],"scheduleId":3,"name":"Sunday"}


HTTP Method: PUT
Updates existing schedule given {id}
HTTP Method: DELETE
Deletes existing schedule given {id}
Unsupported HTTP Method: POST

View active calls

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

Property

Description

description

Short description of the schedule.

periods

The start and the end dates of the period. The format is hours/minutes

scheduleId

The ID of the schedule

name

Alternative name of the schedule

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@openuc.ezuce.com></from-aor>
<to>32011</to>
<to-aor><sip:32011@openuc.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

{"cdrs": [


{
"from": "2011",
"from-aor": "\"2011\" <sip:2011@openuc.ezuce.com>",
"to": "32011",
"to-aor": "<sip:32011@openuc.ezuce.com>",
"direction": "INCOMING",
"recipient": "32011",
"internal": false,
"type": "Unknown",
"start-time": 1400240496000,
"duration": 483896
}
]}
Unsupported HTTP Method: POST, PUT, DELETE

Voicemail

Change voicemail pin

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

Property

Description

description

Short description of the schedule.

periods

The start and the end dates of the period. The format is hours/minutes.

scheduleId

The ID of the schedule.

name

Alternative name of the schedule.

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

{"description":"Desc","periods":[{"start":{"hrs":9,"min":0},"end":{"hrs":18,"min":0},"scheduledDay":7}],"scheduleId":3,"name":"Sunday"}


HTTP Method: PUT
Updates existing schedule given {id}
HTTP Method: DELETE
Deletes existing schedule given {id}
Unsupported HTTP Method: POST

View or modify voicemail settings

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

Property

Description

voicemailPermission

Determines whether the recipient of the call has the permission to receive voice mail. Displays True if the user has permission and False if he is not permitted.

emailformat

Determines the email format type for the main email address. Options are:

  • Null- no email is sent
  • Full – a detailed email is sent
  • Medium

altEmailFormat

Determines the email format type for the secondary email address. Options are:

  • Null- no email is sent
  • Full – a detailed email is sent
  • Medium

greeting

Voicemail prompt callers hear before leaving a message.

emailAttachType

Determines whether the email has an attachment. Displays Yes or No.

emailIncludeAudioAttachemnt

Determines whether the voice mail message can be attached as an attachment Displays True if the user has permission and False if he is not permitted.

email

 

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

View voicemail folder as RSS feed

Resource URI: /my/feed/voicemail/{folder}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Rthe voicemail folder is presented as an RSS feed.
Example:
<?xml version="1.0" encoding="UTF8"?>
<rss xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">
<channel>
<title>Voicemail: 205</title>
<link>http://localhost/sipxconfig/rest/my/feed/voicemail/inbox</link>
<description>Voicemail Inbox for 205</description>
<item>
<title>Voice Message 100000007 from 205</title>
<link>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000007</link>
<description>5 seconds received at 12:02 on 08/07/14</description>
<enclosure url="http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000007"
type="audio/wav" />
<pubDate>Thu, 07 Aug 2014 09:02:06 GMT</pubDate>
<guid>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000007</guid>
<dc:date>20140807T09:02:06Z</dc:date>
</item>
<item>
<title>Voice Message 100000006 from 205</title>
<link>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000006</link>
<description>4 seconds received at 15:36 on 08/06/14</description>
type="audio/wav" />
<pubDate>Wed, 06 Aug 2014 12:36:25 GMT</pubDate>
<guid>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000006</guid>
<dc:date>20140806T12:36:25Z</dc:date>
</item>
<item>
<title>Voice Message 100000009 from 205</title>
<link>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000009</link>
<description>4 seconds received at 10:16 on 08/08/14</description>
type="audio/wav" />
<pubDate>Fri, 08 Aug 2014 07:16:43 GMT</pubDate>
<guid>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000009</guid>
<dc:date>20140808T07:16:43Z</dc:date>
</item>
<item>
<title>Voice Message 100000008 from 205</title>
<link>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000008</link>
<description>2 seconds received at 12:02 on 08/07/14</description>
type="audio/wav" />
<pubDate>Thu, 07 Aug 2014 09:02:49 GMT</pubDate>
<guid>http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000008</guid>
<dc:date>20140807T09:02:49Z</dc:date>
</item>
</channel>
</rss>
<enclosure url="http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000006"
<enclosure url="http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000009"
<enclosure url="http://localhost/sipxconfig/rest/private/eMMlJIsSz4LL9M3OkUXVJfqNS7x2WRSH/voicemail/inbox/100000008"
Unsupported HTTP Method: PUT, POST, DELETE

View or modify voicemail personal attendant

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

Property

Description

personalAttandantPermission

 

language

 

operator

 

menu

 

ovverrideLanguage

 

depositVM

 

playVMDefaultOptions

 

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

Set operators' personal attendant settings

Resource URI: /my/voicemail/operator/{operator}
Default Resource Properties: N/A
Specific Response Codes:
HTTP Method: PUT
Sets personal attendant operator user setting given 'operator' value
Example: JSON format
???
Unsupported HTTP Method: GET, POST, DELETE

Reset operators' personal attendant settings

Resource URI: /my/voicemail/operator/
Default Resource Properties: N/A
Specific Response Codes:
HTTP Method: PUT
Resets personal attendant operator user setting given 'operator' value
Unsupported HTTP Method: GET, POST, DELETE

Phone Book

Export phone book

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

Property

Description

entry

The phone book entry.

first-name

 

last-name

 

number

 

contact-information

 

homeAdress

 

officeAddress

 

imID

 

imDisplayName

 

avatar

The avatars' RST URL

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

{"phonebook": [


{
"number": "205",
"contactinformation": {
"homeAddress": {},
"officeAddress": {},
"imId": "205",
"imDisplayName": "205",
"avatar": "https://mircea.workezuce.ro/sipxconfig/rest/avatar/205"
}
}
]}
Unsupported HTTP Method: PUT, POST, DELETE

View phone book page by page

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:

Property

Description

size

Total entries number

filtered-size

Returned entries number

strat-row

First returned entry number

End-row

End returned entry number

Show-on-phone

 

Google-domain

 

entries

 

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",

"entries": [


{
"id": "1",
"number": "205",
"contactinformation": {
"homeAddress": {},
"officeAddress": {},
"imId": "205",
"imDisplayName": "205",
"avatar": "https://mircea.workezuce.ro/sipxconfig/rest/avatar/205"
}
}
]
}}
Unsupported HTTP Method: PUT, POST, DELETE

Private phone book entries

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

Property

Description

pb

 

internalID

 

uid

 

vcard

 

username

 

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

Search for phone book contacts

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:

Property

Description

entry

 

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

{"phonebook": [


{
"first-name": "FirstName1",
"last-name": "LastName1",
"number": "200",
"contact-information": {}
},
{
"first-name": "FirstName2",
"last-name": "LastName2",
"number": "201",
"contact-information": {}
}
]}
Unsupported HTTP Method: PUT, POST, DELETE

Create or delete a private phone book

Resource URI: /my/phonebookentry/{internalId}
Default Resource Properties: N/A
Specific Response Codes: Error 404 - when {internalId} not found
HTTP Method: PUT
Creates a private phone book from a VCard template
Vcard input template example in XML:
<?xml version="1.0" encoding="UTF-8" ?>
<pb>
<internalId>XXX</internalId>
<uid></uid>
<vcard>BEGIN:VCARD
VERSION:3.0
SOURCE:privatePhonebook_1
SOURCE:
ORG:;
IMPP;TYPE=PERSONAL:
TEL;TYPE=HOME:165611111166
TEL;TYPE=FAX:
TEL;TYPE=WORK;TYPE=PREF:
EMAIL;TYPE=WORK;TYPE=PREF:aa.cc@cc.cc
EMAIL;TYPE=HOME:
ADR;TYPE=WORK:;;;;;;
ADR;TYPE=HOME:;;;;;;
AGENT:BEGIN:VCARD\\nVERSION:3.0\\nTEL\\;TYPE=cell\\,pref:\\nFN:\\nEND:VCARD
n

NOTE:private contact
UID:d5506041-522b-4810-8c31-5457be334d53
TEL;TYPE=CELL:333333
FN:DDDDD EEEEE
N:EEEEE;DDDDD;;;
PRODID:-//dmfs.org//mimedir.vcard//EN
REV:20140224T153000Z
END:VCARD
</vcard>
<userName>200</userName>
</pb>
HTTP Method: DELETE
Deletes private phone book entry
Unsupported HTTP Method: POST, DELETE

View contacts on display

Resource URI: /my/phonebook/showContactsOnPhone/{value}
Default Resource Properties: N/A
Specific Response Codes:
HTTP Method: PUT
Marks 'true' or 'false' for 'showOnPhone' flag on user private phonebook.
Unsupported HTTP Method: GET, GET, POST

Import Google contacts

Resource URI: /my/phonebook/googleImport
Default Resource Properties: N/A
Specific Response Codes:
Error 743 (POST when google authentication error)
Error 744 (POST when google service error)
Error 745 (POST when google transport error)
HTTP Method: POST
Imports google contacts into user private phone book provided XML entity:
<credentials>
<account>aaa</account>
<password>bbb</password>
</credentials>
Unsupported HTTP Method: GET, PUT, DELETE

Preferences

View user contact information

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

Property

Description

jobTitle

 

jobDept

 

companyName

 

homeAddress

 

officeAddress

 

branchAddress

 

imID

 

imDisplayName

 

emailAddress

 

useBranchAddress

 

salutation

 

twiterName

 

linkedinName

 

facebookName

 

xingName

 

timestamp

 

enabeled

 

ldapManaged

true if the user should be modified when importing from LDAP in a system with LDAP configured

firstName

 

lastName

 

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

View or modify IM preferences

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

Property

Description

statusCallInfo

If true include the caller info in the busy status of the XMPP status message

otpMessage

The content of the message used as XMPP status when user is busy

voicemailOnDnd

If true, all calls received when Do Not Disturb status is set through XMPP client are forwarded directly toVoicemail

statusPhonePresence

If true advertise the user's busy status in the XMPP status message

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

View or modify My Buddy preferences

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

Property

Description

confExit

if true, conference exit messages are sent to mybuddy

vmBegin

if true, leave voicemail messages are sent to mybuddy

vmEnd

if true, left voicemail messages are sent to mybuddy

confEnter

if true conference entry messages are sent to mybuddy

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

View or modify speed dial preferences

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

Property

Description

updatePhones

 

canSubscribeToPresence

 

buttons

speed dial number, label, blf (true/false)

groupSpeedDial

true to inherit group speed dials

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

{"updatePhones":false,"canSubscribeToPresence":true,"buttons":[],"groupSpeedDial":false}


HTTP Method: PUT
Saves the modified speed dial preferences
Unsupported HTTP Method: POST, DELETE

Activate active greeting

Resource URI: /my/mailbox/{user}/preferences/activegreeting/{greeting}
Default Resource Properties: N/A
Return Values: plain text (stream content should be one of: none, standard, outofoffice, extendedabsence). For a content different than above, "none" greeting will be saved
Status Values: list of settings for the speed dial functionality
Specific Response Codes:
HTTP Method: PUT
Sets active greeting setting for a specific user
Note: 'greeting' could be anything but not empty. There is an issue on how this url is formed (we could skip the 'greeting' as we send input content for PUT
Unsupported HTTP Method: GET, POST, DELETE

Conferences

Filter conferences for a user ID

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

Property

Description

conferences

 

enabeled

 

name

 

description

 

extension

 

accessCode

 

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

{"conferences": [


{
"enabled": true,
"name": "myConf",
"description": "description",
"extension": "22123",
"accessCode": "555"
}
]}
Unsupported HTTP Method: PUT, POST, DELETE

View conference details

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

Property

Description

conference

 

extension

 

locked

 

members

 

id

 

name


imID

 

uuid

 

volumeIn

 

volumeOut

 

energyLevel

 

canHear

 

canSpeak

 

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,

"members": [


{
"id": 1,
"name": "200",
"imId": "200im",
"uuid": "33ee33ee",
"volumeIn": 0,
"volumeOut": 0,
"energyLevel": 30,
"canHear": true,
"canSpeak": true
},
{
"id": 1,
"name": "201",
"imId": "201im",
"uuid": "333eee333",
"volumeIn": 0,
"volumeOut": 0,
"energyLevel": 30,
"canHear": true,
"canSpeak": false
}
]
}}
Unsupported HTTP Method: PUT, POST, DELETE

View conference settings for all users

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

Property

Description

conference

 

enabled

 

description

 

extension

 

accessCode

 

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

{"conferences": [


{
"enabled": true,
"name": "myConf",
"description": "description",
"extension": "22123",
"accessCode": "555"
}
]}
Unsupported HTTP Method: POST, DELETE

View user conference details

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

Property

Description

enabled

 

name

 

autoeRecorded

 

quickStart

 

video

 

sendActiveVideoOnly

 

maxMembers

 

moh

 

moderatedRoom

 

publicRoom

 

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

FreeSwitch conference commands

Resource URI: my/conference/{confName}
This is a web service thar allows you to execute FreeSwitch commands for conferences. For details, see section 3.1.4 FreeSwitch Conference Commands

System

Change user portal password

Resource URI: /my/portal/password/{password}
Default Resource Properties: N/A
Specific Response Codes: Error 400 - PUT when {password} not valid (less than 8 characters or null)
HTTP Method: PUT
Change user-portal password with 'password'.
Example: N/A
Unsupported HTTP Method: GET, POST, DELETE

View fax extensions and DID number

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

Property

Description

extension

Extension number.

did

DID number

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

View configuration servers' time

Resource URI: /my/time
Default Resource Properties: N/A
Specific Response Codes:
HTTP Method: GET
Retrieves config server time
Example: text/plain format
May 16, 2014 11:19 AM
Unsupported HTTP Method: PUT, POST, DELETE

View log in details

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

Property

Description

login-details

Header for log in details.

userName

User name.

imID

IM name.

ldapImAuth

Determines if LDAP authentication is enabled. Displays True or False.

sipPassword

SIP password.

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

View user details, password and the servers' host name

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

Property

Description

logInDetails

 

userName

 

imID

 

ldapImAuth

 

sipPassword

 

pin

 

im-location

 

fqdn

im server fully qualified domain name

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 (openUC 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",

"im-locations": [


{
"fqdn": "mircea.work-ezuce.ro"
}
]
}
Unsupported HTTP Method: PUT, POST, DELETE

Keep session alive

Resource URI: /my/keepalive
Default Resource Properties: N/A
Return Values: N/A
Status Values: N/A
Specific Response Codes: N/A
HTTP Method: GET
Meant to be periodically called by clients in order to keep their web session alive.
Unsupported HTTP Method: PUT, POST, DELETE

3.1.4 FreeSwitch Conference Commands

About conference services
The Conference Web Services APIs allow the administrator to send commands to the FreeSwitch platform.
Base URL
The base URL for the Conference web services is:
https://\{user id}:{password}@{admin config host name}/sipxconfig/rest/my/conference/{conference-name}
For the above URL you can use the /{command}&{arg 1}&{arg 2}... URL with the PUT HTTP method to send the desired commands and arguments to FreeSwitch.

Available FreeSwitch commands and arguments

Command name

Command details

Usage

bgdial

 

<endpoint_module_name>/<destination> <callerid number> <callerid name>

deaf

Make a conference member deaf.

<[member_id|all]|last>

dial

Dial a destination via a specific endpoint. For more information, click here.

<endpoint_module_name>/<destination> <callerid number> <callerid name>

dtmf

Send DTMF to any member of the conference.

<[member_id|all|last]> <digits>

energy

Adjusts the conference energy level for a specific member.

<member_id|all|last> [<newval>]

hup

Kick without the kick sound.

conference <confname> hup <[member_id|all|last]>

kick

Kicks a specific member form a conference.

<[member_id|all|last]>

list

Lists all or a specific conference members. For more information, click here.

conference list [delim <string>]

 

 

conference <confname> list [delim <string>]

lock

Lock a conference so no new members will be allowed to enter.

lock

mute

Mutes a specific member in a conference.

<[member_id|all]|last>

norecord

 

<[filename|all]>

nopin

Removes a pin for a specific conference.

nopin

pin

Sets or changes a pin number for a specific conference. Note: if you set a conference pin and then issue a command like
conference <confname> dial sofia/default/123456@softswitch
123456 will not be challenged with a pin, but he will just joins the conference named <confname>.

<pin#>

play

Play an audio file in a conference to all members or to a specific member. You can stop that same audio with the Stop command below.

<file_path> [async|<member_id>]

record

 

<filename>

relate

Mute or Deaf a specific member to another member. For more information, click here.

<member_id> <other_member_id> [nospeak|nohear|clear]

say

Write a message to all members in the conference.

<text>

saymember

Write a messaget to a specific member in a conference.

<member_id> <text>

stop

Stops any queued audio from playing.

<[current|all|async|last]> [<member_id>]

transfer

Transfer a member from one conference to another conference. To transfer a member to another extension use the api transfer command with the uuid of their session.

<conference_name> <member id> [...<member id>]

unmute

Unmute a specific member of a conference.

<[member_id|all]|last>

undeaf

Allow a specific member to hear the conference..

<[member_id|all]|last>

unlock

Unlock a conference so that new members can enter.

unlock

volume_in

Adjusts the input volume for a specific conference member.

<member_id|all|last> [<newval>]

volume_out

Adjusts the output volume for a specific conference member.

<member_id|all|last> [<newval>]

xml_list

 

 

Specific response codes:

Error 404 - when {confName} not found
Error 403 - when authenticated user is not owner of {confName}
Error 400 - when no {command} is specified or the command is incorect

Dial Additional Information

If the caller ID values are not set, the variables set in the conference.conf.xml are used. Specifically, the value for caller-id-number is used for the number and the value for caller-id-name is used for the name.
If the conference is dynamically created as a result of this API and the caller-id-number and caller-id-number is not provided in the API call then the number and name will be "00000000" and respectively "FreeSWITCH".
Example:
conference testconf dial {originate_timeout=30}sofia/default/1000@softswitch 1234567890 FreeSWITCH_Conference
The above API call will dial out of a conference named "testconf" to the user located at the specified endpoint with a 30 second timeout. The endpoint will see the call as coming from "FreeSWITCH_Conference" with a caller id of 1234567890.
Note: The values provided in the dial string overwrite the caller-id-number and caller-id-name variables provided at the end of the API call.
Click here for the list of dial string options available.

List Additional Information

The output generated by the system is named by default with the following format:

<conference name> (<member_count> member[s][locked]),


where locked can represent either the locked or unlockes status of the conference.
The following items are a separated list in CSV format for each conference leg:

Item

Description

ID of participant

 

Register string of participants

 

UUID of participants call leg

 

Caller ID number

 

Caller ID name

 

Status

Options are:

  • Hear - The mute/unmute status of the member.
  • Speak - The "deaf /undeaf" status of the member.
  • Talking - The input channel is providing some amount of sound energy.
  • Video - Providing video?
  • Floor - This member currently owns the floor.

Volume In

 

Volume Out

 

Energy Level

 


Relate Additional Information

Examples:

  • conference my_conf relate 1 2 nospeak: Member 1 may now no longer speak to member 2, i.e. member 2 now cannot hear member 1.
  • conference my_conf relate 1 2 clear: Member 1 may now speak to member 2 again
  • conference my_conf relate 1 2 nohear: Member 1 now cannot hear member 2
  • confernce my_conf relate 1 2 clear: Member 1 can now hear member 2 again


Examples

Lock a conference with name "WeeklyTeamConf":
curl --digest -k -X PUT https://200:123@localhost/sipxconfig/rest/my/conference/WeeklyTeamConf/lock
Invite user in conference given username:
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/invite\&401
Invite user in conference given instant message ID:
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/inviteim\&401im
Other examples:
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/xml_list
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/kick\&all
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/record
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/record\&stop
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/record\&status
curl --digest -k https://400:123@gerula-dev.buc.ro/sipxconfig/rest/my/conference/Conf400/record\&duration
Sample PHP click to call code:
<?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);
?>
Sample contact information:
<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>
<imId>myId</imId>
<emailAddress>john.doe@example.com</emailAddress>
<useBranchAddress>false</useBranchAddress>
<avatar>https://secure.gravatar.com/avatar/8eb1b522f60d11fa897de1dc6351b7e8?s=80&amp;d=G</avatar>
<firstName>John</firstName>
<lastName>Doe</lastName>
</contact-information>

3.2 Configuration SOAP API

Web Services defined in this section for configuration of the system are all SOAP based services and require administrator privileges to be used.

3.2.1 Administration services

The following resources for the Configuration API are only available for users with administration rights:
Permissions

  • Add permissions
  • Find permissions
  • Manage permissions

Call Groups

  • Add call group
  • Find call groups
  • WSDL Call Group

Users

  • Add users
  • Find users
  • Manage users

Phones

  • Add phones
  • Find phones
  • Manage phones

Tests

  • Reset


Permissions

The Permission Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/PermissionService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="Permission">
<sequence>
<element name="name" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="label" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="defaultValue" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="type" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="builtIn" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<complexType name="AddPermission">
<sequence>
<element name="permission" type="impl:Permission" />
</sequence>
</complexType>
<element name="AddPermission" type="impl:AddPermission" />
<complexType name="PermissionSearch">
<sequence>
<element maxOccurs="1" minOccurs="0" name="byName" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byLabel" type="xsd:string" />
</sequence>
</complexType>
<complexType name="FindPermission">
<sequence>
<element name="search" type="impl:PermissionSearch" />
</sequence>
</complexType>
<element name="FindPermission" type="impl:FindPermission" />
<complexType name="ArrayOfPermission">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:Permission" />
</sequence>
</complexType>
<complexType name="FindPermissionResponse">
<sequence>
<element name="permissions" type="impl:ArrayOfPermission" />
</sequence>
</complexType>
<element name="FindPermissionResponse" type="impl:FindPermissionResponse" />
<complexType name="Property">
<sequence>
<element name="property" type="xsd:string" />
<element name="value" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="ManagePermission">
<sequence>
<element name="search" type="impl:PermissionSearch" />
<element maxOccurs="unbounded" name="edit" type="impl:Property" />
<element maxOccurs="1" minOccurs="0" name="deletePermission" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<element name="ManagePermission" type="impl:ManagePermission" />
</schema>
</wsdl:types>
<wsdl:message name="findPermissionRequest">
<wsdl:part element="impl:FindPermission" name="FindPermission" />
</wsdl:message>
<wsdl:message name="managePermissionRequest">
<wsdl:part element="impl:ManagePermission" name="ManagePermission" />
</wsdl:message>
<wsdl:message name="addPermissionRequest">
<wsdl:part element="impl:AddPermission" name="AddPermission" />
</wsdl:message>
<wsdl:message name="findPermissionResponse">
<wsdl:part element="impl:FindPermissionResponse" name="FindPermissionResponse" />
</wsdl:message>
<wsdl:message name="addPermissionResponse" />
<wsdl:message name="managePermissionResponse" />
<wsdl:portType name="PermissionService">
<wsdl:operation name="addPermission" parameterOrder="AddPermission">
<wsdl:input message="impl:addPermissionRequest" name="addPermissionRequest" />
<wsdl:output message="impl:addPermissionResponse" name="addPermissionResponse" />
</wsdl:operation>
<wsdl:operation name="findPermission" parameterOrder="FindPermission">
<wsdl:input message="impl:findPermissionRequest" name="findPermissionRequest" />
<wsdl:output message="impl:findPermissionResponse" name="findPermissionResponse" />
</wsdl:operation>
<wsdl:operation name="managePermission" parameterOrder="ManagePermission">
<wsdl:input message="impl:managePermissionRequest" name="managePermissionRequest" />
<wsdl:output message="impl:managePermissionResponse" name="managePermissionResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="PermissionServiceSoapBinding" type="impl:PermissionService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addPermission">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addPermissionRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addPermissionResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="findPermission">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="findPermissionRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="findPermissionResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="managePermission">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="managePermissionRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="managePermissionResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:PermissionServiceSoapBinding" name="PermissionService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/PermissionService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Note: wsdlsoap:address location specified at the end of the WSDL will be specific to your system.

Add permissions

Name: addPermission
Description: Add a custom call permission to the system.
Input parameters:

Name

Value type

Required/Optional

Description

Editable/Read only

name

string

required

The name of the Permission to add. Even though it is a required parameter, its value is ignored and an internal name is generated.

editable

label

string

optional

The label of the Permission to add. Label is the name displayed in the Administration graphical user interface.

editable

description

string

optional

Describes the permission.

editable

defaultValue

boolean

optional

Indicates whether the permission is enabled (true) or disabled (false) by default for Users.

editable

type

string

 

The type of permission. This is a read-only value. Any string placed in this field during an add will be ignored.

read only

builtIn

boolean

 

Indicates whether the permission is builtin(true) or not(false). Any value placed in this field during an add will be ignored.

read only

Output parameters: empty response
Example: Adding a call permission with label "Test Three" whose default value is false.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:AddPermission>
<permission>
<name>Test3</name>
<label>Test Three</label>
<description>Third test permission</description>
<defaultValue>false</defaultValue>
</permission>
</con:AddPermission>
</soapenv:Body>
</soapenv:Envelope>

Response

 


Find permissions

Name: findPermission
Description: Search for a permission or permissions defined in the system.
Input parameters:

Name

Value Type

Required/Optional

Description

Editable/Read only

byName

string

Optional

Indicates a search for permissions by their name. May be null.

Editable

byLabel

string

Optional

Indicates a search for permissions by their label. May be null.

Editable

Output parameters: Array of items representing the permissions found in the search.

Name

Value Type

Description

name

string

The name of thepermission.

label

string

The value representing the label of the permission.

description

string

Describes the permission.

defaultValue

 

Boolean indicating whether the permission is enabled (true) or disabled (false) by default for Users.

builtIn

boolean

Indicates whether the permission is builtin(true) or not(false).

Example: Search to find all permissions defined in the system.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindPermission>
</con:FindPermission>
</soapenv:Body>
</soapenv:Envelope>

Response

 

Example: Search to find permission with label "Test Three"

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindPermission>
<search>
<byLabel>Test Three</byLabel>
</search>
</con:FindPermission>
</soapenv:Body>
</soapenv:Envelope>

Response

 


Manage permissions

Name: managePermission
Description: Manage (update or delete) existing permissions defined in the system. Only permissions which are not built into the system can be edited or deleted.
Input parameters:

Name

Value Type

Required/Optional

Description

Editable/Read only

byName

string

optional

String used to indicate a search for permissions by their name. May be null. Name is an internally generated value and may not be useful for searching.

Editable

byLabel

string

optional

Indicates a search for permissions by their label. May be null.

Editable

property

 

 

Name of the permission field to edit.

 

value

 

 

Value to use for the permission field being edited.

 

deletepermission

boolean

optional

indicating to delete (true) a permission.

 

Output parameters: Empty response.
Example:

Request

 

Response

N/A


Call groups

The CallGroup Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
A Call Group service deals with information related to Hunt Groups. Any information queried or added in one of the implemented services are mapped to Hunt Group in the System Administration.
URI: https://<host name or address>/sipxconfig/services/CallGroupService
WSDL:
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="UserRing">
<sequence>
<element name="expiration" type="xsd:int" />
<element name="type" type="xsd:string" />
<element name="position" type="xsd:int" />
<element name="userName" type="xsd:string" />
</sequence>
</complexType>
<complexType name="CallGroup">
<sequence>
<element name="name" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="extension" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="enabled" nillable="true" type="xsd:boolean" />
<element maxOccurs="unbounded" minOccurs="0" name="rings" nillable="true" type="impl:UserRing" />
</sequence>
</complexType>
<complexType name="AddCallGroup">
<sequence>
<element name="callGroup" type="impl:CallGroup" />
</sequence>
</complexType>
<element name="AddCallGroup" type="impl:AddCallGroup" />
<complexType name="ArrayOfCallGroup">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:CallGroup" />
</sequence>
</complexType>
<complexType name="GetCallGroupsResponse">
<sequence>
<element name="callGroups" type="impl:ArrayOfCallGroup" />
</sequence>
</complexType>
<element name="GetCallGroupsResponse" type="impl:GetCallGroupsResponse" />
</schema>
</wsdl:types>
<wsdl:message name="getCallGroupsResponse">
<wsdl:part element="impl:GetCallGroupsResponse" name="GetCallGroupsResponse" />
</wsdl:message>
<wsdl:message name="getCallGroupsRequest" />
<wsdl:message name="addCallGroupResponse" />
<wsdl:message name="addCallGroupRequest">
<wsdl:part element="impl:AddCallGroup" name="AddCallGroup" />
</wsdl:message>
<wsdl:portType name="CallGroupService">
<wsdl:operation name="addCallGroup" parameterOrder="AddCallGroup">
<wsdl:input message="impl:addCallGroupRequest" name="addCallGroupRequest" />
<wsdl:output message="impl:addCallGroupResponse" name="addCallGroupResponse" />
</wsdl:operation>
<wsdl:operation name="getCallGroups">
<wsdl:input message="impl:getCallGroupsRequest" name="getCallGroupsRequest" />
<wsdl:output message="impl:getCallGroupsResponse" name="getCallGroupsResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="CallGroupServiceSoapBinding" type="impl:CallGroupService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addCallGroup">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addCallGroupRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addCallGroupResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getCallGroups">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="getCallGroupsRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="getCallGroupsResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:CallGroupServiceSoapBinding" name="CallGroupService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/CallGroupService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>

Add call groups

Name: addCallGroup
Description: Add a new hunt group to the system.
Input parameters:

Name

Value Type

Required/Optional

Description

Editable/Read only

name

string

required

String representing the name of the hunt group to add.

editable

extension

string

optional

the extension to be associated with the hunt group.

editable

description

string

optional

describes the hunt group.

editable

enabled

boolean

optional

Indicates whether the hunt group is enabled (true) or disabled (false).

 

rings

array

optional

describing the members of the hunt group, their position in the group, time (in seconds) to ring the user,

0 or more repetitions

expiration

 

 

Time in seconds to present the call to user.

 

type

string

 

the ring sequence. Can be "delayed" or "immediate". Delayed is used to build a sequential type of hunt group and immediate a broadcast type of hunt group. A mixture of delayed and immediate can be used.

 

position

 

 

The unique position (starting at 0) of the user in the group.

 

username

string

 

the extension of the user.

 

Output parameters: Empty response.
Example: Add a new hunt group "TestGroup2" that is enabled, dialable at extension 556 and contains 4 members (212, 215, 211, 221).

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:AddCallGroup>
<callGroup>
<name>TestGroup2</name>
<!-Optional:->
<extension>556</extension>
<!-Optional:->
<description>Sample SOAP created Hunt Group</description>
<!-Optional:->
<enabled>true</enabled>
<!-Zero or more repetitions:->
<rings>
<expiration>10</expiration>
<type>delayed</type>
<position>0</position>
<userName>212</userName>
</rings>
<rings>
<expiration>10</expiration>
<type>immediate</type>
<position>1</position>
<userName>215</userName>
</rings>
<rings>
<expiration>15</expiration>
<type>immediate</type>
<position>2</position>
<userName>211</userName>
</rings>
<rings>
<expiration>15</expiration>
<type>delayed</type>
<position>3</position>
<userName>221</userName>
</rings>
</callGroup>
</con:AddCallGroup>
</soapenv:Body>
</soapenv:Envelope>

Response

 


Get call groups

Name: getCallGroups
Description: Query the hunt groups defined in the system.
Input parameters: None
Output parameters: Array of items representing the permissions found in the search.

Name

Value Type

Description

name

string

the name of the hunt group.

Extension

string

representing the extension associated with the hunt group.

description

string

Describes the hunt group.

enabled

boolean

indicating whether the hunt group is enabled (true) or disabled (false).

rings

array

Describing the members of the hunt group, their position in the group, time (in seconds) to ring the user (0 or more repetitions).

expiration

 

Time in seconds to present the call to user.

type

string

representing the ring sequence. Can be "delayed" or "immediate". Delayed is used to build a sequential type of hunt group and immediate a broadcast type of hunt group. A mixture of delayed and immediate can be used.

position

 

The unique position (starting at 0) of the user in the group.

username

string

String representing the extension of the user.

Example: Query of the hunt groups defined in the system.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body/>
</soapenv:Envelope>

Response

 


Users

The User Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/UserService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="User">
<sequence>
<element name="userName" type="xsd:string" />
<element name="pintoken" nillable="true" type="xsd:string" />
<element name="lastName" nillable="true" type="xsd:string" />
<element name="firstName" nillable="true" type="xsd:string" />
<element name="sipPassword" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="aliases" nillable="true" type="xsd:string" />
<element name="emailAddress" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="groups" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="permissions" nillable="true" type="xsd:string" />
<element maxOccurs="1" name="branchName" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddUser">
<sequence>
<element name="user" type="impl:User" />
<element name="pin" type="xsd:string" />
</sequence>
</complexType>
<element name="AddUser" type="impl:AddUser" />
<complexType name="UserSearch">
<sequence>
<element maxOccurs="1" minOccurs="0" name="byUserName" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byFuzzyUserNameOrAlias" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byGroup" type="xsd:string" />
</sequence>
</complexType>
<complexType name="FindUser">
<sequence>
<element name="search" type="impl:UserSearch" />
</sequence>
</complexType>
<element name="FindUser" type="impl:FindUser" />
<complexType name="ArrayOfUser">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:User" />
</sequence>
</complexType>
<complexType name="FindUserResponse">
<sequence>
<element name="users" type="impl:ArrayOfUser" />
</sequence>
</complexType>
<element name="FindUserResponse" type="impl:FindUserResponse" />
<complexType name="Property">
<sequence>
<element name="property" type="xsd:string" />
<element name="value" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="ManageUser">
<sequence>
<element name="search" type="impl:UserSearch" />
<element maxOccurs="unbounded" name="edit" type="impl:Property" />
<element maxOccurs="1" minOccurs="0" name="deleteUser" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="addGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="removeGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="updateGroup" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<element name="ManageUser" type="impl:ManageUser" />
</schema>
</wsdl:types>
<wsdl:message name="findUserRequest">
<wsdl:part element="impl:FindUser" name="FindUser" />
</wsdl:message>
<wsdl:message name="addUserRequest">
<wsdl:part element="impl:AddUser" name="AddUser" />
</wsdl:message>
<wsdl:message name="manageUserResponse" />
<wsdl:message name="addUserResponse" />
<wsdl:message name="manageUserRequest">
<wsdl:part element="impl:ManageUser" name="ManageUser" />
</wsdl:message>
<wsdl:message name="findUserResponse">
<wsdl:part element="impl:FindUserResponse" name="FindUserResponse" />
</wsdl:message>
<wsdl:portType name="UserService">
<wsdl:operation name="addUser" parameterOrder="AddUser">
<wsdl:input message="impl:addUserRequest" name="addUserRequest" />
<wsdl:output message="impl:addUserResponse" name="addUserResponse" />
</wsdl:operation>
<wsdl:operation name="findUser" parameterOrder="FindUser">
<wsdl:input message="impl:findUserRequest" name="findUserRequest" />
<wsdl:output message="impl:findUserResponse" name="findUserResponse" />
</wsdl:operation>
<wsdl:operation name="manageUser" parameterOrder="ManageUser">
<wsdl:input message="impl:manageUserRequest" name="manageUserRequest" />
<wsdl:output message="impl:manageUserResponse" name="manageUserResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="UserServiceSoapBinding" type="impl:UserService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addUser">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addUserRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addUserResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="findUser">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="findUserRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="findUserResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="manageUser">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="manageUserRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="manageUserResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:UserServiceSoapBinding" name="UserService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/UserService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Note: wsdlsoap:address location specified at the end of the WSDL will be specific to your system.

Add users

Name: addUser
Description: Add a new user to the system.
Input parameters:

Name

Value Type

Required/Optional

Description

Editable/Read only

userName

string

required

the name of the user to add.

editable

pintoken

string

optional

An internally generated token that is an encrypted version of the voicemail pin. This field should not be specified as it will be internally generated.

read only

lastName

string

optional

The last name of the user.

editable

firstName

string

optional

the first name of the user.

editable

sipPassword

string

optional

the SIP password for the user.

 

aliases

array

 

Array of strings, each representing membership in defined groups.(0 or more repetitions)

 

permissions

array

 

rray of strings, each representing a permission name that is granted to the user. Permissions can be general or call permissions. Permissions defined in the system can be obtained using the Permission Services (findPermission).(0 or more repetitions)

 

pin

string

required

The PIN for the user.

editable

branchName

string

optional

user's branch.

editable

Output parameters: Empty response.
Example: Add a new user 223 to the system with sipPassword 4567, pin 1234 along with various permissions and group memberships, in branch Berlin.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:AddUser>
<user>
<userName>223</userName>
<lastName>Einstein</lastName>
<firstName>Albert</firstName>
<sipPassword>4567</sipPassword>
<emailAddress>albertE@yahoo.com</emailAddress>
<branchName>Berlin</branchName>
<groups>Managers</groups>
<permissions>FreeswitchVoicemailServer</permissions>
<permissions>InternationalDialing</permissions>
<permissions>LocalDialing</permissions>
<permissions>LongDistanceDialing</permissions>
<permissions>Mobile</permissions>
<permissions>TollFree</permissions>
<permissions>Voicemail</permissions>
<permissions>music-on-hold</permissions>
<permissions>perm_8</permissions>
<permissions>personal-auto-attendant</permissions>
<permissions>tui-change-pin</permissions>
</user>
<pin>1234</pin>
</con:AddUser>
</soapenv:Body>
</soapenv:Envelope>

Response

 


Find users

Name: findUser
Description: Find a defined user(s) in the system.
Input parameters: Either no parameters (for a listing of all users) should be provided or one of the following optional parameters.

Name

Value Type

Required/Optional

Description

Editable/Read only

byUserName

string

optional

the name of the user to find.

editable

byFuzzyUserNameOrAlias

string

optional

a partial user name or alias to search for. This represents sort type of wildcard search.

editable

byGroup

string

optional

the users which are members of a particular defined group.

editable

Output parameters: An array of 0 or more of the following:

Name

Value Type

Description

userName

string

the name of the user to add.

pintoken

string

an internally generated token that is an encrypted version of the pin.

lastName

string

the last name of the user.

firstName

string

the first name of the user.

sipPassword

string

the SIP password for the user.

aliases

array

Array of strings, each representing a user alias. (0 or more repetitions)

emailAddress

string

the email address for the user.

groups

array

Array of strings, each representing membership in defined groups.
permissions(0 or more repetitions) – Array of strings, each representing a permission name that is granted to the user. Permissions can be general or call permissions. Permissions defined in the system can be obtained using the Permission Services (findPermission). (0 or more repetitions)

pin–

string

the PIN for the user.

branchName

string

user's branch.

Example: Find all defined users in the system.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindUser>
</con:FindUser>
</soapenv:Body>
</soapenv:Envelope>

Response

 

Example: Find all users that are members of the group "Managers".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindUser>
<search>
<byGroup>Managers</byGroup>
</search>
</con:FindUser>
</soapenv:Body>
</soapenv:Envelope>

Response

 

Example: Find the user userName "223".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindUser>
<search>
<byUserName>223</byUserName>
</search>
</con:FindUser>
</soapenv:Body>
</soapenv:Envelope>

Response

 

Example: Find users whose userName begins with "22".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindUser>
<search>
<byFuzzyUserNameOrAlias>22</byFuzzyUserNameOrAlias>
</search>
</con:FindUser>
</soapenv:Body>
</soapenv:Envelope>

Response

 


Manage users

Name: manageUser
Description: Manage (update or delete) existing users defined in the system.
Input parameters: Either no parameters (for a listing of all users) should be provided or one of the following optional parameters.

Name

Value Type

Required/Optional

Description

Editable/Read only

byUserName

string

optional

The name of the user to find.

editable

byFuzzyUserNameOrAlias

string

optional

A partial user name or alias to search for. This represents sort type of wildcard search.

editable

byGroup

string

optional

The users which are members of a particular defined group.

editable

property

string

optional

Name of the user field to edit.

editable

value

string

optional

Edit parameter.Value to use for the user field being edited.

editable

deleteUser

boolean

optional

indicating to delete (true) a user(s). This is dependent on the search results.

editable

addGroup

string

optional

Add parameter. the name of the group to add the user(s) to. This is dependent on the search results.

editable

removeGroup

string

optional

the name of the group to remove the user(s) from. This is dependent on the search results.

editable

updateBranch

string

optional

the name of the branch to update the user(s) to.

editable

Output parameters: Empty response
Example: Remove all users in the system beginning with username "22" from group "Managers"

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:ManageUser>
<search>
<byFuzzyUserNameOrAlias>22</byFuzzyUserNameOrAlias>
</search>
<removeGroup>Managers</removeGroup>
</con:ManageUser>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A

Example: Add user with username "211" to the group "Managers".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:ManageUser>
<byUserName>211</byUserName>
</search>
<addGroup>Managers</addGroup>
</con:ManageUser>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A

Example: Change all users from group "Managers" to have a lastName of "SuperDog" and firstName of "I am"

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:ManageUser>
<search>
<!-Optional:->
<byGroup>Managers</byGroup>
</search>
<!-1 or more repetitions:->
<edit>
<!-You may enter the following 2 items in any order->
<property>lastName</property>
<value>SuperDog</value>
</edit>
<edit>
<!-You may enter the following 2 items in any order->
<property>firstName</property>
<value>I am</value>
</edit>
</con:ManageUser>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A

Example: Update user with username "211" to the branch "Berlin".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:ManageUser>
<byUserName>211</byUserName>
</search>
<updateBranch>Berlin</updateBranch>
</con:ManageUser>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A


Park orbit

The Park Orbit Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
Note that starting with V14.10, new REST APIS have been implement for the park orbit functionality.
URI: https://<host name or address>:8443/sipxconfig/services/ParkOrbitService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="ParkOrbit">
<sequence>
<element name="name" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="extension" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="enabled" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="music" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddParkOrbit">
<sequence>
<element name="parkOrbit" type="impl:ParkOrbit" />
</sequence>
</complexType>
<element name="AddParkOrbit" type="impl:AddParkOrbit" />
<complexType name="ArrayOfParkOrbit">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:ParkOrbit" />
</sequence>
</complexType>
<complexType name="GetParkOrbitsResponse">
<sequence>
<element name="parkOrbits" type="impl:ArrayOfParkOrbit" />
</sequence>
</complexType>
<element name="GetParkOrbitsResponse" type="impl:GetParkOrbitsResponse" />
</schema>
</wsdl:types>
<wsdl:message name="addParkOrbitRequest">
<wsdl:part element="impl:AddParkOrbit" name="AddParkOrbit" />
</wsdl:message>
<wsdl:message name="addParkOrbitResponse" />
<wsdl:message name="getParkOrbitsResponse">
<wsdl:part element="impl:GetParkOrbitsResponse" name="GetParkOrbitsResponse" />
</wsdl:message>
<wsdl:message name="getParkOrbitsRequest" />
<wsdl:portType name="ParkOrbitService">
<wsdl:operation name="addParkOrbit" parameterOrder="AddParkOrbit">
<wsdl:input message="impl:addParkOrbitRequest" name="addParkOrbitRequest" />
<wsdl:output message="impl:addParkOrbitResponse" name="addParkOrbitResponse" />
</wsdl:operation>
<wsdl:operation name="getParkOrbits">
<wsdl:input message="impl:getParkOrbitsRequest" name="getParkOrbitsRequest" />
<wsdl:output message="impl:getParkOrbitsResponse" name="getParkOrbitsResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="ParkOrbitServiceSoapBinding" type="impl:ParkOrbitService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addParkOrbit">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addParkOrbitRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addParkOrbitResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getParkOrbits">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="getParkOrbitsRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="getParkOrbitsResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:ParkOrbitServiceSoapBinding" name="ParkOrbitService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/ParkOrbitService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>

Add park orbit

Name: addParkOrbit
Description: Add a new call park orbit to the system.
Input parameters: Either no parameters (for a listing of all users) should be provided or one of the following optional parameters.

Name

Value Type

Required/Optional

Description

Editable/Read only

name

string

required

the name of the call park orbit to add.

editable

extension

string

optional

the dialable extension to be used.

editable

description

string

optional

description of the call park orbit.

editable

enabled

boolean

optional

indicating if the call park orbit is enabled(true) or not(false).

editable

music

path

optional

Path to a wave file (of the appropriate format) to play as background music for calls parked on this orbit.

editable

Output parameters: Empty response
Example: Add a new call park orbit with name "ParkSales", extension "46" and is enabled.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:AddParkOrbit>
<parkOrbit>
<name>ParkSales</name>
<!-Optional:->
<extension>46</extension>
<!-Optional:->
<description>Sales calls park orbit</description>
<!-Optional:->
<enabled>true</enabled>
</parkOrbit>
</con:AddParkOrbit>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A


Get park orbit

Name: getParkOrbits
Description: Queries information on all call park orbits defined in the system.
Input parameters: None.
Output parameters:

Name

Value Type

Description

name

string

the name of the call park orbit.

extension

string

the dialable extension.

description

string

a description of the call park orbit.

enabled

boolean

indicating if the call park orbit is enabled(true) or not(false).

music

 

Path to a wave file (of the appropriate format) to play as background music for calls parked on this orbit.

Example: Query the call park orbits defined in the system.

Request

N/A

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body/>
</soapenv:Envelope>



Phones

The Phone Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/PhoneService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="Line">
<sequence>
<element name="userId" type="xsd:string" />
<element name="uri" type="xsd:string" />
</sequence>
</complexType>
<complexType name="Phone">
<sequence>
<element name="serialNumber" type="xsd:string" />
<element name="modelId" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="groups" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="lines" nillable="true" type="impl:Line" />
<element maxOccurs="1" minOccurs="0" name="deviceVersion" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddPhone">
<sequence>
<element name="phone" type="impl:Phone" />
</sequence>
</complexType>
<element name="AddPhone" type="impl:AddPhone" />
<complexType name="PhoneSearch">
<sequence>
<element maxOccurs="1" minOccurs="0" name="bySerialNumber" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byGroup" type="xsd:string" />
</sequence>
</complexType>
<complexType name="FindPhone">
<sequence>
<element name="search" type="impl:PhoneSearch" />
</sequence>
</complexType>
<element name="FindPhone" type="impl:FindPhone" />
<complexType name="ArrayOfPhone">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:Phone" />
</sequence>
</complexType>
<complexType name="FindPhoneResponse">
<sequence>
<element name="phones" type="impl:ArrayOfPhone" />
</sequence>
</complexType>
<element name="FindPhoneResponse" type="impl:FindPhoneResponse" />
<complexType name="Property">
<sequence>
<element name="property" type="xsd:string" />
<element name="value" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddExternalLine">
<sequence>
<element name="userId" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="displayName" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="password" type="xsd:string" />
<element name="registrationServer" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="voiceMail" type="xsd:string" />
</sequence>
</complexType>
<complexType name="ManagePhone">
<sequence>
<element name="search" type="impl:PhoneSearch" />
<element maxOccurs="unbounded" name="edit" type="impl:Property" />
<element maxOccurs="1" minOccurs="0" name="deletePhone" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="addGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="removeGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="addLine" nillable="true" type="impl:Line" />
<element maxOccurs="1" minOccurs="0" name="addExternalLine" nillable="true" type="impl:AddExternalLine" />
<element maxOccurs="1" minOccurs="0" name="removeLineByUserId" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="removeLineByUri" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="generateProfiles" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="restart" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<element name="ManagePhone" type="impl:ManagePhone" />
</schema>
</wsdl:types>
<wsdl:message name="findPhoneRequest">
<wsdl:part element="impl:FindPhone" name="FindPhone" />
</wsdl:message>
<wsdl:message name="managePhoneResponse" />
<wsdl:message name="addPhoneResponse" />
<wsdl:message name="managePhoneRequest">
<wsdl:part element="impl:ManagePhone" name="ManagePhone" />
</wsdl:message>
<wsdl:message name="addPhoneRequest">
<wsdl:part element="impl:AddPhone" name="AddPhone" />
</wsdl:message>
<wsdl:message name="findPhoneResponse">
<wsdl:part element="impl:FindPhoneResponse" name="FindPhoneResponse" />
</wsdl:message>
<wsdl:portType name="PhoneService">
<wsdl:operation name="addPhone" parameterOrder="AddPhone">
<wsdl:input message="impl:addPhoneRequest" name="addPhoneRequest" />
<wsdl:output message="impl:addPhoneResponse" name="addPhoneResponse" />
</wsdl:operation>
<wsdl:operation name="findPhone" parameterOrder="FindPhone">
<wsdl:input message="impl:findPhoneRequest" name="findPhoneRequest" />
<wsdl:output message="impl:findPhoneResponse" name="findPhoneResponse" />
</wsdl:operation>
<wsdl:operation name="managePhone" parameterOrder="ManagePhone">
<wsdl:input message="impl:managePhoneRequest" name="managePhoneRequest" />
<wsdl:output message="impl:managePhoneResponse" name="managePhoneResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="PhoneServiceSoapBinding" type="impl:PhoneService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addPhone">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addPhoneRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addPhoneResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="findPhone">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="findPhoneRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="findPhoneResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="managePhone">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="managePhoneRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="managePhoneResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:PhoneServiceSoapBinding" name="PhoneService">
<wsdlsoap:address location="https://47.134.206.174/sipxconfig/services/PhoneService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Note: wsdlsoap:address location specified at the end of the WSDL will be specific to your system.

Add phones

Name: addPhone
Description: Add a new phone to the system.
Input parameters:

Name

Value Type

Required/Optional

Description

Editable/Read only

serialNumber

string

required

the MAC address of the phone.

editable

modelId

string

required

a supported model Id. For a complete list of supported phone tupes, see the list below.

editable

description

string

optional

the description of the phone.

editable

groups

string

optional

the phone group(s) this new phone will be in. (0 or more repetitions)

editable

lines

string

optional

String representing the line(s) assigned to this phone.(0 or more repetitions)

editable

deviceVersion

string

optional

The version of the phone.

editable

Output parameters: Empty response
Example: Add a new "Polycom SounPoint IP 321" phone to the system and assign line "221" to it as well as put it in the phone group "FirstPhoneGroup".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:AddPhone>
<phone>
<serialNumber>000000000002</serialNumber>
<modelId>polycom321</modelId>
<!-Optional:->
<description>SOAP added phone</description>
<!-Zero or more repetitions:->
<groups>FirstPhoneGroup</groups>
<!-Zero or more repetitions:->
<lines>
<userId>221</userId>
<uri>221@openuc.ezuce.com</uri>
</lines>
<!-Optional:->
</phone>
</con:AddPhone>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A


List of supported phones:

  • aastra53i
  • aastra55i
  • aastra57i
  • aastra560m
  • aastra sip ip 53i
  • audiocodesMP112_FXS
  • audiocodesMP114_FXS
  • audiocodesMP118_FXS
  • audiocodesMP124_FXS
  • avaya-1210
  • avaya-1220
  • avaya-1230
  • bria
  • ciscoplus7911G
  • ciscoplus7941G
  • ciscoplus7945G
  • ciscoplus7961G
  • ciscoplus7965G
  • ciscoplus7970G
  • ciscoplus7975G
  • cisco7960
  • cisco7940
  • cisco7912
  • cisco7905
  • cisco18x
  • clearone
  • gtekAq10x
  • gtekHl20x
  • gtekVt20x
  • gsPhoneBt100
  • gsPhoneBt200
  • gsPhoneGxp2020
  • gsPhoneGxp2010
  • gsPhoneGxp2000
  • gsPhoneGxp1200
  • gsPhoneGxv3000
  • gsFxsGxw4004
  • gsFxsGxw4008
  • gsHt286
  • gsHt386
  • gsHt486
  • gsHt488
  • gsHt496
  • hitachi3000
  • hitachi5000
  • hitachi5000A
  • ipDialog
  • isphone
  • karelIP116
  • karelIP112
  • karelIP111
  • karelNT32I
  • karelNT42I
  • linksys901
  • linksys921
  • linksys922
  • linksys941
  • linksys942
  • linksys962
  • linksys2102
  • linksys3102
  • linksys8000
  • SPA501G
  • SPA502G
  • SPA504G
  • SPA508G
  • SPA509G
  • SPA525G
  • mitel
  • nortel11xx
  • nortel1535
  • lip6804
  • lip6812
  • lip6830
  • polycom321
  • polycom320
  • polycom330
  • polycom331
  • polycom335
  • polycom430
  • polycom450
  • polycom550
  • polycom560
  • polycom650
  • polycom670
  • polycomVVX1500
  • polycom5000
  • polycom6000
  • polycom7000
  • snom300
  • snom320
  • snom360
  • snom370
  • snomM3
  • unidatawpu7700


Find phones

Name: findPhone
Description: Find a defined phone(s) in the system.
Input parameters: Either no parameters (for a listing of all phones) should be provided or one of the following optional parameters.

Name

Value Type

Required/Optional

Description

Editable/Read only

bySerialNumber

string

required

the serial number (MAC address) of the phone to find.

editable

byGroup

string

optional

the phones which are members of a particular defined phone group.

editable

Output parameters: An array of 0 or more of the following:

Name

Value Type

Description

serialNumber

string

the serial number (MAC address) of the phone.

extension

string

the dialable extension.

description

string

a description of the call park orbit.

enabled

boolean

indicating if the call park orbit is enabled(true) or not(false).

Example: Find all defined phones in the system.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindPhone>
</con:FindPhone>
</soapenv:Body>
</soapenv:Envelope>

Response

 

Example: Find all phones that are members of the phone group "FirstPhoneGroup".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindPhone>
<search>
<byGroup>FirstPhoneGroup</byGroup>
</search>
</con:FindPhone>
</soapenv:Body>
</soapenv:Envelope>

Response

 

Example: Find the phone with serial number "000000000001".

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:FindPhone>
<search>
<bySerialNumber>000000000001</bySerialNumber>
</search>
</con:FindPhone>
</soapenv:Body>
</soapenv:Envelope>

Response

 


Manage phones

Name: managePhone
Description: Manage (update or delete) existing phones defined in the system.
Input parameters: Either no parameters (for a listing of all phones) should be provided or one of the following optional parameters.

Name

Value Type

Required/Optional

Description

Editable/Read only

bySerialNumber

string

required

indicate a search for a phone by its serial number (MAC Address). May be null.

editable

byGroup

string

optional

the phones which are members of a particular defined phone group.

editable

property

 

 

Name of the phone field to edit.

 

value

 

 

Value to use for the phone field being edited.

 

deletePhone

boolean

optional

Boolean indicating to delete (true) a phone(s). This is dependent on the search results.

 

addGroup

 

optional

the name of the phone group to add the phone(s) to. This is dependent on the search results.

 

removeGroup

string

optional

The name of the group to remove the phone(s) from. This is dependent on the search results.

 

addLine

string

optional

userId and uri representing a line to be added to the phone(s). This is dependent on the search results.

 

addExternalLine

string

optional

userId, displayName, password, registrationServer and voicemail of the external line to add to the phone(s). This is dependent on the search results.

 

userId

string

required

the user portion of the SIP URI and default value for authorization (i.e. 201, jsmith).

 

displayName

string

optional

the display name to use for the userId.

 

password

string

optional

the PIN/Password the the userId.

 

registrationServer

string

required

the domain where the userId resides.

 

voicemail

string

optional

the voicemail extension for the userId.

 

removeLineByUserId

string

optional

the userId of the line to remove from the phone(s). This is dependent on the search results.

 

removeLineByUri

string

optional

the uri of the line to remove the from the phone(s). This is dependent on the search results.

 

generateProfiles

boolean

optional

indicating to generate(true) the profiles for the phone(s). This is dependent on the search results.

 

restart

boolean

optional

indicating to restart(true) the phone(s). This is dependent on the search results.

 

 

 

 

 

 

Output parameters: Empty response
Example: Delete all phones wh