Polycom 3725-49106-001 Rev A manual

Polycom, Inc. 1

Web Application for Polycom® Phones

DEVELOPER GUIDE

UC Software 5.0.0 | September 2013 |3725-49106-001 Rev A

Contents

Main Contents Understanding Web Application Development on Polycom Phones ............. 12 2: Getting to Know the XML API Application Interface ........................................ 19 3: Page About This Guide This guide uses a number of conventions that help you to understand information and perform tasks. Icon Name Conventions Used in This Guide Typographic Conventions Writing Conventions Coding Conventions Whats in This Guide? Getting Started 1: Recommended Software Tools Getting Help and Support Resources Planning Your XML API Interface Requirements Strategies for Web Application Development Best Practices for Web Application Development Best Practices for Microbrowser Web Application Development Page Understanding Web Application 2: Development on Polycom Phones What is the Browser? What is the Microbrowser? Page What is XHTML? What Are the Differences Between the Microbrowser and Browser? Whats in the Software Development Kit? Launching the Polycom SDK Whats New in the Latest Polycom UC Software Updates? Support for the VVX 500 Business Media Phone Getting to Know the XML API 3: Application Interface Notes on API Security Using Telephone Integration URIs Page Page Using Push Requests HTTP URL Push Page HTML Data Push The following table describes the results of using a specific priority. For example, to push the display of an important message: Using Telephony Notification Events Page Viewing an Incoming Call Event Viewing an Outgoing Call Event The Offhook Event allows an application to see when a call is starting. Viewing an Offhook Event Viewing an Onhook Event Viewing a Phone Lock Event Viewing a Phone Unlock Event Viewing a Call State Change Event Viewing a Line Registration Event Viewing a Line Unregistration Event Viewing a User Login/Logout Event </UserLoginOutEvent> Using Phone State Polling Receiving Call Line Information Receiving Device Information The Device Information message is returned in the following format: The device information message contains the attributes listed in the following table. The Network Configuration message returns network information about the phone. Receiving Network Configuration The Network Configuration message is returned in the following format: The network configuration message contains the attributes listed in the following table. Page Writing Your Web Application 4: Developing Your Browser Application Supporting HTTP Launching the Browser from VVX Phones Navigating and Form Editing on the Main Browser Viewing the Idle Browser Using Browser JavaScript DOM Extensions PolySoftKey Page PolyUri Sample Browser Web Applications Developing Microbrowser-Specific Applications Supporting XHTML Elements Basic Tags <!DOCTYPE>  Link Tags <a> Input Tags <form> <input> Image Tags <img> Table Tags <table> An example for the <table> tag is shown next. <caption> <th> <tr> <td> <thead> <tbody> This tag defines table footer. <tfoot> The <tfoot> tag supports the attributes listed in the following table. Meta Information Tags The following META information tags are supported: <head>Defines information about the document <head> Audio Tags <audio> Ordered and Unordered List Tag <ol> <ul> Supporting HTTP Launching the Microbrowser from the Phone Navigating and Form Editing Behavior on the Main Browser Viewing the Idle Browser Sample Microbrowser Web Applications Static XHTML Application Dynamic XHTML Application Page XML API Application Page Page 2 Using the IDE of your choice, create a file called webcallback.aspx.cs. Page Page Using Configuration Parameters 5: Configuring Web Application Parameters Configuring Push Request Parameters Configuring Telephone Event Notification Parameters Configuring Phone State Polling Parameters Configuring Programmable Soft Keys The <softkey> tag supports the attributes listed in the following table. Page Sample Configuration Page apps.statePolling.responseMode is set to send the requested state polling information to Getting Help 6: Polycom and Partner Resources The Polycom Community Troubleshooting 7: Understanding Microbrowser Application Errors Page References 8: Additional Information Unsupported XHTML elements on the Microbrowser Page Page Page JavaScript Examples for the Browser Control of Soft Keys The following example shows how to control soft keys. Page Keypad Captures