Web Services defined in this section for configuration of the system are all SOAP based services and require administrator privileges to be used.
The following resources for the Configuration API are only available for users with administration rights:
Permissions
Call Groups
Users
Phones
Tests
The Permission Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/PermissionService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="Permission">
<sequence>
<element name="name" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="label" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="defaultValue" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="type" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="builtIn" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<complexType name="AddPermission">
<sequence>
<element name="permission" type="impl:Permission" />
</sequence>
</complexType>
<element name="AddPermission" type="impl:AddPermission" />
<complexType name="PermissionSearch">
<sequence>
<element maxOccurs="1" minOccurs="0" name="byName" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byLabel" type="xsd:string" />
</sequence>
</complexType>
<complexType name="FindPermission">
<sequence>
<element name="search" type="impl:PermissionSearch" />
</sequence>
</complexType>
<element name="FindPermission" type="impl:FindPermission" />
<complexType name="ArrayOfPermission">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:Permission" />
</sequence>
</complexType>
<complexType name="FindPermissionResponse">
<sequence>
<element name="permissions" type="impl:ArrayOfPermission" />
</sequence>
</complexType>
<element name="FindPermissionResponse" type="impl:FindPermissionResponse" />
<complexType name="Property">
<sequence>
<element name="property" type="xsd:string" />
<element name="value" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="ManagePermission">
<sequence>
<element name="search" type="impl:PermissionSearch" />
<element maxOccurs="unbounded" name="edit" type="impl:Property" />
<element maxOccurs="1" minOccurs="0" name="deletePermission" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<element name="ManagePermission" type="impl:ManagePermission" />
</schema>
</wsdl:types>
<wsdl:message name="findPermissionRequest">
<wsdl:part element="impl:FindPermission" name="FindPermission" />
</wsdl:message>
<wsdl:message name="managePermissionRequest">
<wsdl:part element="impl:ManagePermission" name="ManagePermission" />
</wsdl:message>
<wsdl:message name="addPermissionRequest">
<wsdl:part element="impl:AddPermission" name="AddPermission" />
</wsdl:message>
<wsdl:message name="findPermissionResponse">
<wsdl:part element="impl:FindPermissionResponse" name="FindPermissionResponse" />
</wsdl:message>
<wsdl:message name="addPermissionResponse" />
<wsdl:message name="managePermissionResponse" />
<wsdl:portType name="PermissionService">
<wsdl:operation name="addPermission" parameterOrder="AddPermission">
<wsdl:input message="impl:addPermissionRequest" name="addPermissionRequest" />
<wsdl:output message="impl:addPermissionResponse" name="addPermissionResponse" />
</wsdl:operation>
<wsdl:operation name="findPermission" parameterOrder="FindPermission">
<wsdl:input message="impl:findPermissionRequest" name="findPermissionRequest" />
<wsdl:output message="impl:findPermissionResponse" name="findPermissionResponse" />
</wsdl:operation>
<wsdl:operation name="managePermission" parameterOrder="ManagePermission">
<wsdl:input message="impl:managePermissionRequest" name="managePermissionRequest" />
<wsdl:output message="impl:managePermissionResponse" name="managePermissionResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="PermissionServiceSoapBinding" type="impl:PermissionService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addPermission">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addPermissionRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addPermissionResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="findPermission">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="findPermissionRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="findPermissionResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="managePermission">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="managePermissionRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="managePermissionResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:PermissionServiceSoapBinding" name="PermissionService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/PermissionService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Note: wsdlsoap:address location specified at the end of the WSDL will be specific to your system.
Name: addPermission
Description: Add a custom call permission to the system.
Input parameters:
Name | Value type | Required/Optional | Description | Editable/Read only |
name | string | required | The name of the Permission to add. Even though it is a required parameter, its value is ignored and an internal name is generated. | editable |
label | string | optional | The label of the Permission to add. Label is the name displayed in the Administration graphical user interface. | editable |
description | string | optional | Describes the permission. | editable |
defaultValue | boolean | optional | Indicates whether the permission is enabled (true) or disabled (false) by default for Users. | editable |
type | string | The type of permission. This is a read-only value. Any string placed in this field during an add will be ignored. | read only | |
builtIn | boolean | Indicates whether the permission is builtin(true) or not(false). Any value placed in this field during an add will be ignored. | read only |
Output parameters: empty response
Example: Adding a call permission with label "Test Three" whose default value is false.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Name: findPermission
Description: Search for a permission or permissions defined in the system.
Input parameters:
Name | Value Type | Required/Optional | Description | Editable/Read only |
byName | string | Optional | Indicates a search for permissions by their name. May be null. | Editable |
byLabel | string | Optional | Indicates a search for permissions by their label. May be null. | Editable |
Output parameters: Array of items representing the permissions found in the search.
Name | Value Type | Description |
name | string | The name of thepermission. |
label | string | The value representing the label of the permission. |
description | string | Describes the permission. |
defaultValue | Boolean indicating whether the permission is enabled (true) or disabled (false) by default for Users. | |
builtIn | boolean | Indicates whether the permission is builtin(true) or not(false). |
Example: Search to find all permissions defined in the system.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Example: Search to find permission with label "Test Three"
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Name: managePermission
Description: Manage (update or delete) existing permissions defined in the system. Only permissions which are not built into the system can be edited or deleted.
Input parameters:
Name | Value Type | Required/Optional | Description | Editable/Read only |
byName | string | optional | String used to indicate a search for permissions by their name. May be null. Name is an internally generated value and may not be useful for searching. | Editable |
byLabel | string | optional | Indicates a search for permissions by their label. May be null. | Editable |
property | Name of the permission field to edit. | |||
value | Value to use for the permission field being edited. | |||
deletepermission | boolean | optional | indicating to delete (true) a permission. |
Output parameters: Empty response.
Example:
Request | |
Response | N/A |
The CallGroup Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
A Call Group service deals with information related to Hunt Groups. Any information queried or added in one of the implemented services are mapped to Hunt Group in the System Administration.
URI: https://<host name or address>/sipxconfig/services/CallGroupService
WSDL:
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="UserRing">
<sequence>
<element name="expiration" type="xsd:int" />
<element name="type" type="xsd:string" />
<element name="position" type="xsd:int" />
<element name="userName" type="xsd:string" />
</sequence>
</complexType>
<complexType name="CallGroup">
<sequence>
<element name="name" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="extension" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="enabled" nillable="true" type="xsd:boolean" />
<element maxOccurs="unbounded" minOccurs="0" name="rings" nillable="true" type="impl:UserRing" />
</sequence>
</complexType>
<complexType name="AddCallGroup">
<sequence>
<element name="callGroup" type="impl:CallGroup" />
</sequence>
</complexType>
<element name="AddCallGroup" type="impl:AddCallGroup" />
<complexType name="ArrayOfCallGroup">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:CallGroup" />
</sequence>
</complexType>
<complexType name="GetCallGroupsResponse">
<sequence>
<element name="callGroups" type="impl:ArrayOfCallGroup" />
</sequence>
</complexType>
<element name="GetCallGroupsResponse" type="impl:GetCallGroupsResponse" />
</schema>
</wsdl:types>
<wsdl:message name="getCallGroupsResponse">
<wsdl:part element="impl:GetCallGroupsResponse" name="GetCallGroupsResponse" />
</wsdl:message>
<wsdl:message name="getCallGroupsRequest" />
<wsdl:message name="addCallGroupResponse" />
<wsdl:message name="addCallGroupRequest">
<wsdl:part element="impl:AddCallGroup" name="AddCallGroup" />
</wsdl:message>
<wsdl:portType name="CallGroupService">
<wsdl:operation name="addCallGroup" parameterOrder="AddCallGroup">
<wsdl:input message="impl:addCallGroupRequest" name="addCallGroupRequest" />
<wsdl:output message="impl:addCallGroupResponse" name="addCallGroupResponse" />
</wsdl:operation>
<wsdl:operation name="getCallGroups">
<wsdl:input message="impl:getCallGroupsRequest" name="getCallGroupsRequest" />
<wsdl:output message="impl:getCallGroupsResponse" name="getCallGroupsResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="CallGroupServiceSoapBinding" type="impl:CallGroupService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addCallGroup">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addCallGroupRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addCallGroupResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getCallGroups">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="getCallGroupsRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="getCallGroupsResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:CallGroupServiceSoapBinding" name="CallGroupService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/CallGroupService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Name: addCallGroup
Description: Add a new hunt group to the system.
Input parameters:
Name | Value Type | Required/Optional | Description | Editable/Read only |
name | string | required | String representing the name of the hunt group to add. | editable |
extension | string | optional | the extension to be associated with the hunt group. | editable |
description | string | optional | describes the hunt group. | editable |
enabled | boolean | optional | Indicates whether the hunt group is enabled (true) or disabled (false). | |
rings | array | optional | describing the members of the hunt group, their position in the group, time (in seconds) to ring the user, | 0 or more repetitions |
expiration | Time in seconds to present the call to user. | |||
type | string | the ring sequence. Can be "delayed" or "immediate". Delayed is used to build a sequential type of hunt group and immediate a broadcast type of hunt group. A mixture of delayed and immediate can be used. | ||
position | The unique position (starting at 0) of the user in the group. | |||
username | string | the extension of the user. |
Output parameters: Empty response.
Example: Add a new hunt group "TestGroup2" that is enabled, dialable at extension 556 and contains 4 members (212, 215, 211, 221).
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Name: getCallGroups
Description: Query the hunt groups defined in the system.
Input parameters: None
Output parameters: Array of items representing the permissions found in the search.
Name | Value Type | Description |
name | string | the name of the hunt group. |
Extension | string | representing the extension associated with the hunt group. |
description | string | Describes the hunt group. |
enabled | boolean | indicating whether the hunt group is enabled (true) or disabled (false). |
rings | array | Describing the members of the hunt group, their position in the group, time (in seconds) to ring the user (0 or more repetitions). |
expiration | Time in seconds to present the call to user. | |
type | string | representing the ring sequence. Can be "delayed" or "immediate". Delayed is used to build a sequential type of hunt group and immediate a broadcast type of hunt group. A mixture of delayed and immediate can be used. |
position | The unique position (starting at 0) of the user in the group. | |
username | string | String representing the extension of the user. |
Example: Query of the hunt groups defined in the system.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> |
Response |
The User Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/UserService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="User">
<sequence>
<element name="userName" type="xsd:string" />
<element name="pintoken" nillable="true" type="xsd:string" />
<element name="lastName" nillable="true" type="xsd:string" />
<element name="firstName" nillable="true" type="xsd:string" />
<element name="sipPassword" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="aliases" nillable="true" type="xsd:string" />
<element name="emailAddress" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="groups" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="permissions" nillable="true" type="xsd:string" />
<element maxOccurs="1" name="branchName" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddUser">
<sequence>
<element name="user" type="impl:User" />
<element name="pin" type="xsd:string" />
</sequence>
</complexType>
<element name="AddUser" type="impl:AddUser" />
<complexType name="UserSearch">
<sequence>
<element maxOccurs="1" minOccurs="0" name="byUserName" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byFuzzyUserNameOrAlias" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byGroup" type="xsd:string" />
</sequence>
</complexType>
<complexType name="FindUser">
<sequence>
<element name="search" type="impl:UserSearch" />
</sequence>
</complexType>
<element name="FindUser" type="impl:FindUser" />
<complexType name="ArrayOfUser">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:User" />
</sequence>
</complexType>
<complexType name="FindUserResponse">
<sequence>
<element name="users" type="impl:ArrayOfUser" />
</sequence>
</complexType>
<element name="FindUserResponse" type="impl:FindUserResponse" />
<complexType name="Property">
<sequence>
<element name="property" type="xsd:string" />
<element name="value" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="ManageUser">
<sequence>
<element name="search" type="impl:UserSearch" />
<element maxOccurs="unbounded" name="edit" type="impl:Property" />
<element maxOccurs="1" minOccurs="0" name="deleteUser" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="addGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="removeGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="updateGroup" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<element name="ManageUser" type="impl:ManageUser" />
</schema>
</wsdl:types>
<wsdl:message name="findUserRequest">
<wsdl:part element="impl:FindUser" name="FindUser" />
</wsdl:message>
<wsdl:message name="addUserRequest">
<wsdl:part element="impl:AddUser" name="AddUser" />
</wsdl:message>
<wsdl:message name="manageUserResponse" />
<wsdl:message name="addUserResponse" />
<wsdl:message name="manageUserRequest">
<wsdl:part element="impl:ManageUser" name="ManageUser" />
</wsdl:message>
<wsdl:message name="findUserResponse">
<wsdl:part element="impl:FindUserResponse" name="FindUserResponse" />
</wsdl:message>
<wsdl:portType name="UserService">
<wsdl:operation name="addUser" parameterOrder="AddUser">
<wsdl:input message="impl:addUserRequest" name="addUserRequest" />
<wsdl:output message="impl:addUserResponse" name="addUserResponse" />
</wsdl:operation>
<wsdl:operation name="findUser" parameterOrder="FindUser">
<wsdl:input message="impl:findUserRequest" name="findUserRequest" />
<wsdl:output message="impl:findUserResponse" name="findUserResponse" />
</wsdl:operation>
<wsdl:operation name="manageUser" parameterOrder="ManageUser">
<wsdl:input message="impl:manageUserRequest" name="manageUserRequest" />
<wsdl:output message="impl:manageUserResponse" name="manageUserResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="UserServiceSoapBinding" type="impl:UserService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addUser">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addUserRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addUserResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="findUser">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="findUserRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="findUserResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="manageUser">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="manageUserRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="manageUserResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:UserServiceSoapBinding" name="UserService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/UserService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Note: wsdlsoap:address location specified at the end of the WSDL will be specific to your system.
Name: addUser
Description: Add a new user to the system.
Input parameters:
Name | Value Type | Required/Optional | Description | Editable/Read only |
userName | string | required | the name of the user to add. | editable |
pintoken | string | optional | An internally generated token that is an encrypted version of the voicemail pin. This field should not be specified as it will be internally generated. | read only |
lastName | string | optional | The last name of the user. | editable |
firstName | string | optional | the first name of the user. | editable |
sipPassword | string | optional | the SIP password for the user. | |
aliases | array | Array of strings, each representing membership in defined groups.(0 or more repetitions) | ||
permissions | array | rray of strings, each representing a permission name that is granted to the user. Permissions can be general or call permissions. Permissions defined in the system can be obtained using the Permission Services (findPermission).(0 or more repetitions) | ||
pin | string | required | The PIN for the user. | editable |
branchName | string | optional | user's branch. | editable |
Output parameters: Empty response.
Example: Add a new user 223 to the system with sipPassword 4567, pin 1234 along with various permissions and group memberships, in branch Berlin.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Name: findUser
Description: Find a defined user(s) in the system.
Input parameters: Either no parameters (for a listing of all users) should be provided or one of the following optional parameters.
Name | Value Type | Required/Optional | Description | Editable/Read only |
byUserName | string | optional | the name of the user to find. | editable |
byFuzzyUserNameOrAlias | string | optional | a partial user name or alias to search for. This represents sort type of wildcard search. | editable |
byGroup | string | optional | the users which are members of a particular defined group. | editable |
Output parameters: An array of 0 or more of the following:
Name | Value Type | Description |
userName | string | the name of the user to add. |
pintoken | string | an internally generated token that is an encrypted version of the pin. |
lastName | string | the last name of the user. |
firstName | string | the first name of the user. |
sipPassword | string | the SIP password for the user. |
aliases | array | Array of strings, each representing a user alias. (0 or more repetitions) |
emailAddress | string | the email address for the user. |
groups | array | Array of strings, each representing membership in defined groups. |
pin– | string | the PIN for the user. |
branchName | string | user's branch. |
Example: Find all defined users in the system.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Example: Find all users that are members of the group "Managers".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Example: Find the user userName "223".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Example: Find users whose userName begins with "22".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Name: manageUser
Description: Manage (update or delete) existing users defined in the system.
Input parameters: Either no parameters (for a listing of all users) should be provided or one of the following optional parameters.
Name | Value Type | Required/Optional | Description | Editable/Read only |
byUserName | string | optional | The name of the user to find. | editable |
byFuzzyUserNameOrAlias | string | optional | A partial user name or alias to search for. This represents sort type of wildcard search. | editable |
byGroup | string | optional | The users which are members of a particular defined group. | editable |
property | string | optional | Name of the user field to edit. | editable |
value | string | optional | Edit parameter.Value to use for the user field being edited. | editable |
deleteUser | boolean | optional | indicating to delete (true) a user(s). This is dependent on the search results. | editable |
addGroup | string | optional | Add parameter. the name of the group to add the user(s) to. This is dependent on the search results. | editable |
removeGroup | string | optional | the name of the group to remove the user(s) from. This is dependent on the search results. | editable |
updateBranch | string | optional | the name of the branch to update the user(s) to. | editable |
Output parameters: Empty response
Example: Remove all users in the system beginning with username "22" from group "Managers"
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
Example: Add user with username "211" to the group "Managers".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
Example: Change all users from group "Managers" to have a lastName of "SuperDog" and firstName of "I am"
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
Example: Update user with username "211" to the branch "Berlin".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
The Park Orbit Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
Note that starting with V14.10, new REST APIS have been implement for the park orbit functionality.
URI: https://<host name or address>:8443/sipxconfig/services/ParkOrbitService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="ParkOrbit">
<sequence>
<element name="name" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="extension" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="enabled" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="music" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddParkOrbit">
<sequence>
<element name="parkOrbit" type="impl:ParkOrbit" />
</sequence>
</complexType>
<element name="AddParkOrbit" type="impl:AddParkOrbit" />
<complexType name="ArrayOfParkOrbit">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:ParkOrbit" />
</sequence>
</complexType>
<complexType name="GetParkOrbitsResponse">
<sequence>
<element name="parkOrbits" type="impl:ArrayOfParkOrbit" />
</sequence>
</complexType>
<element name="GetParkOrbitsResponse" type="impl:GetParkOrbitsResponse" />
</schema>
</wsdl:types>
<wsdl:message name="addParkOrbitRequest">
<wsdl:part element="impl:AddParkOrbit" name="AddParkOrbit" />
</wsdl:message>
<wsdl:message name="addParkOrbitResponse" />
<wsdl:message name="getParkOrbitsResponse">
<wsdl:part element="impl:GetParkOrbitsResponse" name="GetParkOrbitsResponse" />
</wsdl:message>
<wsdl:message name="getParkOrbitsRequest" />
<wsdl:portType name="ParkOrbitService">
<wsdl:operation name="addParkOrbit" parameterOrder="AddParkOrbit">
<wsdl:input message="impl:addParkOrbitRequest" name="addParkOrbitRequest" />
<wsdl:output message="impl:addParkOrbitResponse" name="addParkOrbitResponse" />
</wsdl:operation>
<wsdl:operation name="getParkOrbits">
<wsdl:input message="impl:getParkOrbitsRequest" name="getParkOrbitsRequest" />
<wsdl:output message="impl:getParkOrbitsResponse" name="getParkOrbitsResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="ParkOrbitServiceSoapBinding" type="impl:ParkOrbitService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addParkOrbit">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addParkOrbitRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addParkOrbitResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getParkOrbits">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="getParkOrbitsRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="getParkOrbitsResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:ParkOrbitServiceSoapBinding" name="ParkOrbitService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/ParkOrbitService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Name: addParkOrbit
Description: Add a new call park orbit to the system.
Input parameters: Either no parameters (for a listing of all users) should be provided or one of the following optional parameters.
Name | Value Type | Required/Optional | Description | Editable/Read only |
name | string | required | the name of the call park orbit to add. | editable |
extension | string | optional | the dialable extension to be used. | editable |
description | string | optional | description of the call park orbit. | editable |
enabled | boolean | optional | indicating if the call park orbit is enabled(true) or not(false). | editable |
music | path | optional | Path to a wave file (of the appropriate format) to play as background music for calls parked on this orbit. | editable |
Output parameters: Empty response
Example: Add a new call park orbit with name "ParkSales", extension "46" and is enabled.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
Name: getParkOrbits
Description: Queries information on all call park orbits defined in the system.
Input parameters: None.
Output parameters:
Name | Value Type | Description |
name | string | the name of the call park orbit. |
extension | string | the dialable extension. |
description | string | a description of the call park orbit. |
enabled | boolean | indicating if the call park orbit is enabled(true) or not(false). |
music | Path to a wave file (of the appropriate format) to play as background music for calls parked on this orbit. |
Example: Query the call park orbits defined in the system.
Request | N/A |
Response | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> |
The Phone Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/PhoneService
WSDL:
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:apachesoap="http://xml.apache.org/xml-soap" xmlns:impl="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:intf="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
- <!--
WSDL created by Apache Axis version: 1.4
Built on Apr 22, 2006 (06:55:48 PDT)
-->
<wsdl:types>
<schema targetNamespace="http://www.sipfoundry.org/2007/08/21/ConfigService" xmlns="http://www.w3.org/2001/XMLSchema">
<complexType name="Line">
<sequence>
<element name="userId" type="xsd:string" />
<element name="uri" type="xsd:string" />
</sequence>
</complexType>
<complexType name="Phone">
<sequence>
<element name="serialNumber" type="xsd:string" />
<element name="modelId" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="description" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="groups" nillable="true" type="xsd:string" />
<element maxOccurs="unbounded" minOccurs="0" name="lines" nillable="true" type="impl:Line" />
<element maxOccurs="1" minOccurs="0" name="deviceVersion" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddPhone">
<sequence>
<element name="phone" type="impl:Phone" />
</sequence>
</complexType>
<element name="AddPhone" type="impl:AddPhone" />
<complexType name="PhoneSearch">
<sequence>
<element maxOccurs="1" minOccurs="0" name="bySerialNumber" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="byGroup" type="xsd:string" />
</sequence>
</complexType>
<complexType name="FindPhone">
<sequence>
<element name="search" type="impl:PhoneSearch" />
</sequence>
</complexType>
<element name="FindPhone" type="impl:FindPhone" />
<complexType name="ArrayOfPhone">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="item" type="impl:Phone" />
</sequence>
</complexType>
<complexType name="FindPhoneResponse">
<sequence>
<element name="phones" type="impl:ArrayOfPhone" />
</sequence>
</complexType>
<element name="FindPhoneResponse" type="impl:FindPhoneResponse" />
<complexType name="Property">
<sequence>
<element name="property" type="xsd:string" />
<element name="value" nillable="true" type="xsd:string" />
</sequence>
</complexType>
<complexType name="AddExternalLine">
<sequence>
<element name="userId" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="displayName" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="password" type="xsd:string" />
<element name="registrationServer" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="voiceMail" type="xsd:string" />
</sequence>
</complexType>
<complexType name="ManagePhone">
<sequence>
<element name="search" type="impl:PhoneSearch" />
<element maxOccurs="unbounded" name="edit" type="impl:Property" />
<element maxOccurs="1" minOccurs="0" name="deletePhone" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="addGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="removeGroup" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="addLine" nillable="true" type="impl:Line" />
<element maxOccurs="1" minOccurs="0" name="addExternalLine" nillable="true" type="impl:AddExternalLine" />
<element maxOccurs="1" minOccurs="0" name="removeLineByUserId" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="removeLineByUri" nillable="true" type="xsd:string" />
<element maxOccurs="1" minOccurs="0" name="generateProfiles" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="restart" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<element name="ManagePhone" type="impl:ManagePhone" />
</schema>
</wsdl:types>
<wsdl:message name="findPhoneRequest">
<wsdl:part element="impl:FindPhone" name="FindPhone" />
</wsdl:message>
<wsdl:message name="managePhoneResponse" />
<wsdl:message name="addPhoneResponse" />
<wsdl:message name="managePhoneRequest">
<wsdl:part element="impl:ManagePhone" name="ManagePhone" />
</wsdl:message>
<wsdl:message name="addPhoneRequest">
<wsdl:part element="impl:AddPhone" name="AddPhone" />
</wsdl:message>
<wsdl:message name="findPhoneResponse">
<wsdl:part element="impl:FindPhoneResponse" name="FindPhoneResponse" />
</wsdl:message>
<wsdl:portType name="PhoneService">
<wsdl:operation name="addPhone" parameterOrder="AddPhone">
<wsdl:input message="impl:addPhoneRequest" name="addPhoneRequest" />
<wsdl:output message="impl:addPhoneResponse" name="addPhoneResponse" />
</wsdl:operation>
<wsdl:operation name="findPhone" parameterOrder="FindPhone">
<wsdl:input message="impl:findPhoneRequest" name="findPhoneRequest" />
<wsdl:output message="impl:findPhoneResponse" name="findPhoneResponse" />
</wsdl:operation>
<wsdl:operation name="managePhone" parameterOrder="ManagePhone">
<wsdl:input message="impl:managePhoneRequest" name="managePhoneRequest" />
<wsdl:output message="impl:managePhoneResponse" name="managePhoneResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="PhoneServiceSoapBinding" type="impl:PhoneService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="addPhone">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="addPhoneRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="addPhoneResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="findPhone">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="findPhoneRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="findPhoneResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="managePhone">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="managePhoneRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="managePhoneResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:PhoneServiceSoapBinding" name="PhoneService">
<wsdlsoap:address location="https://47.134.206.174/sipxconfig/services/PhoneService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Note: wsdlsoap:address location specified at the end of the WSDL will be specific to your system.
Name: addPhone
Description: Add a new phone to the system.
Input parameters:
Name | Value Type | Required/Optional | Description | Editable/Read only |
serialNumber | string | required | the MAC address of the phone. | editable |
modelId | string | required | a supported model Id. For a complete list of supported phone tupes, see the list below. | editable |
description | string | optional | the description of the phone. | editable |
groups | string | optional | the phone group(s) this new phone will be in. (0 or more repetitions) | editable |
lines | string | optional | String representing the line(s) assigned to this phone.(0 or more repetitions) | editable |
deviceVersion | string | optional | The version of the phone. | editable |
Output parameters: Empty response
Example: Add a new "Polycom SounPoint IP 321" phone to the system and assign line "221" to it as well as put it in the phone group "FirstPhoneGroup".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
List of supported phones:
Name: findPhone
Description: Find a defined phone(s) in the system.
Input parameters: Either no parameters (for a listing of all phones) should be provided or one of the following optional parameters.
Name | Value Type | Required/Optional | Description | Editable/Read only |
bySerialNumber | string | required | the serial number (MAC address) of the phone to find. | editable |
byGroup | string | optional | the phones which are members of a particular defined phone group. | editable |
Output parameters: An array of 0 or more of the following:
Name | Value Type | Description |
serialNumber | string | the serial number (MAC address) of the phone. |
extension | string | the dialable extension. |
description | string | a description of the call park orbit. |
enabled | boolean | indicating if the call park orbit is enabled(true) or not(false). |
Example: Find all defined phones in the system.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Example: Find all phones that are members of the phone group "FirstPhoneGroup".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Example: Find the phone with serial number "000000000001".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response |
Name: managePhone
Description: Manage (update or delete) existing phones defined in the system.
Input parameters: Either no parameters (for a listing of all phones) should be provided or one of the following optional parameters.
Name | Value Type | Required/Optional | Description | Editable/Read only |
bySerialNumber | string | required | indicate a search for a phone by its serial number (MAC Address). May be null. | editable |
byGroup | string | optional | the phones which are members of a particular defined phone group. | editable |
property | Name of the phone field to edit. | |||
value | Value to use for the phone field being edited. | |||
deletePhone | boolean | optional | Boolean indicating to delete (true) a phone(s). This is dependent on the search results. | |
addGroup | optional | the name of the phone group to add the phone(s) to. This is dependent on the search results. | ||
removeGroup | string | optional | The name of the group to remove the phone(s) from. This is dependent on the search results. | |
addLine | string | optional | userId and uri representing a line to be added to the phone(s). This is dependent on the search results. | |
addExternalLine | string | optional | userId, displayName, password, registrationServer and voicemail of the external line to add to the phone(s). This is dependent on the search results. | |
userId | string | required | the user portion of the SIP URI and default value for authorization (i.e. 201, jsmith). | |
displayName | string | optional | the display name to use for the userId. | |
password | string | optional | the PIN/Password the the userId. | |
registrationServer | string | required | the domain where the userId resides. | |
voicemail | string | optional | the voicemail extension for the userId. | |
removeLineByUserId | string | optional | the userId of the line to remove from the phone(s). This is dependent on the search results. | |
removeLineByUri | string | optional | the uri of the line to remove the from the phone(s). This is dependent on the search results. | |
generateProfiles | boolean | optional | indicating to generate(true) the profiles for the phone(s). This is dependent on the search results. | |
restart | boolean | optional | indicating to restart(true) the phone(s). This is dependent on the search results. | |
Output parameters: Empty response
Example: Delete all phones which are part of the group "FirstPhoneGroup"
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
Example: Add line with userId "221" to the phones in "FirstPhoneGroup", generate the profiles for the phones and then restart them.
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
Example: Remove all the phones in "FirstPhoneGroup".
Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.sipfoundry.org/2007/08/21/ConfigService"> |
Response | N/A |
The Test Web Services supported are SOAP based services. These services use the Web Service Definition Language (WSDL) to define the interfaces supported.
URI: https://<host name or address>/sipxconfig/services/TestService
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="ResetServices">
<sequence>
<element maxOccurs="1" minOccurs="0" name="callGroup" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="parkOrbit" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="permission" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="phone" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="user" nillable="true" type="xsd:boolean" />
<element maxOccurs="1" minOccurs="0" name="superAdmin" nillable="true" type="xsd:boolean" />
</sequence>
</complexType>
<element name="ResetServices" type="impl:ResetServices" />
</schema>
</wsdl:types>
<wsdl:message name="resetServicesRequest">
<wsdl:part element="impl:ResetServices" name="ResetServices" />
</wsdl:message>
<wsdl:message name="resetServicesResponse" />
<wsdl:portType name="TestService">
<wsdl:operation name="resetServices" parameterOrder="ResetServices">
<wsdl:input message="impl:resetServicesRequest" name="resetServicesRequest" />
<wsdl:output message="impl:resetServicesResponse" name="resetServicesResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="TestServiceSoapBinding" type="impl:TestService">
<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="resetServices">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="resetServicesRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="resetServicesResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="ConfigImplService">
<wsdl:port binding="impl:TestServiceSoapBinding" name="TestService">
<wsdlsoap:address location="https://47.134.206.174:8443/sipxconfig/services/TestService" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Name: resetServices
Description: Resets(deletes) the data associated with one or more web services.
Note: This is an extremely dangerous service as it could permanently delete large amounts of configuration data. USE WITH EXTREME CAUTION
Input parameters:
Name | Value Type | Required/Optional | Description | Editable/Read only |
callGroup | boolean | optional | indicating to delete(true) all callGroup(i.e. Hunt Group) data. | editable |
parkOrbit | boolean | optional | indicating to delete(true) all Call Park Orbits. | editable |
permission | boolean | optional | indicating to delete(true) all non-system defined permissions. | editable |
phone | boolean | optional | indicating to delete(true) all defined phones. | editable |
user | boolean | optional | indicating to delete(true) all defined users(except superadmin). | editable |
superadmin | boolean | optional | indicating to delete(true) all superadmin data except for the PIN. | editable |
Output parameters: Empty response
Example: Remove all Call Groups (i.e. 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"> |
Response | N/A |