Child pages
  • System Service
Skip to end of metadata
Go to start of metadata

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>

View system information

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

  • No labels