OpenStage WPI

Overview
The OpenStage WPI (WorkPoint Interface) is an all-purpose provisioning interface for controlling and configuring OpenStage SIP Phones. The possibilities go beyond the scope of uploading configuration files to the phone, as the interface allows for interaction between the phone and a provisioning service. Thus, the communication is bidirectional: The provisioning service can change settings on the phone, or upload data, e.g. firmware, ring tones, or picture clips to the phone. The phone, in turn, communicates configuration changes that have been made via WBM or local menu to the provisioning service. Thus, it is possible to develop phone administration tools which are able to execute any administration task, and which are always informed about the current phone settings.

Data Format And Protocol
The OpenStage WPI is based on XML messages which are exchanged via HTTPS. Additionally, plain HTTP is used for interaction startup. To ensure the continuity of subsequent requests and responses, HTTP cookies are supported by OpenStage SIP phones.

Requirements / Recommendations

 * OpenStage SIP phone with appropriate firmware version.
 * Connection to an IP network.
 * FTP or HTTPS server for file and software deployment.
 * SIP server
 * (Recommended) DHCP server to communicate the IP address of the provisioning server to the phone.
 * (Recommended) Web browser to configure the application on the phone using the Web Based Management. Alternatively, the phone’s local menu can be used.

If a Firewall or NAT get in the Way
In case the phones and the provisioning service reside in different networks or subnets that are separated by a firewall and/or NAT, it may be impossible for the provisioning service to contact the phones. To enable a solution for this problem, the phone can be configured to periodically poll the provisioning service, or a special proxy, for new messages. Thus, provisioning service driven interactions are possible even when the provisioning service is located behind a fire-wall, or in a DMZ. For further information, please refer to the, Section 1.4.4.3, "Polling Request To Bridge A Firewall" and Section 3.1.2.2, "Provisioning Service Located Behind A Firewall".

Documentation
For a complete description of the OpenStage WPI, please refer to the.