When you install the 4PSA VoipNow Core system, the installer automatically unpacks a group of .xsd
and .wsdl
files in the folder: /usr/local/voipnowcore/admin/htdocs/soap/schema/<schema_version>/
These files define the available methods that can be performed through the web service. The third-party application developer must be aware of
the content of these files in order to determine the request and response package format. The structure of the .xsd
files is the
following:
voipnowcoreservice.wsdl
– Describes the interface of the web service, including all available web services.
HeaderData.xsd
– Defines the data that must be included in the SOAP header; this data will be used by the web service for
authentication purposes.
Common.xsd
– Defines the common complex types used by the schema.
Each web service has the following schema structure:
{Service}.wsdl
- Web Service Description Language
{Service}Data.xsd
– Contains complex data type definitions for SOAP requests and/or responses.
{Service}Messages.sxd
- Defines the requests and responses available for that service
{Service}MessagesInfo.xsd
– Defines the response element types that will be received from the web
server.
The services included in the 4PSA VoipNow Core SOAP API are listed below:
Reseller - management of reseller accounts: account information, status, control panel access, permissions and limits
Client - management of client accounts: account information, status, control panel access, permissions and limits
Endpoints - management of endpoint accounts: account information, status, control panel access, permissions and limits, endpoint preferences
Charging - management of charging plans
Channel - management of channels (only SIP channel support on Add operations), outgoing routing rules, public phone numbers
PBX - query methods for user templates, time intervals, interface and phone languages, sounds and available upgrade components
SSO - query user SSO preferences, SSO access
Report - quick statistics on 4PSA VoipNow Core server