Polycom, Inc. 3
Contents About This Guide ...................................................................................................... 5
Conventions Used in This Guide .................................................................................................... 5
Information Elements ....................................................................................................................... 5
Typographic Conventions ............................................................................................................... 6
Writing Conventions ......................................................................................................................... 6
Coding Conventions ......................................................................................................................... 7
What’s in This Guide? ...................................................................................................................... 7
Getting Started ...................................................................................................... 8 1:
Recommended Software Tools ....................................................................................................... 8
Getting Help and Support Resources ............................................................................................. 8
Planning Your XML API Interface Requirements .......................................................................... 8
Strategies for Web Application Development ............................................................................... 9
Best Practices for Web Application Development ........................................................................... 9
Best Practices for Microbrowser Web Application Development ................................................... 10
Understanding Web Application Development on Polycom Phones ............. 12 2:
What is the Browser? ..................................................................................................................... 13
What is the Microbrowser? ............................................................................................................ 14
What is XHTML? ............................................................................................................................. 16
What Are the Differences Between the Microbrowser and Browser? ....................................... 16
What’s in the Software Development Kit? ................................................................................... 16
Launching the Polycom SDK ......................................................................................................... 17
What’s New in the Latest Polycom UC Software Updates? ....................................................... 17
Getting to Know the XML API Application Interface ........................................ 19 3:
Using Telephone Integration URIs ................................................................................................ 19
Using Push Requests ..................................................................................................................... 22
HTTP URL Push ............................................................................................................................ 23
HTML Data Push ............................................................................................................................ 25
Using Telephony Notification Events ........................................................................................... 27
Viewing an Incoming Call Event .................................................................................................... 29
Viewing an Outgoing Call Event .................................................................................................... 30
Viewing an Offhook Event .............................................................................................................. 30
Viewing an Onhook Event .............................................................................................................. 31
Viewing a Phone Lock Event ......................................................................................................... 31
Viewing a Phone Unlock Event ...................................................................................................... 32
Viewing a Call State Change Event ............................................................................................... 32
Viewing a Line Registration Event ................................................................................................. 33
Viewing a Line Unregistration Event .............................................................................................. 33
Viewing a User Login/Logout Event ............................................................................................... 34
Using Phone State Polling ............................................................................................................. 34