DLS provides an API that can be used to perform certain tasks on the DLS without using the GUI. It is a WebService based API called DlsAPI. DlsAPI does not provide equal functionality as the DLS-GUI, but is evolving continuously (driven by various project and customer requests).
DLS V2 and later provides both DlsAPI v100 (as released with DLS V1) and new methods as part of DlsAPI v200.
While DlsAPI v100 methods support IP Phones only, DlsAPI v200 methods also support IP Clients and IP Gateways. The DlsAPI is deployed with the DLS installation unit, in the folder:
The folder contains:
- dlsapiv100.wsdl – the wsdl for the DlsAPI interfaces available in v100
- dlsapiv100.jar - the WSDL2JAVA result, especially the client stubs and the service locator. This can be used by JAVA clients as interface to the DlsAPI v100.
- dlsapiv200.wsdl – the wsdl for new DlsAPI interfaces available in v200
- dlsapiv200.jar - the WSDL2JAVA result, especially the client stubs and the service locator. This can be used by JAVA clients as interface to the DlsAPI v200.
- doc – subfolder with the DlsAPI interface description (Javadoc format)
On an installed and running DLS server (on Windows OS), the links to the WSDLs are:https://<server>:10444/DeploymentService/services/DlsAPIv100?wsdlhttps://<server>:10444/DeploymentService/services/DlsAPIv200?wsdl
The link to the online documentation of DlsAPI is:https://<server>:10443/DeploymentService/dlsapidoc/
The same links are also valid for DLS installed on OpenScape Voice/UC servers (Linux OS) - but using the default port for https (443).
As well as this Online documentation you can access from the DLS itself we have an overview document that gives you and introduction to the capabilities of the API: