- DevConnect eBook: Mastering Avaya one-X Deskphone Application Development
- Sample Applications & Tutorials
- 9600 Series H.323 Software Release 6.4
- 9600 Series H.323 Software Release 6.3
- 9600 Series H.323 Software Release 6.2
- 9600 Series SIP Software Release 6.4
- 9600 Series SIP Software Release 6.3
- 9600 Series SIP Software Release 6.2
- 9600 Series SIP Software Release 6.0
- 9600 Series H.323 Software Release 3.2
- 9600 Series H.323 Software Release 3.1
- 9600 Series SIP Software Release 2.6
- 9600 Series SIP Software Release 2.5
- UNIStim Software Release 5.5
- UNIStim Software Release 5.4
- 9600 Series SIP Software Release 6.5
- 9600 Series H.323 Software Release 6.6
- 9600 Series SIP Software Release 7.0
- 9600 Series SIP Software Release 7.1
- 9600 Series H.323 Software Release 6.7
- 9600 Series H.323 Software Release 6.8
- Development Tools & Configurations
- Compliance Testing
This document contains the Frequently Asked Questions on Avaya 4600 and 9600 Series IP Telephones.
Push API Issues
Can you give me a brief overview of what the Push API is?
Push is the ability of an external application to send content to the telephone using the HTTP protocol without the user requesting it. Content can be pushed to the phone as a text message, WML Web page, or an audio stream through the handset or speaker. The Web Browser interface requires users to "Pull" data from an application, such as when a user clicks a link to access information. By using the Push API, an application can spontaneously deliver information to the telephone without depending on user input. In addition, there is a Subscription Push type which causes the phone to re-subscribe with its Subscription Servers. The Subscription service allows external applications to dynamically become aware of the IP Telephones and build databases of users.
There are three types of Push Messages: Topline, Display and Audio. A Topline push sends a single line of text to the top line of the IP phone screen. A Display push send content such as WML pages, images, click-to-dial links, and forms. Any Web content supported by the browser can be pushed. The Audio push type sends one-way RTP audio streams.
All the Push types can be configured to have optional alerts sound upon their arrival. The Push API supports the notion of message priority.
The Push API employs standards based interfaces, including HTTP, XML, WML, and standard Web servers. There are no proprietary servers, languages or protocols used. This helps make the Push API easy to learn and support as no special skills are required.
A Push Message consists of a very simple XML message sent to the IP phone using an HTTP Post command.
The Push interface can be used to:
- Broadcast company news
- Send meeting reminders with click-to-dial conference bridge numbers
- Stream music, such as wake-up alarms in hotel rooms
- Stream audio announcements
- Send news information such as stock prices
- Broadcast weather alerts
- Build databases to target information to an individual or groups of phones
Can you show me what the XML for a Push Request looks like?
Here is the generic template for a Push Message:
<go href=http://trusted_push_server/filename.wml method="get|post">
>postfield name="name1" value="value1"/>
>postfield name="name2" value="value2"/>
The Push Message has atttributes for how many alert "pings" to sound, the priority and the type of Push. It contains a URL for the location of the actual Push Content, i.e., the information to display on the phone.
For example, to send a high priority Topline Push with 3 alerts to an IP phone, an application would send an HTTP Post request to the URL of the phone (http://<IP_Address_of_the_telephone>/forms/push) with the following XML message as the value of the HTTP POST pre-defined variable called "XMLData":
<go href=http://trusted_push_server/filename.wml method="get" />
Where the text to display is contained in the Push Content file, filename.wml on the server, trusted_push_server. The phone retrieves the Push Content for display.
Please see the "4600 Series IP Telephone Interfaces API Guide" or the "Avaya one-X Deskphone Edition for 9600 Series IP Telephones Application Programmer Interface (API) Guide" for a full description of the Push API.
What does a Push Content file look like?
For a Topline or Audio push, the Push Content file is a simple XML file.
For example, a Push Content file for a Topline Push is shown below.
Stock Alert: AV @ $15
Here is a generic example of the Push content for an Audio push type:
codec = "PCMU | PCMA"
For a Display type push, the Push Content is a WML file where the entire range of features of an IP Telephone's Web browser can be used.
Please see the "4600 Series IP Telephone Interfaces API Guide" or the "Avaya one-X Deskphone Edition for 9600 Series IP Telephones Application Programmer Interface (API) Guide" for a full description of the Push API
What is the Subscription Service and why is it important? What is the Subscription Push?
The Avaya 4600 Series and the Avaya 9600 Series IP telephones support a subscription service, whereby they provide a set of identifying values (such as IP address) to subscription servers. This allows intelligent applications to dynamically build a database of all IP telephones. The subscription occurs automatically when the IP phone registers with the media server (Avaya Communication Manager). The subscription Service makes the administration of IP phones and their associated applications much easier by automating the discovery process.
Once an application builds a database of information about all telephones in a network, it can target Push Content to specific phones or groups of phones.
The phone makes the following values known to the trusted subscription service server(s):
- IP Address of the Phone
- User's Extension
- MAC Address
- Set ID, a fixed eight-character model number
The IP Phone uses a standard HTTP GET Message to send its subscription values to a subscription server. The Subscription Message Syntax is as follows: