Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

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

Wiki Markup
"phone": \[

...

Anchor
__RefHeading__4275_380902303
__RefHeading__4275_380902303
Retrieve phone profile

...

  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. Wiki Markup
    \{"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. 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. Wiki Markup
    \{"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

...

  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. Wiki Markup
    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. Wiki Markup
    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

...

  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. Wiki Markup
    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

...

  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. Wiki Markup
    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

...

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
{

Wiki Markup
"autoAttendants": \[

...

Anchor
__RefHeading__4281_380902303
__RefHeading__4281_380902303
View or modify AAs special mode

...

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

Wiki Markup
"users": \[

...

Wiki Markup
"groups": \[

...

Wiki Markup
"aliases": \[

...

Wiki Markup
"groups": \[

...

Wiki Markup
"aliases": \[

...

  • 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.

...

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

Wiki Markup
"groups": \[

...

Wiki Markup
"aliases": \[

...

Anchor
__RefHeading__4297_380902303
__RefHeading__4297_380902303
View permissions for all users

...

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>

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

...

Anchor
__RefHeading__4311_380902303
__RefHeading__4311_380902303
View or modify a branch ID

...

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

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

...

Wiki Markup
"groups": \[

...

Anchor
__RefHeading__4317_380902303
__RefHeading__4317_380902303
View or modify a user group ID

...

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

Wiki Markup
"groups": \[

...

Anchor
__DdeLink__81289_1685120373
__DdeLink__81289_1685120373

...

Anchor
__RefHeading__4319_380902303
__RefHeading__4319_380902303
View or modify user group permissions

...

  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. Wiki Markup
    \{\"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

...

  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. Wiki Markup
    "\{\"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

...

  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. Wiki Markup
    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

...

  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. Wiki Markup
    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

...

  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

       

    1. Specific Response Codes: N/A
    2. HTTP Method: GET
    3. Retrieves tall MWI settings.
          1. Example: XML format
    4. <Settings>
    5. <Setting>
    6. <path>status-config/SIP_STATUS_TCP_PORT</path>
    7. <type>integer</type>
    8. <value>5110</value>
    9. <defaultValue>5110</defaultValue>
    10. <label>MWI TCP Port</label>
    11. </Setting>
    12. <Setting>
    13. <path>status-config/SIP_STATUS_UDP_PORT</path>
    14. <type>integer</type>
    15. <value>5110</value>
    16. <defaultValue>5110</defaultValue>
    17. <label>MWI UDP Port</label>
    18. </Setting>
    19. <Setting>
    20. <path>status-config/SIP_STATUS_HTTP_PORT</path>
    21. <type>integer</type>
    22. <value>8100</value>
    23. <defaultValue>8100</defaultValue>
    24. <label>MWI HTTP Port</label>
    25. </Setting>
    26. <Setting>
    27. <path>status-config/SIP_STATUS_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>Logging Level</label>
    58. <description>Handling of SUBSCRIBE/NOTIFY messages for voicemail notification control (MWI)</description>
    59. </Setting>
    60. <Setting>
    61. <path>status-config/SIP_STATUS_MAX_EXPIRES</path>
    62. <type>integer</type>
    63. <label>Max expires</label>
    64. </Setting>
    65. <Setting>
    66. <path>status-config/SIP_STATUS_MIN_EXPIRES</path>
    67. <type>integer</type>
    68. <label>Min expires</label>
    69. </Setting>
    70. <Setting>
    71. <path>resource-limits/fd-soft</path>
    72. <type>integer</type>
    73. <value>32768</value>
    74. <defaultValue>32768</defaultValue>
    75. <label>FD Soft</label>
    76. <description>FD Soft resource limit</description>
    77. </Setting>
    78. <Setting>
    79. <path>resource-limits/fd-hard</path>
    80. <type>integer</type>
    81. <value>65536</value>
    82. <defaultValue>65536</defaultValue>
    83. <label>FD Hard</label>
    84. <description>FD Hard resource limit</description>
    85. </Setting>
    86. <Setting>
    87. <path>resource-limits/core-enabled</path>
    88. <type>boolean</type>
    89. <value>false</value>
    90. <defaultValue>false</defaultValue>
    91. <label>Core Enabled</label>
    92. <description>Core Enabled resource limit</description>
    93. </Setting>
    94. </Settings>
      1. JSON format
    95. {
    96. Wiki Markup
      settings: \[9\]

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

    ...

    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. Wiki Markup
      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

    ...

    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. Wiki Markup
      versions: \[1\]

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

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

    ...

    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. Wiki Markup
      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

    ...

    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. Wiki Markup
      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

    ...

    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.

         


      1. Specific Response Codes: N/A
      2. HTTP Method: GET
      3. Retrieves registrations for the specified MAC addresses.
            1. Example: XML format
      4. <Registrations />
        1. JSON format
      5. {
      6. Wiki Markup
        registrations: \[0\]

      7. }
      8. HTTP Method: DELETE
            1. Stops registrations for the specified MAC addresses.
      9. Unsupported HTTP Method: PUT, POST

      ...

      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. Wiki Markup
        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

      ...

      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

           

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

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

        ...

        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

                 

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

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

              ...

              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

                       

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

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

                    ...

                    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

                             

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

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

                          ...

                          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

                                   

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

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

                                ...

                                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

                                         

                                      1. Specific Response Codes: N/A
                                      2. HTTP Method: GET
                                      3. Retrieves a list with all the proxy settings in the system.
                                            1. Example: XML format
                                      4. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
                                      5. <Settings>
                                      6. <Setting>
                                      7. <path>proxy-configuration/SIPX_PROXY_DEFAULT_SERIAL_EXPIRES</path>
                                      8. <type>integer</type>
                                      9. <value>20</value>
                                      10. <defaultValue>20</defaultValue>
                                      11. <label>Default Serial Fork Expiration</label>
                                      12. <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>
                                      13. </Setting>
                                      14. <Setting>
                                      15. <path>proxy-configuration/SIPX_PROXY_DEFAULT_EXPIRES</path>
                                      16. <type>integer</type>
                                      17. <value>300</value>
                                      18. <defaultValue>300</defaultValue>
                                      19. <label>Default Expiration</label>
                                      20. <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>
                                      21. </Setting>
                                      22. <Setting>
                                      23. <path>proxy-configuration/SIPX_PROXY_LOG_LEVEL</path>
                                      24. <type>enum</type>
                                      25. <options>
                                      26. <entry>
                                      27. <key>NOTICE</key>
                                      28. </entry>
                                      29. <entry>
                                      30. <key>CRIT</key>
                                      31. </entry>
                                      32. <entry>
                                      33. <key>EMERG</key>
                                      34. </entry>
                                      35. <entry>
                                      36. <key>WARNING</key>
                                      37. </entry>
                                      38. <entry>
                                      39. <key>ERR</key>
                                      40. </entry>
                                      41. <entry>
                                      42. <key>INFO</key>
                                      43. </entry>
                                      44. <entry>
                                      45. <key>ALERT</key>
                                      46. </entry>
                                      47. <entry>
                                      48. <key>DEBUG</key>
                                      49. </entry>
                                      50. </options>
                                      51. <value>NOTICE</value>
                                      52. <defaultValue>NOTICE</defaultValue>
                                      53. <label>Log Level</label>
                                      54. </Setting>
                                      55. <Setting>
                                      56. <path>proxy-configuration/SIPX_PROXY_AUTHENTICATE_ALGORITHM</path>
                                      57. <type>string</type>
                                      58. <label>Authenticate Algorithm</label>
                                      59. <description>The algorithm used in authentication</description>
                                      60. </Setting>
                                      61. <Setting>
                                      62. <path>proxy-configuration/SIPX_PROXY_MAX_FORWARDS</path>
                                      63. <type>integer</type>
                                      64. <label>Maximum Forwards</label>
                                      65. <description>(Max-Forwards header field)Maximum number of hops a request can transit on the way to its destination.</description>
                                      66. </Setting>
                                      67. <Setting>
                                      68. <path>proxy-configuration/SIPX_PROXY_STALE_TCP_TIMEOUT</path>
                                      69. <type>integer</type>
                                      70. <label>Stale TCP Timeout</label>
                                      71. <description />
                                      72. </Setting>
                                      73. <Setting>
                                      74. <path>proxy-configuration/SIPX_PROXY_ENSURE_TCP_LIFETIME</path>
                                      75. <type>boolean</type>
                                      76. <value>0</value>
                                      77. <defaultValue>0</defaultValue>
                                      78. <label>Ensure TCP Lifetime</label>
                                      79. <description />
                                      80. </Setting>
                                      81. <Setting>
                                      82. <path>proxy-configuration/SIPX_PROXY_RELAY_ALLOWED</path>
                                      83. <type>boolean</type>
                                      84. <value>1</value>
                                      85. <defaultValue>1</defaultValue>
                                      86. <label>Allow Non-Local Domain Relay</label>
                                      87. <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>
                                      88. </Setting>
                                      89. </setting>
                                        1. JSON format
                                      90. {
                                      91. Wiki Markup
                                        settings: \[26\]

                                      92. 0: {
                                      93. path: "proxy-configuration/SIPX_PROXY_DEFAULT_SERIAL_EXPIRES"
                                      94. type: "integer"
                                      95. options: null
                                      96. value: "20"
                                      97. defaultValue: "20"
                                      98. label: "Default Serial Fork Expiration"
                                      99. 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."
                                      100. }-
                                      101. 1: {
                                      102. path: "proxy-configuration/SIPX_PROXY_DEFAULT_EXPIRES"
                                      103. type: "integer"
                                      104. options: null
                                      105. value: "300"
                                      106. defaultValue: "300"
                                      107. label: "Default Expiration"
                                      108. description: "Number of seconds a call is allowed to go unanswered; if this many seconds pass, the call request is returned with an error."
                                      109. }-
                                      110. 2: {
                                      111. path: "proxy-configuration/SIPX_PROXY_LOG_LEVEL"
                                      112. type: "enum"
                                      113. options: {
                                      114. NOTICE: null
                                      115. CRIT: null
                                      116. EMERG: null
                                      117. WARNING: null
                                      118. ERR: null
                                      119. INFO: null
                                      120. ALERT: null
                                      121. DEBUG: null
                                      122. }-
                                      123. value: "NOTICE"
                                      124. defaultValue: "NOTICE"
                                      125. label: "Log Level"
                                      126. description: null
                                      127. }-
                                      128. 3: {
                                      129. path: "proxy-configuration/SIPX_PROXY_AUTHENTICATE_ALGORITHM"
                                      130. type: "string"
                                      131. options: null
                                      132. value: null
                                      133. defaultValue: null
                                      134. label: "Authenticate Algorithm"
                                      135. description: "The algorithm used in authentication"
                                      136. }-
                                      137. 4: {
                                      138. path: "proxy-configuration/SIPX_PROXY_MAX_FORWARDS"
                                      139. type: "integer"
                                      140. options: null
                                      141. value: null
                                      142. defaultValue: null
                                      143. label: "Maximum Forwards"
                                      144. description: "(Max-Forwards header field)Maximum number of hops a request can transit on the way to its destination."
                                      145. }-
                                      146. 5: {
                                      147. path: "proxy-configuration/SIPX_PROXY_STALE_TCP_TIMEOUT"
                                      148. type: "integer"
                                      149. options: null
                                      150. value: null
                                      151. defaultValue: null
                                      152. label: "Stale TCP Timeout"
                                      153. description: ""
                                      154. }-
                                      155. 6: {
                                      156. path: "proxy-configuration/SIPX_PROXY_ENSURE_TCP_LIFETIME"
                                      157. type: "boolean"
                                      158. options: null
                                      159. value: "0"
                                      160. defaultValue: "0"
                                      161. label: "Ensure TCP Lifetime"
                                      162. description: ""
                                      163. }-
                                      164. 7: {
                                      165. path: "proxy-configuration/SIPX_PROXY_RELAY_ALLOWED"
                                      166. type: "boolean"
                                      167. options: null
                                      168. value: "1"
                                      169. defaultValue: "1"
                                      170. label: "Allow Non-Local Domain Relay"
                                      171. 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."
                                      172. }
                                      173. Unsupported HTTP Method: PUT, POST, DELETE

                                      ...

                                      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

                                               

                                            1. Specific Response Codes: N/A
                                            2. HTTP Method: GET
                                            3. Retrieves a list with all the My buddy settings in the system.
                                                  1. Example: XML format
                                            4. <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
                                            5. <Settings>
                                            6. <Setting>
                                            7. <path>imbot/log.level</path>
                                            8. <type>enum</type>
                                            9. <options>
                                            10. <entry>
                                            11. <key>NOTICE</key>
                                            12. </entry>
                                            13. <entry>
                                            14. <key>CRIT</key>
                                            15. </entry>
                                            16. <entry>
                                            17. <key>EMERG</key>
                                            18. </entry>
                                            19. <entry>
                                            20. <key>WARNING</key>
                                            21. </entry>
                                            22. <entry>
                                            23. <key>ERR</key>
                                            24. </entry>
                                            25. <entry>
                                            26. <key>INFO</key>
                                            27. </entry>
                                            28. <entry>
                                            29. <key>ALERT</key>
                                            30. </entry>
                                            31. <entry>
                                            32. <key>DEBUG</key>
                                            33. </entry>
                                            34. </options>
                                            35. <value>NOTICE</value>
                                            36. <defaultValue>NOTICE</defaultValue>
                                            37. <label>Logging Level</label>
                                            38. </Setting>
                                            39. <Setting>
                                            40. <path>imbot/_imbot.paUserName</path>
                                            41. <type>string</type>
                                            42. <value>mybuddy</value>
                                            43. <defaultValue>mybuddy</defaultValue>
                                            44. <label>IM ID</label>
                                            45. <description>The ID under which ImBot feature is visible in the contact list.</description>
                                            46. </Setting>
                                            47. <Setting>
                                            48. <path>imbot/imbot.paPassword</path>
                                            49. <type>string</type>
                                            50. <label>IM password</label>
                                            51. <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>
                                            52. </Setting>
                                            53. </Settings>
                                              1. JSON format
                                            54. {
                                            55. Wiki Markup
                                              settings: \[3\]

                                            56. 0: {
                                            57. path: "imbot/log.level"
                                            58. type: "enum"
                                            59. options: {
                                            60. NOTICE: null
                                            61. CRIT: null
                                            62. EMERG: null
                                            63. WARNING: null
                                            64. ERR: null
                                            65. INFO: null
                                            66. ALERT: null
                                            67. DEBUG: null
                                            68. }-
                                            69. value: "NOTICE"
                                            70. defaultValue: "NOTICE"
                                            71. label: "Logging Level"
                                            72. description: null
                                            73. }-
                                            74. 1: {
                                            75. path: "imbot/_imbot.paUserName"
                                            76. type: "string"
                                            77. options: null
                                            78. value: "mybuddy"
                                            79. defaultValue: "mybuddy"
                                            80. label: "IM ID"
                                            81. description: "The ID under which ImBot feature is visible in the contact list."
                                            82. }-
                                            83. 2: {
                                            84. path: "imbot/imbot.paPassword"
                                            85. type: "string"
                                            86. options: null
                                            87. value: null
                                            88. defaultValue: null
                                            89. label: "IM password"
                                            90. 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."
                                            91. }-
                                            92. -
                                            93. }
                                            94. Unsupported HTTP Method: PUT, POST, DELETE

                                            ...

                                            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

                                                     

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

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

                                                  ...

                                                  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

                                                           

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

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

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

                                                        ...

                                                        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

                                                                 

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

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

                                                              ...

                                                              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

                                                                       

                                                                    1. Specific Response Codes: N/A
                                                                    2. HTTP Method: GET
                                                                    3. Retrieve all general schedules.
                                                                          1. Example: XML format
                                                                    4. "<Schedules><Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
                                                                    5. "<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>"
                                                                    6. "</workingHours></workingTime></Schedule></Schedules>", schedule.getId()), schedules);
                                                                      1. JSON format
                                                                    7. Wiki Markup
                                                                      "\{\"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);

                                                                    8. Unsupported HTTP Method: POST, PUT, DELETE

                                                                    ...

                                                                    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

                                                                             

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

                                                                          40. 0: {
                                                                          41. id: 2
                                                                          42. name: "User200"
                                                                          43. description: "desc"
                                                                          44. userId: 10
                                                                          45. groupId: -1
                                                                          46. type: "S"
                                                                          47. workingTime: {
                                                                          48. Wiki Markup
                                                                            workingHours: \[1\]

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

                                                                          67. 0: {
                                                                          68. enabled: false
                                                                          69. start: 0
                                                                          70. stop: 64800000
                                                                          71. scheduledDay: "Friday"
                                                                          72. }-
                                                                          73. -
                                                                          74. }-
                                                                          75. }-
                                                                          76. -
                                                                          77. }
                                                                          78. Unsupported HTTP Method: POST, PUT, DELETE

                                                                          ...

                                                                          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

                                                                                   

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

                                                                                24. 0: {
                                                                                25. id: 2
                                                                                26. name: "User200"
                                                                                27. description: "desc"
                                                                                28. userId: 10
                                                                                29. groupId: -1
                                                                                30. type: "S"
                                                                                31. workingTime: {
                                                                                32. Wiki Markup
                                                                                  workingHours: \[1\]

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

                                                                                ...

                                                                                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

                                                                                         

                                                                                      1. Specific Response Codes: N/A
                                                                                      2. HTTP Method: GET
                                                                                      3. View the description for the specified schedule ID.
                                                                                            1. Example: XML format
                                                                                      4. "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
                                                                                      5. "<Schedule><id>%s</id><name>Schedule1</name><description>Description1</description><userId>-1</userId><groupId>-1</groupId><type>general</type>"
                                                                                      6. "<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>"
                                                                                      7. "</workingHours></workingTime></Schedule>",
                                                                                      8. schedule.getId()), scheduleXml);
                                                                                        1. JSON format
                                                                                      9. "{\"id\":%s,\"name\":\"Schedule1\",\"description\":\"Description1\",\"userId\":-1,\"groupId\":-1,\"type\":\"G\",\"workingTime\":"
                                                                                      10. Wiki Markup
                                                                                        + "\{\"workingHours\":\[\{\"enabled\":false,\"start\":32400000,\"stop\":64800000,\"scheduledDay\":\"Thursday\"\}\]\}\}",

                                                                                      11. HTTP Method: PUT
                                                                                      12. Update the description for the specified schedule ID.
                                                                                      13. HTTP Method: DELETE
                                                                                      14. Delete the description for the specified schedule ID.
                                                                                      15. Unsupported HTTP Method: POST

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__4480_1290585556
                                                                                      __RefHeading__4480_1290585556
                                                                                      Filter ERLs by the number of assigned phones

                                                                                      Wiki Markup
                                                                                      *Resource URI{*}: /erl/phone/\{serial_number\}\[,\{serial_numer2\},...\]

                                                                                      ...

                                                                                      Property

                                                                                      Description

                                                                                      location

                                                                                       

                                                                                      elin

                                                                                      ELIN number.

                                                                                      addressInfo

                                                                                       

                                                                                      description

                                                                                      Short description of the ERL.

                                                                                      serial

                                                                                       

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      \[ 1\]

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__4591_1290585556
                                                                                      __RefHeading__4591_1290585556
                                                                                      Filter registrations for lines

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      \[ 1\]

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__26766_1685120373
                                                                                      __RefHeading__26766_1685120373
                                                                                      Filter registrations by mac

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      \[ 2\]

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__4593_1290585556
                                                                                      __RefHeading__4593_1290585556
                                                                                      Phones

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      "rings": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__5792_958082936
                                                                                      __RefHeading__5792_958082936
                                                                                      View or modify call forwarding schedules

                                                                                      ...

                                                                                      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

                                                                                      Wiki Markup
                                                                                      \{"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\}

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__5794_958082936
                                                                                      __RefHeading__5794_958082936
                                                                                      View or modify a schedule ID

                                                                                      ...

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

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

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__5796_958082936
                                                                                      __RefHeading__5796_958082936
                                                                                      View active calls

                                                                                      ...

                                                                                      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

                                                                                      Wiki Markup
                                                                                      \{"cdrs": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__5798_958082936
                                                                                      __RefHeading__5798_958082936
                                                                                      Voicemail

                                                                                      ...

                                                                                      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

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

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__5802_958082936
                                                                                      __RefHeading__5802_958082936
                                                                                      View or modify voicemail settings

                                                                                      ...

                                                                                      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

                                                                                      Wiki Markup
                                                                                      \{"phonebook": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__42076_131641563
                                                                                      __RefHeading__42076_131641563
                                                                                      View phone book page by page

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      "entries": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__24177_958082936
                                                                                      __RefHeading__24177_958082936
                                                                                      Private phone book entries

                                                                                      ...

                                                                                      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

                                                                                      Wiki Markup
                                                                                      \{"phonebook": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__24181_958082936
                                                                                      __RefHeading__24181_958082936
                                                                                      Create or delete a private phone book

                                                                                      ...

                                                                                      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

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

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__24197_958082936
                                                                                      __RefHeading__24197_958082936
                                                                                      Activate active greeting

                                                                                      ...

                                                                                      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

                                                                                      Wiki Markup
                                                                                      \{"conferences": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__24203_958082936
                                                                                      __RefHeading__24203_958082936
                                                                                      View conference details

                                                                                      ...

                                                                                      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,

                                                                                      Wiki Markup
                                                                                      "members": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__24205_958082936
                                                                                      __RefHeading__24205_958082936
                                                                                      View conference settings for all users

                                                                                      ...

                                                                                      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

                                                                                      Wiki Markup
                                                                                      \{"conferences": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__24207_958082936
                                                                                      __RefHeading__24207_958082936
                                                                                      View user conference details

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      "im-locations": \[

                                                                                      ...

                                                                                      Anchor
                                                                                      __RefHeading__42528_958082936
                                                                                      __RefHeading__42528_958082936
                                                                                      Keep session alive

                                                                                      ...

                                                                                      Command name

                                                                                      Command details

                                                                                      Usage

                                                                                      bgdial

                                                                                       

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

                                                                                      deaf

                                                                                      Make a conference member deaf.

                                                                                      Wiki Markup
                                                                                      <\[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.

                                                                                      Wiki Markup
                                                                                      <\[member_id|all|last\]> <digits>

                                                                                      energy

                                                                                      Adjusts the conference energy level for a specific member.

                                                                                      Wiki Markup
                                                                                      <member_id|all|last> \[<newval>\]

                                                                                      hup

                                                                                      Kick without the kick sound.

                                                                                      Wiki Markup
                                                                                      conference <confname> hup <\[member_id|all|last\]>

                                                                                      kick

                                                                                      Kicks a specific member form a conference.

                                                                                      Wiki Markup
                                                                                      <\[member_id|all|last\]>

                                                                                      list

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

                                                                                      Wiki Markup
                                                                                      conference list \[delim <string>\]

                                                                                       

                                                                                       

                                                                                      Wiki Markup
                                                                                      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.

                                                                                      Wiki Markup
                                                                                      <\[member_id|all\]|last>

                                                                                      norecord

                                                                                       

                                                                                      Wiki Markup
                                                                                      <\[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.

                                                                                      Wiki Markup
                                                                                      <file_path> \[async|<member_id>\]

                                                                                      record

                                                                                       

                                                                                      <filename>

                                                                                      relate

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

                                                                                      Wiki Markup
                                                                                      <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.

                                                                                      Wiki Markup
                                                                                      <\[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.

                                                                                      Wiki Markup
                                                                                      <conference_name> <member id> \[...<member id>\]

                                                                                      unmute

                                                                                      Unmute a specific member of a conference.

                                                                                      Wiki Markup
                                                                                      <\[member_id|all\]|last>

                                                                                      undeaf

                                                                                      Allow a specific member to hear the conference..

                                                                                      Wiki Markup
                                                                                      <\[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.

                                                                                      Wiki Markup
                                                                                      <member_id|all|last> \[<newval>\]

                                                                                      volume_out

                                                                                      Adjusts the output volume for a specific conference member.

                                                                                      Wiki Markup
                                                                                      <member_id|all|last> \[<newval>\]

                                                                                      xml_list

                                                                                       

                                                                                       

                                                                                      Specific response codes:

                                                                                      ...

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

                                                                                      Wiki Markup
                                                                                      _<conference name> (<member_count> member\[s\]\[locked\]),_

                                                                                      ...

                                                                                      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

                                                                                       

                                                                                      ...