Page 1
WTAI (Click-to-dial and Add-to-Speed
Dial) Tags Sample Code
4600 Series IP Telephone
16-300554
Issue 2.5
April 2005
Page 2
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 can not provide assistance
with generic configuration, servers, other software, or network
issues. Please visit 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 Management link.
Then click the appropriate link for the type of support you need.
• Outside the United States, click the Escalation Management
link.
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
(timemultiplexed 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: totalware@gwsmail.com
For the most current versions of documentation, go to
the Avaya support Web site:
http://www.avaya.com/support
Page 3
Table of Contents
INTRODUCTION........................................................................................................4
DESCRIPTION ...................................................................................................................................4
SYNTAX IMPLEMENTATION .................................................................................6
CLICK-TO-DIAL FUNCTIONALITY ..................................................................................................6
Click-to-dial using <a> tag:............................................................................................................6
Click-to-dial using <anchor> tag: ...................................................................................................8
Click-to-dial using <onevent> tag:...................................................................................................9
Click-to-dial using <do> tag (softkey): ..........................................................................................10
ADD-TO-SPEED DIAL FUNCTIONALITY......................................................................................11
Add-to-speed dial using <a> tag: ..................................................................................................11
REFERENCES: .......................................................................................................... 13
WTAI Tags Sample Code Page 3 Avaya, Inc.
Page 4
Introduction
This document describes the Wireless Telephony Application Interface (WTAI) click-to-dial
and add-to-speed dial functionality and provides sample WML code to develop web pages
for the Avaya™ 4600 Series IP telephones.
Description
The WTAI provides the means to develop telephony applications, using a WTA user-agent
using appropriate (Avaya supported) function libraries.
Avaya’s 4600 Series IP Telephones supports Public WTAI function libraries starting with
click-to-dial functionality in software release 1.71 or higher. Add to phone book2 function is
supported in software release 1.8 or higher.
The WTAI URI scheme is as follows:
1
wtai://<library>/<function> (; <parameter>)* [! <result>]
Definition:
< > Denotes an enumerated operator
[ ] Denotes an optional section
| Denotes a pair of mutually exclusive options
( )* Repeat none or multiple items
*( ) Repeat one or multiple items
library Name that identifies type of library, WTA Public uses library “wp”
function
Function within a library, for example “mc” for function “make call”
in “wp” library
parameter
Zero or more parameters sent to a function, should be delimited by a
1
Click-to-dial: adapted from WAP (Wireless Application Protocol)
2
Add to Phone Book: adapted from WAP (Wireless Application Protocol)
WTAI Tags Sample Code Page 4 Avaya, Inc.
Page 5
semicolon “;”
result Start of result is denoted by “!”. optional
WTAI Tags Sample Code Page 5 Avaya, Inc.
Page 6
Syntax Implementation
Click-to-dial functionality
To enable the click-to-dial functionality, the following syntax should be used:
wtai://wp/mc;number
This code can be embedded into any valid WML tag that implements “href” or a hyperlink
such as <a> tag, <anchor>, <do>, <option>, or <onevent> tags by associating these tags
with a <go> tag.
Click-to-dial using <a> tag:
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN"
"http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="callid1" title="Click-to-Dial Demo">
<p>
Click on the link below to originate a call
<a href="wtai://wp/mc;5551212">Call 5551212</a>
</p>
</card>
</wml>
The above-generated code will be rendered as the following diagram:
TOP LINE
FB 1
FB 2
FB 3
FB 4
FB 5
FB 6
Web: Click-to-Dial Demo
Click on the link below to originate a call
Call 5551212
.
.
.
.
....
SK1 SK2 SK4SK3
PHONE/
EXIT
PAGE
LEFT
PAGE
RIGHT
OPTIONS
FB 7
FB 8
FB 9
FB 10
FB 11
FB 12
WTAI Tags Sample Code Page 6 Avaya, Inc.
Page 7
The above-generated code will show a hyperlink as
Avaya 4620 IP Telephone. A phone icon will precede this hyperlink indicating that it is a
“click-to-dial” number. When this link is selected on the phone, the phone will dial the string
“5551212” or any phone number followed by a semicolon in the WTAI code above.
Call 5551212 on the web screen of an
WTAI Tags Sample Code Page 7 Avaya, Inc.
Page 8
Click-to-dial using <anchor> tag:
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN"
"http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="callid2" title="Using anchor tag">
<p>
<p align=”center”>***Customer Service***</p>
Your order will ship in 3-5 days.
If you have any questions, then
<anchor>Call us
<go href="wtai://wp/mc;5551212"/>
</anchor>
</p>
</card>
</wml>
The above-generated code will be rendered as the following diagram:
The above-generated code will show a hyperlink as
Call Us on the web screen of an Avaya
4620 IP Telephone. When this link is selected on the phone, it will dial the string “5551212”
or a number followed by a semicolon in the WTAI code above.
WTAI Tags Sample Code Page 8 Avaya, Inc.
Page 9
Click-to-dial using <onevent> tag:
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN"
"http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="callid3" title="Incorrect Login">
<onevent type="ontimer">
<timer value="50"/>
<go href="wtai://wp/mc;+1888 555 1212"/>
</onevent>
<p>
You have exceeded number of tries.
A call will be automatically launched in 5 seconds.
</p>
</card>
</wml>
The above-generated code will be rendered as the following diagram:
TOP LINE
We b: Incorrect Login
You have exceeded number of
tries. A call will be automatically
launched in 5 seconds.
FB 7
FB 8
FB 9
FB 10
.
.
FB 11
FB 12
....
SK1 SK2 SK4SK3
PHONE/
EXIT
OPTIONS
The above-generated code will automatically dial the number “1888 555 1212” after 5
seconds, once the web page is loaded.
WTAI Tags Sample Code Page 9 Avaya, Inc.
Page 10
Click-to-dial using <do> tag (softkey):
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN"
"http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="callid4" title="Click-to-Dial Demo">
<p>
Please contact us for more information.
</p>
<do type=”accept” label=”Call Us” name=”dotag1”>
<go href="wtai://wp/mc;+18005552525"/>
</do>
</card>
</wml>
The above-generated code will be rendered as the following diagram:
TOP LINE
We b: Click-to-Dial Demo
Please contact us for more information.
FB 7
FB 8
.
.
.
Call Us .
PHONE/
EXIT
PAGE
LEFT
PAGE
RIGHT
OPTIONS
FB 9
FB 10
FB 11
FB 12
The above-generated code will be implemented as a softkey “Call Us” indicating that it is a
“click-to-dial” number when this link is selected on the phone, it will dial the string
“18005552525” or a number followed by a semicolon in the WTAI code above.
WTAI Tags Sample Code Page 10 Avaya, Inc.
Page 11
Add-to-Speed Dial functionality
Add-to-Speed dial is referred to as Add to Phone Book by WTA. When a user clicks on the
add-to-speed dial tag, the web will transfer the name and number to the speed dial
application of the Avaya 4600 Series IP Telephones, which will allow the user to edit and
save the entry to their speed dial list.
To enable the “add-to-speed dial” functionality, the following syntax should be used:
wtai://wp/ap;number;name
This code can be embedded into any valid WML tag that implements “href” or a hyperlink
such as <a> tag, <anchor>, <do>, <option>, or <onevent> tags by associating these tags
with a <go> tag.
Add-to-speed dial using <a> tag:
<?xml version="1.0"?>
<!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.3//EN"
"http://www.wapforum.org/DTD/wml13.dtd">
<wml>
<card id="addap1" title=”Add-to-speed dial Demo">
<p>
My number is:
<a href="wtai://wp/ap;5551212;My Company”>5551212</a>
</p>
</card>
</wml>
The above-generated code will be rendered as the following diagram:
WTAI Tags Sample Code Page 11 Avaya, Inc.
Page 12
TOP LINE
FB 1
FB 2
FB 3
FB 4
FB 5
FB 6
Web: Add-to-speed dial Demo
My number is:
5551212
.
.
.
.
....
SK1 SK2 SK4SK3
FB 7
FB 8
FB 9
FB 10
FB 11
FB 12
PHONE/
EXIT
PAGE
LEFT
PAGE
RIGHT
OPTIONS
The above-generated code will add the entry to the speed dial group with a name as “My
Company” on the speed dial screen of an Avaya 4600 Series IP Telephones. A save icon will
precede this hyperlink indicating that it is an “add-to-speed dial” number. When this link is
selected on the phone, the web will transfer the name and number, “My Company” and
“5551212”, to the speed dial application of the phone. The user can then edit and save the
entry to their speed dial list.
NOTE: A save icon is only generated when an <a> tag is used.
WTAI Tags Sample Code Page 12 Avaya, Inc.
Page 13
References:
Application Programmer Interface (API) Guide discusses all the WML 1.2 tags that are
supported as well as how they are rendered on the phone:
This document can be downloaded from the Avaya Support Website.
The above document(s) can be located by using the following navigation matrix on the
Avaya’s Support Site:
Home > Support > 4600 IP Telephones > Application Developer
Information
WTAI Tags Sample Code Page 13 Avaya, Inc.
Loading...