Page is loading ...
4600 Series IP Telephones
Application Programmer Interface
(API) Guide
Release 2.2 for 4610SW, 4620/4620SW,
4621SW, and 4622SW IP Telephones
Release 2.5 for the 4625SW IP Telephone
16-300256
Issue 1
April 2005
Copyright 2005, Avaya Inc.
All Rights Reserved
Notice
Every effort was made to ensure that the information in this document
was complete and accurate at the time of printing. However, information
is subject to change.
Trademarks
DEFINITY is a registered trademark of Avaya, Inc. MultiVantage is a
trademark of Avaya, Inc. HTTP Server functionality is provided by the
GoAhead WebServer 2.1, Copyright© 2004 GoAhead Software, Inc. All
rights reserved.
Disclaimer
Avaya is not responsible for any modifications, additions or deletions to
the original published version of this documentation unless such
modifications, additions or deletions were performed by Avaya. Customer
and/or End User agree to indemnify and hold harmless Avaya, Avaya's
agents, servants and employees against all claims, lawsuits, demands
and judgments arising out of, or in connection with, subsequent
modifications, additions or deletions to this documentation to the extent
made by the Customer or End User.
API Support
This support is limited to the API. We cannot provide assistance with
generic configuration, servers, other software, or network issues. See the
Application Support Forum for more information.
How to Get Help
For additional support telephone numbers, go to the Avaya support Web
site: http://www.avaya.com/support
. If you are:
• Within the United States, click the Escalation Contacts link
that is located under the Support Tools heading. Then click
the appropriate link for the type of support that you need.
• Outside the United States, click the Escalation Contacts link
that is located under the Support Tools heading. Then click
the International Services link that includes telephone
numbers for the international Centers of Excellence.
Providing Telecommunications Security
Telecommunications security (of voice, data, and/or video
communications) is the prevention of any type of intrusion to (that is,
either unauthorized or malicious access to or use of) your company's
telecommunications equipment by some party.
Your company's “telecommunications equipment” includes both this
Avaya product and any other voice/data/video equipment that could be
accessed via this Avaya product (that is, “networked equipment”).
An “outside party” is anyone who is not a corporate employee, agent,
subcontractor, or is not working on your company's behalf. Whereas, a
“malicious party” is anyone (including someone who may be otherwise
authorized) who accesses your telecommunications equipment with
either malicious or mischievous intent.
Such intrusions may be either to/through synchronous (time-multiplexed
and/or circuit-based) or asynchronous (character-, message-, or
packet-based) equipment or interfaces for reasons of:
• Utilization (of capabilities special to the accessed equipment)
• Theft (such as, of intellectual property, financial assets, or toll
facility access)
• Eavesdropping (privacy invasions to humans)
• Mischief (troubling, but apparently innocuous, tampering)
• Harm (such as harmful tampering, data loss or alteration,
regardless of motive or intent)
Be aware that there may be a risk of unauthorized intrusions associated
with your system and/or its networked equipment. Also realize that, if
such an intrusion should occur, it could result in a variety of losses to your
company (including but not limited to, human/data privacy, intellectual
property, material assets, financial resources, labor costs, and/or legal
costs).
Responsibility for Your Company’s Telecommunications Security
The final responsibility for securing both this system and its networked
equipment rests with you - Avaya’s customer system administrator, your
telecommunications peers, and your managers. Base the fulfillment of
your responsibility on acquired knowledge and resources from a variety
of sources including but not limited to:
• Installation documents
• System administration documents
• Security documents
• Hardware-/software-based security tools
• Shared information between you and your peers
• Telecommunications security experts
To prevent intrusions to your telecommunications equipment, you and
your peers should carefully program and configure:
• Your Avaya-provided telecommunications systems and their
interfaces
• Your Avaya-provided software applications, as well as their
underlying hardware/software platforms and interfaces
• Any other equipment networked to your Avaya products
TCP/IP Facilities
Customers may experience differences in product performance, reliability
and security depending upon network configurations/design and
topologies, even when the product performs as warranted.
To order copies of this and other documents:
Call: Avaya Publications Center
Voice 1.800.457.1235 or 1.207.866.6701
FAX 1.800.457.1764 or 1.207.626.7269
Write: Globalware Solutions
200 Ward Hill Avenue
Haverhill, MA 01835 USA
Attention: Avaya Account Management
E-mail:[email protected]
For the most current versions of documentation, go to the Avaya support
Web site: http://www.avaya.com/support
.
Issue 1 April 2005 3
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Intended Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Issue Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
How to Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Terms Used in This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Conventions Used in This Document . . . . . . . . . . . . . . . . . . . . . . . . 14
Symbolic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Typographic Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Online Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Avaya Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Other Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
IETF Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Chapter 1: IP Telephone Interfaces. . . . . . . . . . . . . . . . . . . . . 17
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Existing Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 2: Push Interface Overview . . . . . . . . . . . . . . . . . . . . 21
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Push Feature Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Push Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
The Push Flow Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
The Push/Pull Process – A Two-Step View . . . . . . . . . . . . . . . . . . . 23
Push operation (Step 1a and Step 1b) . . . . . . . . . . . . . . . . . . . . 23
Pull operation (Step 2a and Step 2b) . . . . . . . . . . . . . . . . . . . . . 23
Push Message Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Step 1 - XML File Push Message Sent . . . . . . . . . . . . . . . . . . . . 24
Step 2 – Push Agent Responds. . . . . . . . . . . . . . . . . . . . . . . . 24
Step 3 – XML Message Parsing . . . . . . . . . . . . . . . . . . . . . . . . 24
Step 4 – Request Launched. . . . . . . . . . . . . . . . . . . . . . . . . . 25
Step 5 – Push Content Server Responds . . . . . . . . . . . . . . . . . . 25
Step 6 – Message Sent to Telephone. . . . . . . . . . . . . . . . . . . . . 25
About the Push Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
HTTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Contents
Contents
4 4600 Series IP Telephones Application Programmer Interface (API) Guide
Push Agent - HTTP POST Address. . . . . . . . . . . . . . . . . . . . . . . . . . 27
Push Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 3: Creating Push Messages. . . . . . . . . . . . . . . . . . . . 29
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
The Display Push Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Web Browser Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Display Push Example 1: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Priorities and States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Pushable vs. Non-Pushable States. . . . . . . . . . . . . . . . . . . . . . 30
Successful Push Response. . . . . . . . . . . . . . . . . . . . . . . . . . 31
Normal Priority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Barge Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Display Push XML Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Display Push Message (PM). . . . . . . . . . . . . . . . . . . . . . . . . . 33
Using the <postfield> Tag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Display Push Example 2: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Push Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Push Content (PC). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
The Topline Push Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Text Message Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Topline Push Example 1: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Priorities and States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Pushable vs. Non-Pushable States. . . . . . . . . . . . . . . . . . . . . . 39
Successful Push Response. . . . . . . . . . . . . . . . . . . . . . . . . . 39
Normal Priority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Barge Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Topline Push XML Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Topline Push Message (PM). . . . . . . . . . . . . . . . . . . . . . . . . . 41
Using the <postfield> Tag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Topline Push Example 2: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Push Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Topline Push Content (PC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Using the <Response> tag . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Using the <Topline> tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
The Audio Push Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Audio Push Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Contents
Issue 1 April 2005 5
Audio Push Example: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Priorities and States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Pushable vs. Non-Pushable States. . . . . . . . . . . . . . . . . . . . . . 47
Successful Push Response. . . . . . . . . . . . . . . . . . . . . . . . . . 47
Normal Priority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Barge Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Audio Push XML Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Audio Push Message (PM) . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Using the <postfield> Tag. . . . . . . . . . . . . . . . . . . . . . . . . . . 49
RTP Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Push Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Audio Push Content (PC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
The Subscribe Push Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Subscribe Push Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Priorities and States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Successful Push Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Subscribe XML Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Subscribe Push Message (PM) . . . . . . . . . . . . . . . . . . . . . . . . 55
Using the <postfield> Tag. . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Push Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Subscribe Push Content (PC). . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using the <Response> Tag . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using the <Subscribe> Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Chapter 4: Push Administration . . . . . . . . . . . . . . . . . . . . . . 59
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Trusted Push Server List (TPSLIST) . . . . . . . . . . . . . . . . . . . . . . . . . 60
Validation Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Recommendations: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Subscriber Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Subscription List (SUBSCRIBELIST). . . . . . . . . . . . . . . . . . . . . . . . . 64
Subscription Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Retry Timer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Denial of Service Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Contents
6 4600 Series IP Telephones Application Programmer Interface (API) Guide
Chapter 5: Troubleshooting the Push Interface . . . . . . . . . . . . . . 67
Avaya HTTP Header Extensions (x-Push-Status Codes) . . . . . . . . . . . . . . 67
HTTP Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Chapter 6: About The Web Browser . . . . . . . . . . . . . . . . . . . . 71
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Physical Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Web Browser Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Icons for Navigation Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Multiple Paging Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Moving Up and Down a Card . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Truncation Rules and Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Truncating Lines and Words . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Enabling Text Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Text Entry Example: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Text Editing Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Input Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Character Set Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Web History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Display Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Call Interaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Requirements for Deck/Card Elements. . . . . . . . . . . . . . . . . . . . . . . . 85
Wireless Telephony Applications (WTA) . . . . . . . . . . . . . . . . . . . . . . . 86
Syntax Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Click to Dial Functionality. . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Add to Speed Dial Functionality . . . . . . . . . . . . . . . . . . . . . . . 92
Support for HTTP Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Page Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Error Tones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
HTTP Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
HTTP Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
User Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
User-Agent Header String (4610SW IP Telephones). . . . . . . . . . . . . 96
User-Agent Header String (4620/4620SW, 4621SW, 4622SW IP Telephones) 96
User-Agent Header String (4625SW IP Telephones). . . . . . . . . . . . . 97
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Summary Of WML Tags and Attributes . . . . . . . . . . . . . . . . . . . . . . . 99
Contents
Issue 1 April 2005 7
Chapter 7: Web Browser for 4610SW, 4620/4620SW, 4621SW, and 4622SW IP
Telephones . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
General Background. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
WML Tags and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
WML Document Skeleton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Text Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Text Formatting Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Anchor Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Image Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Event Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Task Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Input Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Variable Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Character Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Colors and Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Access Key Input Mode (AIM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Support for Access Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Example of Text Entry Using AIM: . . . . . . . . . . . . . . . . . . . . . . 121
AIM Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Terminating AIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Chapter 8: Web Applications . . . . . . . . . . . . . . . . . . . . . . . . 127
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Application Platform Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 129
Installing the Thin Client Directory on the Server . . . . . . . . . . . . . . . . . . 129
Pre-Installation Requirements (Apache/PHP) . . . . . . . . . . . . . . . . . . 129
Avaya-Provided Download Files . . . . . . . . . . . . . . . . . . . . . . . . . 129
Installing the Thin Client Directory . . . . . . . . . . . . . . . . . . . . . . . . 130
Web Application User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Generic User Interface Screen Characteristics . . . . . . . . . . . . . . . . . 133
Web Application Search Screen . . . . . . . . . . . . . . . . . . . . . . . . . 134
Web Application Successful Search Screen. . . . . . . . . . . . . . . . . . . 135
Web Application Detail Screen . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Web Application Directory Trouble Screen . . . . . . . . . . . . . . . . . . . 137
Directory Database Administration Interface . . . . . . . . . . . . . . . . . . . . 140
Configuring the General Directory Application Administration Screen . . . . 142
Configuring the Directory Application Search Administration Screen. . . . . 144
Contents
8 4600 Series IP Telephones Application Programmer Interface (API) Guide
Configuring the Directory Application Details Administration Screen. . . . . 146
Configuring the Directory Application Softkey Administration Screen . . . . 147
Chapter 9: Web Browser for the 4625SW IP Telephone. . . . . . . . . . 151
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
General Background. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
WML Tags and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
WML Document Skeleton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Text Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Text Formatting Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Anchor Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Image Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Event Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Task Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Input Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Variable Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Character Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Image Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
WBMP Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
JPEG Images. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Image Rendering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Scrolling Through Images. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Image Justification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Image Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Number of Images Supported. . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Support for Cascading Style Sheets . . . . . . . . . . . . . . . . . . . . . . . . . 175
Cascading Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
CSS2 Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
CSS Background Properties . . . . . . . . . . . . . . . . . . . . . . . . . 183
CSS Text Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Code Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Colors Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Colors and Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Issue 1 April 2005 9
About This Guide
About this Document
This document describes how to set up two optional Avaya application interfaces, the Web
browser and the Push interface. Both interfaces apply only to the following Avaya IP
Telephones:
● 4610SW
● 4620/4620SW
● 4621SW
● 4622SW
● 4625SW
This document applies to software Release 2.2 for the 4610SW, 4620/4620SW, 4621SW, and
4622SW IP Telephones, and to Release 2.5 for the 4625SW IP Telephone. This document
covers only the behavior of the IP telephones specified. The performance and behavior of the
application or application server(s) are not addressed.
Note:
Note: The 4625SW has a significantly different display than the other IP telephones,
and supports the display of both color and JPEG images. Differences between
the 4625SW and the other IP telephones are noted throughout this document.
Intended Audience
This document is intended for the application developers and System Administrators who
develop or implement Web- or Push-based applications for Avaya IP Telephones. Chapter
4: Push Administration is intended for System Administrators who need to enable the Push
interface and set up Subscription Server Addresses on the TFTP server.
!
CAUTION:
CAUTION: Avaya does not support many of the products mentioned in this document. Take
care to ensure that there is adequate technical support available for the TFTP,
DHCP, HTTP, LDAP, and Web servers. If the servers are not functioning correctly,
the Avaya IP Telephones might not operate correctly.
About This Guide
10 4600 Series IP Telephones Application Programmer Interface (API) Guide
Document Organization
This guide contains the following chapters:
Chapter 1: IP Telephone
Interfaces
Describes the available Avaya IP Telephone interfaces.
Chapter 2: Push Interface
Overview
Provides an overview of the Push technology. This chapter
describes the Push Message Flow process with diagrams,
and gives an overview of Push features as applicable to
4610SW, 4620/4620SW, 4621SW, 4622SW, and 4625SW
IP Telephones.
Chapter 3: Creating Push
Messages
Describes the message types that can be sent (pushed) to
an IP telephone in detail, and provides setup requirements
and examples.
Chapter 4: Push
Administration
Covers Push security features and recommendations, and
server setup.
Chapter 5: Troubleshooting
the Push Interface
Describes messages received during Push interface setup
or processing, and provides suggested resolutions.
Chapter 6: About The Web
Browser
Provides a general overview of the Web browser and
application setup.
Chapter 7: Web Browser for
4610SW, 4620/4620SW,
4621SW, and 4622SW IP
Telephones
Provides information about creating and customizing Web
sites for viewing on the 4610SW, 4620/4620SW, 4621SW,
and 4622SW IP Telephones. Also describes the current
capabilities and limitations of the Web browser.
Chapter 8: Web Applications
Provides information on administering an LDAP directory
for the 4610SW, 4620/4620SW, 4621SW, 4622SW, and
4625SW IP Telephones.
Chapter 9: Web Browser for
the 4625SW IP Telephone
Provides information about creating and customizing Web
sites for viewing on the 4625SW IP Telephone. Also
describes the current capabilities and limitations of the
Web browser.
Issue Date
Issue 1 April 2005 11
Issue Date
April, 2005 is the first issue of this document, which combines and replaces two
previously-issued documents:
● Avaya IP Telephones Web Browser API (Document Number 16-300313) and
● Avaya IP Telephones Push Interface API (Document Number 16-300314).
This issue also reflects updates for two 4600 IP Telephone Software Releases:
● Release 2.2 for the 4610SW, 4620/4620SW, 4621SW, and 4622SW IP Telephones, and
● Release 2.5 for the 4625SW IP Telephone.
How to Use This Document
This guide is organized to help you find topics in a logical manner. Read it from start to finish to
get a thorough understanding of the interfaces or use the Table of Contents or Index to locate
specific features.
Terms Used in This Document
Term Description
ACM
Avaya Communication Manager, previously known as MultiVantage. A member
of a family of Avaya PBX’s providing advanced call features. Avaya IP
Telephones register on or login to the ACM.
AIM
Access Key Input Mode. A new text entry mode that allows a user to access a
particular URL by selecting a single dialpad key.
Alerts
An optional notification such as a series of ring pings to alert the user to an
incoming Push Message.
Card
A WML card is similar to an HTML page, but WML delivers a set (deck) of
closely related cards. The complete WML page comprises a collection of
various cards, of which only one is visible on the browser at one time. As each
of the cards is labeled by a name and ID, they can be linked together without
difficulty. The WML card author determines the content of the card. The browser
determines how this card will be displayed (rendered).
1 of 4
About This Guide
12 4600 Series IP Telephones Application Programmer Interface (API) Guide
CAPP
Cross-APEX Process Platform, the set of development processes used by most
of the CES development organizations. CAPP is subject to ISO audits.
CDATA
Text, which can contain numeric or named character entities. CDATA, a DTD
data type, is used only in attribute values.
CSS2
Cascading Style Sheets Version 2.
Deck
A deck can be described as a stack of cards. When the browser downloads a
WML page, it really is downloading a deck of cards but only one card in the
deck is visible at a time.
DTD
Document Type Definition. The DTD defines the names and contents of all
elements that permissible on a WML page, the order in which the elements
must appear, the contents of all elements, attributes and default values.
Elements
Elements are the essential components that make up a single WML document.
FLOW
The flow type represents “card-level” information. In general, flow is used
anywhere general markup can be included.
Focus
A unique adaptation of WML is the idea of focusing on a particular line on the
screen. This is known as “focus.” Since the phone has no mouse to navigate
around the screen, the Feature buttons that are located on the left side of the
screen can be used to select a particular line on the display, or “to bring that line
into focus.” Focusing on a line is used to select a line for text entry or to select a
line that contains a link to another URL (card). Additionally, new titles can (not
always) be presented to the user on the Top Line as each line on the screen is
individually brought “into focus” (selected by pressing the Feature buttons).
Frame
The area in which the Web page is displayed.
Full-Width
Browser
The Full-Width browser has with 12 linkable buttons, 6 on each side and no
fixed navigation buttons.
href
The href attribute refers to either a relative or an absolute Uniform Resource
Locator.
HTML
Hyper Text Markup Language is a text-based way of describing data for
transmission over the Internet HTML is usually used with larger, color displays.
HTTP
Hyper Text Transfer Protocol, used to request and transmit pages on the World
Wide Web.
IP
Internet Protocol – a suite of information exchanged message sets widely used
for data transmission and increasingly used for the transmission of voice.
Link
The URI that is used to chain cards together.
mode
Push Priority type – normal or barge – to distinguish between emergency
messages and ideal messages.
NMTOKEN
A name token, containing any mixture of name characters, as defined by the
XML.
Term Description (continued)
2 of 4
Terms Used in This Document
Issue 1 April 2005 13
PBX
Private Branch Exchange – A generic name for a premise-based switch
supporting telephony features owned by an enterprise.
PCDATA
Parsed CDATA. Text that can contain numeric or named character entities. This
text can contain tags. PCDATA, a DTD data type, is used only in elements.
Push Agent or PA
The telephone software that is capable of receiving a Push Message from a
server (Push Initiator).
Push Initiator or
Push Server
A Web application that is capable of transmitting the Push Message to the Push
Agent.
Push Content (PC)
A valid XML or a WML file that contains a <Response> tag as the root or a
<WML> as the root. The file carries the actual information to be displayed or
streamed on to an IP telephone.
Push Message
(PM)
An XML message that contains a <Push> tag as the root. The Push Message
uses a <go> tag to specify a URI to which the Push Agent can launch a request
for Push Content.
Push State
When the telephone is in busy state such as an active phone call or user
entering information in the Speed Dial Application.
Registration
The registration is a scheme of allowing an Avaya IP Telephone to authenticate
itself with the Avaya Communication Manager. The Avaya Media Server switch
supports registering and authenticating Avaya IP Telephones using the
extension and password.
RTP Audio
An audio stream received from an application outside the context of a telephone
call. The audio Push Message can be accompanied with an optional notification
alert.
Standard Browser
The Standard Browser display has 6 linkable buttons on the left, plus 6 fixed
navigation buttons on the right. The 4625SW IP Telephone supports both the
Standard Browser and the Full-Width browser. Other IP telephones currently
support the Standard Browser only.
SUBSCRIBELIST
The subscription list for potential pushed content contains zero or more fully
qualified URLs, separated by commas without any intervening spaces, up to
255 ASCII characters, including commas. The default is “” (Null).
Subscription
Servers
A server or a database that stores the information for a Push-enabled IP
telephone such as IP Address, Extension, MAC Address, etc.
Topline
The topline is 18 pixels in height, including one black pixel at the bottom of the
area, extending across the width of the display. The other 17 pixels of height are
available for text, icons, etc.
TPSLIST
List of Trusted Push Servers, contains one or more domains and paths in DNS
format, separated by commas without any intervening spaces, up to 255 ASCII
characters, including commas. The default is “” (Null)
Trusted Push
Server (TPS)
Application Server with a URI that conforms to the security settings as
established by the TPSLIST parameter in the script file. The Trusted Push
Server and the Push Initiator can be the same entity.
Term Description (continued)
3 of 4
About This Guide
14 4600 Series IP Telephones Application Programmer Interface (API) Guide
Conventions Used in This Document
This guide uses the following textual, symbolic, and typographic conventions to help you
interpret information.
Type
Type specifies a tag or attribute.
User Agent
Software that interprets WML, WMLscript, WTAI and other forms of codes.
VDATA
A DTD data type representing a string that can contain variable references. This
type is only used in attribute values.
W3C
World Wide Web Consortium.
WAP
Wireless Application Protocol. An open global standard for wireless solutions
that includes WML.
WBMP
WBMP is a bitmap graphic format that is required for the integration of graphics
into WML pages.
WML
Wireless Markup Language is a subset of XML, used by Avaya IP Telephone’s
Web browser to communicate with WML Servers.
WML homedeck
The WML start page, derived from Homepage.
WML tags
WML cards/deck are composed of a number of elements. Each element begins
with a descriptive tag. Tags are indicated by a pair of angled brackets that start
with the < character and end with the > character. The first element inside the
angled brackets is the tag name.
WMLscript
A scripting language specifically designed for programming mobile devices. It is
based on ECMAScript, but has been optimized for low bandwidth
communication and limited processing power and memory.
WTA
Wireless Telephony Application(s). An extension of the WAE (Wireless
Application Environment) that provides a set of interfaces to a mobile device’s
telephony functionality.
WTAI
Wireless Telephony Application Interface is a set of interfaces that extend the
WAE (Wireless Application Environment) to include telephony applications.
x-Push-Status
The Push Agent HTTP extension header. This extension is used by the Push
Agent to send the Push Message status to the Push Initiator.
XML
eXtensible Markup Language. W3C's standard for Internet Markup Languages.
WML is one of these languages.
xml:lang
The xml:lang attribute specifies the natural or formal language of an element
or its attributes. This is a DTD term.
Term Description (continued)
4 of 4
Online Documentation
Issue 1 April 2005 15
Symbolic Conventions
Note:
Note: This symbol precedes additional information about a topic.
!
CAUTION:
CAUTION: This symbol is used to emphasize possible harm to software, possible loss of
data, or possible service interruptions.
Typographic Conventions
This guide uses the following typographic conventions:
Online Documentation
The online documentation for this guide and related Avaya documentation is located at the
following URL:
http://www.avaya.com/support
Document Underlined type indicates a section or sub-section in this document
containing additional information about a topic.
“Document” Italic type enclosed in quotes indicates a reference to specific
section or chapter of an external document.
italics Italic type indicates the result of an action you take or a system
response in step by step procedures.
Conference In step by step procedures, words shown in bold represent a single
telephone button that should be pressed/selected.
message Words printed in this type are messages, prompts, code excerpts,
code samples, and XML tags.
About This Guide
16 4600 Series IP Telephones Application Programmer Interface (API) Guide
Related Documentation
Avaya Documents
● 4600 Series IP Telephone LAN Administrator Guide (Document Number 555-233-507)
This guide provides a description of Voice over IP, describes how to administer DHCP and
TFTP servers, and how to set up Push parameters in the 46xxsettings.txt script file.
● 4600 Series IP Telephone WML Server Setup Guide (Document Number 16-300507)
This guide provides information on setting up a Web server.
Other Documents
● The Unicode Consortium, The Unicode Standard, Version 3.2, Addison Wesley, 2002
● Extensible Markup Language (XML) 1.0 (Second Edition), W3C Recommendation 6
October 2000.
IETF Documents
The following documents provide information relevant to IP telephony and are available for free
from the IETF Web site.
● IETF RFC 2616: http://www.ietf.org/rfc/rfc2616.txt?number=2616
● IETF 1945: http://www.ietf.org/rfc/rfc1945.txt?number=1945
Issue 1 April 2005 17
Chapter 1: IP Telephone Interfaces
Overview
Figure 1 shows a typical system-wide network diagram that includes Avaya IP Telephones,
Avaya Communication Manager Servers, and application servers. The application servers
include Push Servers, Subscription Servers, and a Web Application Server.
Figure 1: Typical System-Wide Network Topolgy
With this picture in the current context, enabling a Web server or an application server for a
particular enterprise is not an additional entity.
IP Telephone Interfaces
18 4600 Series IP Telephones Application Programmer Interface (API) Guide
Existing Interfaces
Avaya IP Telephones accept the interfaces shown in Figure 2.
Figure 2: Avaya IP Telephone Interfaces
Example:
ABC Company currently has an intranet Web server that serves the company’s intranet
sites and other employee information. ABC has just deployed a company-wide Avaya
IP Telephone system, which offers an optional Web browser application. To set up a
Web server for the Avaya IP Telephones, ABC just has to add two MIME types to their
existing intranet Web server. ABC does not require an additional server or entity to
enable Web functionality on Avaya 4600 Series IP Telephones. Additionally, the same
intranet server can be a Push Application server or a Trusted Push Server. Similarly, a
subscription server can also be resident on ABC’s existing intranet server.
Note:
Note: For more information on setting up MIME types or setting up a Web server,
see the WML Server Setup Guide (Document Number16-300507), available
for download at: http://www.avaya.com/support
.
Existing Interfaces
Issue 1 April 2005 19
TAPI:
This is a Telephony Application Programmer’s Interface. TAPI is primarily used for call
control applications such as NetMeeting or IP Softphone. This type of interface is not
covered in this guide. Push does not require this type of interface.
irDA:
This is an infrared interface. Users can dial telephone numbers using the IR port from other
IR devices such as PDAs. This type of interface is not covered in this guide. Push does not
require this type of interface.
Web:
This is a Web browser Interface. Users can navigate Web applications and retrieve
information about the company, news, or interactive applications such as a conference
room scheduler and Company Directory lookup. For detailed information about the Web
interface see:
● Chapter 6: About The Web Browser,
● Chapter 7: Web Browser for 4610SW, 4620/4620SW, 4621SW, and 4622SW IP
Telephones,
● Chapter 8: Web Applications, and
● Chapter 9: Web Browser for the 4625SW IP Telephone
Push:
This interface allows an application to spontaneously Push Message to an IP telephone’s
display without involving the user. See Chapter 2: Push Interface Overview
,
Chapter 3: Creating Push Messages
, Chapter 4: Push Administration, and
Chapter 5: Troubleshooting the Push Interface
for information about the Push interface.
IP Telephone Interfaces
20 4600 Series IP Telephones Application Programmer Interface (API) Guide
/
