Versions Compared

Key

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

APIs in the Diagnose section are meant to extract information from the system about its use or performance.
Three types of API can help you retrive system information:

  • CDR REST API
  • System Service SOAP API
  • OpenFire APIs

...

SipX Call Detail Records (CDR) Log is a RESTLET plugin which provides a resource whereby one can obtain the Call Logs for a particular user. Records are sorted by start date in descending order. Regarding security and ports, the same rules apply as for callcontroller described above
It is bundled as a JAR package file and is loaded by the sipXrest container on initialization. It is invoked by the GET HTTP method to a specific URL.
The general form of the URL when call is issued from internal cluster is:
http://<sipxrest_node_host>:6667/cdr/user?fromdate=yyyymmdd&limit=<max # of records to return>
The general form of the URL when call is issued from outside the cluster is:
https://<web_admin_host>/sipxconfig/rest/my/redirect/cdr/user?fromdate=yyyymmdd&limit=<max # of records to return>
URL Parameters:

Property

Description

fromdate

start date from which call records will be retrieved.

limit

maximum number of call log records to return.

Examples:
Using curl, you would initiate a query for the specified user calling records
curl -k --digest -X GET -u 200:123 https://192.168.1.104/sipxconfig/rest/my/redirect/cdr/200?limit=5
It returns first five calling records for the user 200. The call is secured and DIGEST authentication is applied. As wanted, you can perform basic authentication or authenticate against LDAP.
Sample response as follows:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Results>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:1201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-16 09:08:57.713</start_time>
<duration>0 years 0 mons -2 days -23 hours -59 mins -35.811 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"Alejandro 201" <sip:501@domain.com></caller_aor>
<callee_aor>"Buddy 200" <sip:200@external200201.com></callee_aor>
<callee_contact><sip:200@192.168.3.2:15060></callee_contact>
<start_time>2011-01-15 14:14:11.853</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 4.231 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-13 09:08:57.713</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 24.189 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"asd"<sip:201@domain.com></caller_aor>
<callee_aor>"200"<sip:200@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:08:08.724</start_time>
<duration>0 years 0 mons 0 days 0 hours 1 mins 28.431 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:06:15.806</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 31.454 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
</Results>

...

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

Property

Description

fromdate

Start date from which call records will be retrieved.

limit

Maximum number of call log records to return.

Specific Response Codes: N/A
HTTP Method: GET
Get the current call state for any ongoing call between callingUser and calledUser.
Examples: XML format
<Results>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:1201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-16 09:08:57.713</start_time>
<duration>0 years 0 mons -2 days -23 hours -59 mins -35.811 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"Alejandro 201" <sip:501@domain.com></caller_aor>
<callee_aor>"Buddy 200" <sip:200@external200201.com></callee_aor>
<callee_contact><sip:200@192.168.3.2:15060></callee_contact>
<start_time>2011-01-15 14:14:11.853</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 4.231 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:202@11.126.12.21:1319></callee_contact>
<start_time>2011-01-13 09:08:57.713</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 24.189 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"asd"<sip:201@domain.com></caller_aor>
<callee_aor>"200"<sip:200@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:08:08.724</start_time>
<duration>0 years 0 mons 0 days 0 hours 1 mins 28.431 secs</duration>
<termination>C</termination>
<callee_route>INT</callee_route>
</Row>
<Row>
<caller_aor>"200" <sip:200@domain.com></caller_aor>
<callee_aor><sip:201@domain.com></callee_aor>
<callee_contact><sip:201@11.126.12.21:1320></callee_contact>
<start_time>2011-01-13 09:06:15.806</start_time>
<duration>0 years 0 mons 0 days 0 hours 0 mins 31.454 secs</duration>
<termination>C</termination>
<callee_route>null</callee_route>
</Row>
</Results>
Return Values: list with information on the user ID
Unsupported HTTP Method: POST, PUT, DELETE

...

  1. Property

...

  1. Description

...

  1. path

...

  1. type

...

 

...

  1. entry

...

 

...

  1. key

...

 

...

      1. Example: XML format

...

  1. JSON format

...

  1. Property

...

  1. Description

...

  1. path

...

  1. type

...

 

...

  1. value

...

 

...

  1. defaultValue

...

 

...

  1. label

...

 

...

  1. description

...

 

...

      1. Example: XML format

...

  1. Property

...

  1. Description

...

  1. callee

...

  1. calleeAor

...

 

...

  1. caller

...

 

...

  1. duration

...

 

...

  1. recipient

...

 

...

  1. startAt

...

 

...

  1. termination

...

 

...

      1. Example: XML format

...

  1. JSON format

...

  1. Property

...

  1. Description

...

 

...

  1. Parameter
  1. Description
  1. fromDate
  1. Optional. The beginning point in the date range

...

  1. toDate
  1. Optional. The ending point in the date range

...

  1. from

...

  1. to

...

 

...

  1. limit

...

Maximum number of rows with results.

...

  1. offset

...

 

...

  1. orderBy

...

Determines how the results are ordered. Options are:

  • caller
  • callee
  • startTime
  • duration
  • termination|
  1. Specific Response Codes: N/A
  2. HTTP Method: GET
  3. Retrieves the history for all the CDRs in the system that match the filtering parameters.
        1. Example: XML format
        2. <Cdrs>
        3. <Cdr>
        4. <callId>df01bebf-a9246135-3b09f217@10.5.0.3</callId>
        5. <callee>300</callee>
        6. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
        7. <caller>200</caller>
        8. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        9. <duration>00:00:00</duration>
        10. <startAt>9/12/14 3:30 PM</startAt>
        11. <termination>ABANDONED</termination>
        12. </Cdr>
        13. <Cdr>
        14. <callId>8a9fbbaf-cc747405-b95b7e87@10.5.0.3</callId>
        15. <callee>400</callee>
        16. <calleeAor><sip:400@dluca.ezuce.ro;user=phone></calleeAor>
        17. <caller>200</caller>
        18. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        19. <connectAt>9/12/14 12:32 PM</connectAt>
        20. <duration>00:21:05</duration>
        21. <recipient>400</recipient>
        22. <startAt>9/12/14 3:32 PM</startAt>
        23. <termination>COMPLETED</termination>
        24. </Cdr>
        25. <Cdr>
        26. <callId>ebf13b4f-ff161ae5-9261eb27@10.5.0.3</callId>
        27. <callee>333</callee>
        28. <calleeAor><sip:333@dluca.ezuce.ro;user=phone></calleeAor>
        29. <caller>200</caller>
        30. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        31. <duration>00:00:00</duration>
        32. <startAt>9/12/14 3:54 PM</startAt>
        33. <termination>FAILED</termination>
        34. </Cdr>
        35. <Cdr>
        36. <callId>fe09178d-9a6adb1f-71d18e55@10.5.0.3</callId>
        37. <callee>300</callee>
        38. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
        39. <caller>200</caller>
        40. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        41. <connectAt>9/12/14 12:55 PM</connectAt>
        42. <duration>00:00:16</duration>
        43. <recipient>300</recipient>
        44. <startAt>9/12/14 3:54 PM</startAt>
        45. <termination>TRANSFER</termination>
        46. </Cdr>
        47. <Cdr>
        48. <callId>b7e025d7-88a40c7d-ca5fd5ef@10.5.0.3</callId>
        49. <callee>300</callee>
        50. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
        51. <caller>200</caller>
        52. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        53. <duration>00:00:00</duration>
        54. <startAt>9/12/14 3:56 PM</startAt>
        55. <termination>FAILED</termination>
        56. </Cdr>
        57. <Cdr>
        58. <callId>d8458d6f-6a11d945-137e47@10.5.0.3</callId>
        59. <callee>333</callee>
        60. <calleeAor><sip:333@dluca.ezuce.ro;user=phone></calleeAor>
        61. <caller>200</caller>
        62. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        63. <connectAt>9/12/14 12:57 PM</connectAt>
        64. <duration>00:00:15</duration>
        65. <recipient>333</recipient>
        66. <startAt>9/12/14 3:57 PM</startAt>
        67. <termination>COMPLETED</termination>
        68. </Cdr>
        69. <Cdr>
        70. <callId>8f14f1e3-404ddc94-f041937@10.5.0.2</callId>
        71. <callee>*4333</callee>
        72. <calleeAor><sip:*4333@dluca.ezuce.ro;user=phone></calleeAor>
        73. <caller>400</caller>
        74. <callerAor>"400" <sip:400@dluca.ezuce.ro></callerAor>
        75. <duration>00:00:00</duration>
        76. <startAt>9/12/14 3:58 PM</startAt>
        77. <termination>FAILED</termination>
        78. </Cdr>
        79. <Cdr>
        80. <callId>8510150f-b8f09825-53c732e7@10.5.0.3</callId>
        81. <callee>300</callee>
        82. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
        83. <caller>200</caller>
        84. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        85. <duration>00:00:00</duration>
        86. <startAt>9/12/14 4:07 PM</startAt>
        87. <termination>FAILED</termination>
        88. </Cdr>
        89. <Cdr>
        90. <callId>89ad82ff-f22d3df5-38b93857@10.5.0.3</callId>
        91. <callee>300</callee>
        92. <calleeAor><sip:300@dluca.ezuce.ro;user=phone></calleeAor>
        93. <caller>200</caller>
        94. <callerAor>"200" <sip:200@dluca.ezuce.ro></callerAor>
        95. <connectAt>9/12/14 1:09 PM</connectAt>
        96. <duration>00:01:05</duration>
        97. <recipient>300</recipient>
        98. <startAt>9/12/14 4:09 PM</startAt>
        99. <termination>TRANSFER</termination>
        100. </Cdr>
        101. <Cdr>
        102. <callId>11bffdd3-f7bb6a95-ae713073@10.5.0.4</callId>
        103. <callee>333</callee>
        104. <calleeAor><sip:333@dluca.ezuce.ro;user=phone></calleeAor>
        105. <caller>300</caller>
        106. <callerAor>"300" <sip:300@dluca.ezuce.ro></callerAor>
        107. <duration>00:00:00</duration>
        108. <startAt>9/12/14 4:10 PM</startAt>
        109. <termination>FAILED</termination>
        110. </Cdr>
        111. <Cdr>
        112. <callId>60c91777-98d2a490-4e1dcaeb@10.5.0.2</callId>
        113. <callee>*4333</callee>
        114. <calleeAor><sip:*4333@dluca.ezuce.ro;user=phone></calleeAor>
        115. <caller>400</caller>
        116. <callerAor>"400" <sip:400@dluca.ezuce.ro></callerAor>
        117. <connectAt>9/12/14 1:12 PM</connectAt>
        118. <duration>00:00:09</duration>
        119. <recipient>*4333</recipient>
        120. <startAt>9/12/14 4:12 PM</startAt>
        121. <termination>COMPLETED</termination>
        122. </Cdr>
        123. </Cdrs>

JSON format
{
cdrs:
0: {
startTime: 1410525010684
caller: "200"
callee: "300"
startAt: "9/12/14 3:30 PM"
connectAt: null
duration: "00:00:00"
callerAor: ""200" <sip:200@dluca.ezuce.ro>"
calleeAor: "<sip:300@dluca.ezuce.ro;user=phone>"
recipient: null
termination: "ABANDONED"
callId: "df01bebf-a9246135-3b09f217@10.5.0.3"
}-
{
startTime: 1410525150483
caller: "200"
callee: "400"
startAt: "9/12/14 3:32 PM"
connectAt: "9/12/14 12:32 PM"
duration: "00:21:05"
callerAor: ""200" <sip:200@dluca.ezuce.ro>"
calleeAor: "<sip:400@dluca.ezuce.ro;user=phone>"
recipient: "400"
termination: "COMPLETED"
callId: "8a9fbbaf-cc747405-b95b7e87@10.5.0.3"
}-
{
startTime: 1410526446565
caller: "200"
callee: "333"
startAt: "9/12/14 3:54 PM"
connectAt: null
duration: "00:00:00"
callerAor: ""200" <sip:200@dluca.ezuce.ro>"
calleeAor: "<sip:333@dluca.ezuce.ro;user=phone>"
recipient: null
termination: "FAILED"
callId: "ebf13b4f-ff161ae5-9261eb27@10.5.0.3"
}-
{
startTime: 1410526499280
caller: "200"
callee: "300"
startAt: "9/12/14 3:54 PM"
connectAt: "9/12/14 12:55 PM"
duration: "00:00:16"
callerAor: ""200" <sip:200@dluca.ezuce.ro>"
calleeAor: "<sip:300@dluca.ezuce.ro;user=phone>"
recipient: "300"
termination: "TRANSFER"
callId: "fe09178d-9a6adb1f-71d18e55@10.5.0.3"
}
}

  1. Unsupported HTTP Method: PUT, POST, DELETE

...

  1. Property

...

  1. Description

...

 

...

  1. Property

...

  1. Description

...

 

...

  1. Parameter
  1. Description
  1. fromDate
  1. Optional. The beginning point in the date range

...

  1. toDate
  1. Optional. The ending point in the date range

...

  1. from

...

  1. to

...

 

...

  1. limit

...

Maximum number of results.

...

  1. offset

...

 

...

  1. orderBy

...

Determines how the results are ordered. Options are:

  • caller
  • callee
  • startTime
  • duration
  • termination|
  1. Specific Response Codes: N/A
  2. HTTP Method: GET
  3. Retrieves the history for the CDRs corresponding to the specified user ID, user name or alias.
        1. Example:

...

  1. Property

...

  1. Description

...

 

...

  1. Parameter
  1. Description
  1. fromDate
  1. Optional. The beginning point in the date range

...

  1. toDate
  1. Optional. The ending point in the date range

...

  1. from

...

  1. to

...

  1. limit

...

  1. Maximum number of results.

...

  1. offset

...

  1. orderBy

...

  1. Determines how the results are ordered. Options are:
  • caller
  • callee
  • startTime
  • duration
  • termination|

...

      1. Example: N/A

...

  1. Parameter

...

  1. Description

...

  1. fromDate

...

  1. Optional. The beginning point in the date range. The format is yyyyMMddHHmm. If not specified, the date defaults to yesterday.

...

  1. toDate

...

  1. Optional. The ending point in the date range. The format is yyyyMMddHHmm. If not specified, the date defaults to now.

...

  1. from

...

  1. to

...

  1. limit

...

  1. Maximum number of results?

...

  1. offset

...

  1. orderBy

...

  1. Determines how the results are ordered. Options are:
  • caller
  • callee
  • startTime
  • duration
  • termination|
  1. Specific Response Codes: N/A
  2. HTTP Method: GET
  3. Downloads a report in the PDF format for the specified user ID, user name or alias.
        1. Example: N/A
  4. Unsupported HTTP Method: PUT, POST, DELETE

...

The System Web Service supported are SOAP based services. This service use the Web Service Definition Language (WSDL) to define the interface supported.
URI: https://<host name or address>/sipxconfig/services/SystemService
WSDL:
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="Domain">
<sequence>
<element name="name" type="xsd:string" />
<element name="realm" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="aliases" type="xsd:string" />
</sequence>
</complexType>
<complexType name="SystemInfo">
<sequence>
<element name="domain" type="impl:Domain" />
</sequence>
</complexType>
<element name="SystemInfo" type="impl:SystemInfo" />
</schema>
</wsdl:types>
<wsdl:message name="systemInfoRequest" />
<wsdl:message name="systemInfoResponse">
<wsdl:part element="impl:SystemInfo" name="SystemInfo" />
</wsdl:message>
<wsdl:portType name="SystemService">
<wsdl:operation name="systemInfo">
<wsdl:input message="impl:systemInfoRequest" name="systemInfoRequest" />
<wsdl:output message="impl:systemInfoResponse" name="systemInfoResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="SystemServiceSoapBinding" type="impl:SystemService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="systemInfo">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="systemInfoRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="systemInfoResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:SystemServiceSoapBinding" name="SystemService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/SystemService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>

...

Name: systemInfo
Description: Query to provide minimal information about the system.
Input parameters: None
Output parameters:

Name

Value Type

Description

name

string

System name.

realm

string

Domain of the system.

Example: Remove all Call Groups (example: Hunt Groups), Park Orbits and Permissions defined.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService">
<soapenv:Header/>
<soapenv:Body>
<con:ResetServices>
<!-Optional:->
<callGroup>true</callGroup>
<!-Optional:->
<parkOrbit>true</parkOrbit>
<!-Optional:->
<permission>true</permission>
</con:ResetServices>
</soapenv:Body>
</soapenv:Envelope>

Response

N/A

...

There is currently one XMLRPC APIs available from the sipXopenfire plugin.

...

XML-RPC presence java clients provided by sipxecs (sipXopenfire project) can be used using the SHARED_SECRET
NOTE: Calls are secured using BASIC Authentication
Example using curl CLI tool to get presence information

...

Method name: getUnifiedPresenceInfo
Description: This method returns XMPP information being given the sip extension, as described below.
Step 1. Create a file called get-presence.xml with content, replace 200 with the SIP user ID you wish to get presence information on:
<methodCall>
<methodName>presenceServer.getUnifiedPresenceInfo</methodName>
<params>
<param>
<value>
<string>2011</string>
</value>
</param>
</params>
</methodCall>
Step 2. Then run this command, replacing mypbx.example.com with the FQDN of your sipXecs system:
curl {color}
-H "Content-Type: application/xml" {color}
-X POST {color}
--data-binary @get-presence.xml {color}
http://<user>:<password>@mypbx.example.com:9094/plugins/sipx-openfire-presence/status

Response example:
<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
<params>
<param>
<value>
<struct>
<member>
<name>custom-presence-message</name>
<value></value>
</member>
<member>
<name>sip-id</name>
<value>2011</value>
</member>
<member>
<name>status-code</name>
<value>ok</value>
</member>
<member>
<name>unified-presence</name>
<value>available-for-both</value>
</member>
<member>
<name>jabber-id</name>
<value>mirceac@openuc.ezuce.com</value>
</member>
<member>
<name>xmpp-presence</name>
<value>AVAILABLE</value>
</member>
<member>
<name>sip-presence</name>
<value>IDLE</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>

...

Method name: getXMPPUsername
Description: This method returns the xmpp username being given the email address saved in user-portal: contact information page.

XML Request

<methodCall>
<methodName>presenceServer.getXmppUsername</methodName>
<params>
<param>
<value>
<string>mirceac@ezuce.com</string>
</value>
</param>
</params>
</methodCall>

Response

<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
<params>
<param>
<value>
<struct>
<member>
<name>sip-id</name>
<value>mirceac</value>
</member>
<member>
<name>status-code</name>
<value>ok</value>
</member>
</struct>
</value>
</param>
</params>

...

Method name: getPresenceState
Description: This method returns the presence state being given the XMPP ID. The string representation of the presence might be: AVAILABLE, AWAY, BUSY, OFFLINE, CHAT, EXTENDED_AWAY.

XML Request

<methodCall>
<methodName>presenceServer.getPresenceState</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
</params>

Response

<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
<params>
<param>
<value>
<struct>
<member>
<name>status-code</name>
<value>ok</value>
</member>
<member>
<name>xmpp-presence</name>
<value>AVAILABLE</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
</methodCall>

...

Method name: setPresenceState
Description: This method changes the presence state of the given XMPP user id The xmppPresenceAsString parameter can have the following String representations: AVAILABLE, AWAY, BUSY, OFFLINE, CHAT, EXTENDED_AWAY.

XML Request

? (String xmppUsername, String xmppPresenceAsString)?
XML to send:
<methodCall>
<methodName>presenceServer.setPresenceState</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
<param>
<value>
<string>AWAY</string>
</value>
</param>
</params>
</methodCall>

Response

? (String xmppUsername, String xmppPresenceAsString)?
XML to send:
<methodCall>
<methodName>presenceServer.setPresenceState</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
<param>
<value>
<string>AWAY</string>
</value>
</param>
</params>
</methodCall>

...

Method name: setPresenceStatus
Description: This method sets the given status message of the given XMPP user ID.
(String id, String status)

XML Request

<methodCall>
<methodName>presenceServer.setPresenceStatus</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
<param>
<value>
<string>Here</string>
</value>
</param>
</params>
</methodCall>

Response

<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
<params>
<param>
<value>
<struct>
<member>
<name>status-code</name>
<value>ok</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>

...

Method name: getPresenceStatus
Description: This method returns the presence status message of the given XMPP user ID.
public Map getPresenceStatus(String id)

XML Request

<methodCall>
<methodName>presenceServer.getPresenceStatus</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
</params>
</methodCall>

Response

<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
<params>
<param>
<value>
<struct>
<member>
<name>custom-presence-message</name>
<value>Here</value>
</member>
<member>
<name>status-code</name>
<value>ok</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>

...

Method name: setPresenceState
Description: This method verifies if the XMPP server is running.
(String originatorName)

XML Request

<methodCall>
<methodName>presenceServer.ping</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
</params>
</methodCall>

Response

<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
<params>
<param>
<value>
<struct>
<member>
<name>status-code</name>
<value>ok</value>
</member>
<member>
<name>instance-handle</name>
<value>of:821711375117195347</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>

...

Method name: registerPresenceMonitor
Description: This method registers a listener to be notified when the presence changes.
(String protocol, String serverUrl )

XML Request

? (String xmppUsername, String xmppPresenceAsString)?
XML to send:
<methodCall>
<methodName>presenceServer.setPresenceState</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
<param>
<value>
<string>AWAY</string>
</value>
</param>
</params>
</methodCall>

Response

? (String xmppUsername, String xmppPresenceAsString)?
XML to send:
<methodCall>
<methodName>presenceServer.setPresenceState</methodName>
<params>
<param>
<value>
<string>mirceac</string>
</value>
</param>
<param>
<value>
<string>AWAY</string>
</value>
</param>
</params>
</methodCall>

...

  1. Property
  1. Description
  1. id
  1. Server unique identification number.
  1. host

Name of the host server.

  1. ip

The IP address.

  1. primary

Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

  1. registered

Displays True if it is a registered server or False if it's not.

  1. description

Short description provided by the user.

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
servers: \[2\]

...

  1. primary: true

...

      1. ip: "195.167.1.323"

...

  1. Configures a new node.

...

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

    Name of the host server.

    1. ip

    The IP address.

    1. primary

    Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

    1. registered

    Displays True if it is a registered server or False if it's not.

    1. description

    Short description provided by the user.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves nodes for the specified internal ID or host name.
        1. Example: XML format
  8. <Server>
  9. <id>1</id>
  10. <host>openuc_1410.ezuce.ro</host>
  11. <ip>195.167.1.323</ip>
  12. <primary>true</primary>
  13. <registered>true</registered>
  14. <description>Primary</description>
  15. </Server>
    1. JSON format
  16. {
    1. primary: true
  17. description: "Primary"
  18. host: "openuc_1410.ezuce.ro"
  19. id: 1
  20. registered: true
        1. ip: "195.167.1.323"
  21. {
  22. HTTP Method: PUT
    1. Creates a new node node for the specified internal ID or host name.
  23. HTTP Method: DELETE
    1. Deletes the node node for the specified internal ID or host name.
  24. Unsupported HTTP Method: POST

...

  1. Property
  1. Description
  1. name
    1. Name of the feature.
    1. bundle

Name of the bundle taht contains the feature.

    1. type

Feature type.

    1. enabeled

Displays True if it is a registered server or False if it's not.

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
features: \[36\]

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/{serverId}/features/{featureId}
  3. Default Resource Properties: N/A
  4. Specific Response Codes: N/A
  5. HTTP Method: DELETE
  6. Disable location based feature for the specified node.
  7. HTTP Method: POST
      1. Enable location based feature for the specified node.
  8. Unsupported HTTP Method: GET, POST

...

  1. Property
  1. Description
  1. name
  1. Job name.
  1. status

Job status. Possible values are: Completed or Failed.

  1. start

Start date of the job.

  1. end

End date of the job.

  1. server

The server related information is similar to the one described under /servers/{serverId}.

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
jobs: \[3\]

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/jobs/completed
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. job
    1. The jobs related information is similar to the one described under /servers/jobs.
            1. server

    The server related information is similar to the one described under /servers/{serverId}.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve completed jobs on all servers.
        1. Example: XML format
  8. <Jobs>
  9. <Job>
  10. <name>Configuration deployment</name>
  11. <status>COMPLETED</status>
  12. <start>9/8/14 12:34 PM</start>
  13. <end>9/8/14 12:34 PM</end>
  14. <server>
  15. <id>1</id>
  16. <host>o14_10.ezuce.ro</host>
  17. <ip>192.234.3.788</ip>
  18. <primary>true</primary>
  19. <registered>true</registered>
  20. <description>Primary</description>
  21. </server>
  22. <errMsg />
  23. </Job>
  24. <Job>
  25. <name>Configuration generation</name>
  26. <status>COMPLETED</status>
  27. <start>9/8/14 12:36 PM</start>
  28. <end>9/8/14 12:36 PM</end>
  29. <errMsg />
  30. </Job>
  31. <Job>
  32. </Jobs>
    1. JSON format
  33. {
  34. errMsg: ""
  35. server: {
  36. primary: true
  37. description: "Primary"
  38. host: "o14_10.ezuce.ro"
  39. id: 1
  40. registered: true
  41. ip: "152.667.1.141"
  42. }-
  43. status: "FAILED"
  44. start: "9/8/14 12:36 PM"
  45. end: "9/8/14 12:36 PM"
  46. name: "Configuration deployment"
  47. }-
  48. -
  49. }
  50. HTTP Method: DELETE
  51. Delete completed jobs on all servers.
  52. Unsupported HTTP Method: POST, PUT

...

  1. Property
  1. Description
  1. job
  1. The jobs related information is similar to the one described under /servers/jobs.
          1. server

The server related information is similar to the one described under /servers/{serverId}.

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
jobs: \[1\]

...

  1. Property
  1. Description
  1. job
  1. The jobs related information is similar to the one described under /servers/jobs.
          1. server

The server related information is similar to the one described under /servers/{serverId}.

...

      1. Example: XML format

...

  1. JSON format

...

  1. Property
  1. Description
  1. job
  1. The jobs related information is similar to the one described under /servers/jobs.
          1. server

The server related information is similar to the one described under /servers/{serverId}.

...

      1. Example: XML format
  1. JSON format

...

  1. Property
  1. Description
  1. name
  1. Bundle name.
  1. globalFeature

List of global features.

  1. locationFeature

List of location features.

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
bundles: \[6\]

...

Wiki Markup
locationFeatures: \[4\]

...

Wiki Markup
globalFeatures: \[7\]

...

Wiki Markup
locationFeatures: \[22\]

...

Wiki Markup
globalFeatures: \[1\]

...

Wiki Markup
locationFeatures: \[2\]

...

Wiki Markup
globalFeatures: \[0\]

...

Wiki Markup
locationFeatures: \[2\]

...

Wiki Markup
globalFeatures: \[0\]

...

Wiki Markup
locationFeatures: \[6\]

...

Wiki Markup
globalFeatures: \[0\]

...

Wiki Markup
locationFeatures: \[0\]

Wiki Markup
globalFeatures: \[0\]

...

  1. Property
  1. Description
  1. name
  1. Bundle name.
  1. globalFeature

List of global features.

  1. locationFeature

List of location features.

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
locationFeatures: \[2\]

...

Wiki Markup
globalFeatures: \[0\]

...

  1. Property
  1. Description
  1. name
  1. Feature name.
  1. bundle

The bundle containig the feature.

  1. type

Feature type.

  1. enabled

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

...

      1. Example: XML format

...

  1. JSON format

...

Wiki Markup
features: \[44\]

...

  1. Property
  1. Description
  1. id
  1. Unique identification number of the server.
  1. host

Server host.

  1. ip

IP address.

  1. primary

Displays True if the server is primary or False if it is not.

  1. registered

Displays True if the server is registered or False if it is not.

  1. description

Short description provided by the user.

...

      1. Example: XML format

...

  1. JSON format

...

  1. Property
  1. Description
  1. name
  1. Feature name.
  1. bundle

The bundle containig the feature.

  1. type

Feature type.

  1. enabled

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

...

      1. Example: XML format

...

  1. JSON format

...

  1. Property

...

  1. Description

...

 

...

Page Tree
root5. Diagnose