Page 3 - Contents
Polycom, Inc. 3 Contents About This Guide ...................................................................................................... 5 Conventions Used in This Guide .................................................................................................... 5 Information Element...
Page 5 - About This Guide; Conventions Used in This Guide
Polycom, Inc. 5 About This Guide This guide uses a number of conventions that help you to understand information and perform tasks. Conventions Used in This Guide This user guide contains terms, graphical elements, and a few typographic conventions. Familiarizing yourself with these terms, elements,...
Page 6 - Typographic Conventions; Writing Conventions
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 6 Typographic Conventions A few typographic conventions, listed next, are used in this guide to distinguish types of in-text information. Typographic Conventions Used in This Guide Convention Description Bold Highlights interface ite...
Page 7 - Coding Conventions; What’s in This Guide?
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 7 Coding Conventions Sample code is shown in this guide to assist you in writing your applications. All samples are presented in the following format. Table 1: Sample Code <html> <body> <br/> Click on the link to en...
Page 8 - Recommended Software Tools
Polycom, Inc. 8 Getting Started 1: Getting Started provides you with information on helpful resources and recommended software tools that can aid you in Web application development on Polycom ® phones with the Polycom UC software. This Web Application Developer’s Guide provides you with information ...
Page 9 - Strategies for Web Application Development; Best Practices for Web Application Development; Using the HTTP User Agent; Supporting Image Formats; Scaling Images
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 9 The XML API is designed to provide you with flexibility when developing Polycom phone applications while securely integrating into the phone’s capabilities and functions. The XML API features are supported by the Polycom browser an...
Page 12 - Understanding Web Application
Polycom, Inc. 12 Understanding Web Application 2:Development on Polycom Phones Polycom has two types of browser environments for Polycom phones running Polycom UC software: browser and microbrowser. Before you write your application, you need to explore both environments and choose the one that prov...
Page 13 - What is the Browser?
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 13 would on a computer, or a microbrowser that supports a limited set of XHTML tags and displays limited content. For a more information on which Polycom phones support a browser or a microbrowser, see What is the Browser ? and What ...
Page 14 - What is the Microbrowser?; Static XHTML
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 14 The browser display is limited by the total display area available on each Polycom phone model. If you are creating an application for a specific Polycom phone model, consider the display area as a factor in the design of your Web...
Page 15 - Dynamic XHTML; Applications
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 15 Dynamic XHTML These pages involve dynamic information updates of XHTML pages by an application hosted on the Web server. The application residing on the Web server retrieves information from an intranet or Internet data service ...
Page 16 - What’s in the Software Development Kit?
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 16 What is XHTML? XHTML, or eXtensible HyperText Markup Language, is a family of XML markup languages that mirror or extend versions of the widely-used Hypertext Markup Language (HTML), the language used to write Web pages. XHTML is ...
Page 17 - Launching the Polycom SDK; To work around this issue:
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 17 The SDK installation file installs the following components on your computer: Phone Simulators The SDK Quick Start Guide An Apache Tomcat Web Server The XML API Web Testing Tool Launching the Polycom SDK The Polycom SDK is...
Page 19 - Getting to Know the XML API; Notes on API Security; Authenticating remote control and monitoring; Using Telephone Integration URIs
Polycom, Inc. 19 Getting to Know the XML API 3:Application Interface The XML API provides you with flexibility in developing applications on Polycom phones while you securely integrate into the phone’s capabilities and functions. The XML API features are supported by the microbrowser and browser, ex...
Page 22 - Using Push Requests
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 22 If any invalid URI is present in a XHTML file, the execution of that URI is ignored. For example, Table 7 shows the code created for a link that behaves as if you pressed the Do Not Disturb key: Table 7: Sample Code - Simulate P...
Page 23 - HTTP URL Push
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 23 HTTP URL Push The HTTP URL push enables an application to push a URL to a phone to open its microbrowser or browser, as for example, an HTML Web page. The URL value sent within the push request is relative to the URL configured by...
Page 25 - HTML Data Push
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 25 HTML Data Push The data push enables you to send XHTML page content directly to a phone without the overhead of the phone having to fetch the XHTML. Use the following format when sending the HTML Data Push: <Data priority=”X” &...
Page 27 - Using Telephony Notification Events
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 27 Using Telephony Notification Events Telephony events allow application programs insight into how the phones operate. Using a combination of telephony events enables an application to detect the starting of the phones, the signing ...
Page 29 - Viewing an Incoming Call Event
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 29 Attribute Permitted Values State Outgoing call states: Dialtone, Setup, Ringback Incoming call states: Offering Outgoing/incoming call states: Connected, Hold, Held, Free, Disconnected Unknown call state: Ncas The call state. Line...
Page 30 - Viewing an Outgoing Call Event; Viewing an Offhook Event
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 30 The following example shows the transmitted data for a call between two registered lines when the telephone notification URI is set and the incoming call event is enabled to gather information: Table 18: Incoming Call Event <In...
Page 31 - Viewing an Onhook Event; Viewing a Phone Lock Event
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 31 Use the following format when viewing the offhook event: Table 20 Code Snippet for Offhook Event <OffHookEvent> <PhoneIP> </PhoneIP> <MACAddress> </MACAddress> <TimeStamp> </TimeStamp> <...
Page 32 - Viewing a Phone Unlock Event; Viewing a Call State Change Event
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 32 Viewing a Phone Unlock Event The phone unlock event notifies the application when the phone is unlocked. Instructions sent to the phone in a locked state are ignored. Use the following format when viewing the phone unlock event: T...
Page 33 - Viewing a Line Registration Event; Viewing a Line Unregistration Event
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 33 Viewing a Line Registration Event The Line Registration Event occurs when a phone registers a line to a call server. This event is useful for flagging when the phone is on and running on the network. Use the following format when ...
Page 34 - Viewing a User Login/Logout Event; Using Phone State Polling; Receiving Call Line Information
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 34 Viewing a User Login/Logout Event The UserLogin/Logout Event is used to detect when a profile is used to sign into or out of a phone. Use the following format when viewing the user login/logout event: Table 27: User Login/Logout E...
Page 36 - Receiving Device Information
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 36 Attribute Permitted Values LineDirNum phone number The phone number associated with the line. For example, ‘1234’. LineState Active, Inactive The line state. CallState Outgoing call states: Dialtone, Setup, Ringback Incoming call ...
Page 37 - Receiving Network Configuration
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 37 The Device Information message is returned in the following format: Table 30: Device Information <DeviceInformation> <MACAddress> </MACAddress> <PhoneDN> </PhoneDN> <AppLoadID> </AppLoadID>...
Page 40 - Writing Your Web Application; Developing Your Browser Application; Supporting HTTP; Cookies
Polycom, Inc. 40 Writing Your Web Application 4: This chapter provides you with information you need to know while writing your Web application. The topics in this chapter include: Developing Your Browser Application Developing Microbrowser-Specific Applications Web Info: Polycom Developer Commu...
Page 41 - Launching the Browser from VVX Phones
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 41 HTTPS by HTTP over TLS The browser supports the TLS protocol v1 only. It is not backward compatible with SSL v2 or SSL v3. Custom CA certificates Web Info: To View Trusted Certificate Authorities For more information on CA cer...
Page 42 - Navigating and Form Editing on the Main Browser
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 42 Figure 2: VVX 500 Main Browser Navigating and Form Editing on the Main Browser Navigation and Form Editing is slightly different on each phone. The different keyboard keys and the presence or absence of a touch-screen display affe...
Page 43 - Viewing the Idle Browser
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 43 Form editing in the browser behaves the same as any major Web browser. When an input field is invoked, the keyboard displays at the bottom of the screen, and the input field is centered at the top of the screen. The keyboard is re...
Page 44 - Using Browser JavaScript DOM Extensions; PolySoftKey
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 44 Figure 4: VVX 500 Idle Browser Using Browser JavaScript DOM Extensions The browser provides access to phone-specific Document Object Model (DOM) JavaScript extensions. The DOM is created by the browser after parsing an XHTML f ile...
Page 46 - PolyUri
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 46 // get the styled points of the SKs so app can add whatever object they // want to that area after calling hideToolBar() function getSKPoints(){ // Returns a JSON object with two properties, X & Y. To convert to // JS object y...
Page 47 - Sample Browser Web Applications; Developing Microbrowser-Specific Applications; Supporting XHTML Elements
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 47 The PolyUri custom DOM extension example is shown next. Table 35: PolyUri DOM Extension PolyUri.shownSig.connect(appShown); PolyUri.hiddenSig.connect(appHidden); function appShown(){ // Pushes a play request whenever the browser i...
Page 48 - Basic Tags; XHTML Strict
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 48 Table Tags Meta Information Tags Audio Tags Ordered and Unordered List Tags Unsupported elements and attributes are described in Unsupported XHTML elements on the Microbrowser . Basic Tags The following basic tags are supp...
Page 49 - Link Tags; Input Tags
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 49 This tag does not support any attributes. Link Tags The following link tag is supported: <a> —Defines an anchor <a> Use the <a> tag to define an anchor. An anchor can be used to create a link to another documen...
Page 51 - Image Tags
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 51 The <input> tag supports the attributes listed in the following table. Table 40: < input > Tag Attributes Attribute Value(s) checked 1 checked Indicates that the input element should be checked when it first loads. typ...
Page 53 - Table Tags
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 53 Table Tags The following table tags are supported: <table> —Defines a table <caption> —Defines a table caption <th> —Defines a table header <tr> —Defines a table row <td> —Defines a table ce...
Page 59 - Meta Information Tags
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 59 The <tfoot> tag supports the attributes listed in the following table. Table 51: < tfoot > Tag Attributes Attribute Value(s) align left, right, center, justify, char Specifies the horizontal alignment of cell content t...
Page 60 - Audio Tags
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 60 <head> The <head> element contains information about the document. The browser does not display the head information. The following tags can be in the head section: <base> , <link> , <meta> , <scri...
Page 61 - Ordered and Unordered List Tag
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 61 An example of the <audio> tag is shown next. Table 53: <audio> Tag Example <audio src="flute16Ksps.wav" description="This is a short description" buttons="Details Back" links="details.xht...
Page 62 - Launching the Microbrowser from the Phone
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 62 An example of an unordered list is shown next. Table 55: <ul> Tag Example <ul> <li><a href="target1">link 1</a></li> <li><a href="target2">link 2</a></li>...
Page 63 - Navigating and Form Editing Behavior on the Main Browser
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 63 Whenever there is an event in the phone application that requires your attention, the telephony application is brought to the foreground automatically. While you are viewing the microbrowser, if there is an event in the phone appl...
Page 64 - Sample Microbrowser Web Applications
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 64 Viewing the Idle Browser The idle display microbrowser is independent of the main microbrowser but is capable of rendering the same content. The idle browser’s home page is configured via the mb.idleDisplay.home configuration para...
Page 65 - To develop a static XML application:; Dynamic XHTML Application
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 65 Note: Careful When Copying Sample Code Be careful when copying the lines of code in the following tables because the lines may have wrapped over to the next line. If you cut and paste these lines, the code can inadvertently contai...
Page 66 - To develop a dynamic XML application:
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 66 To develop a dynamic XML application: 1 Use the following to create a addstock.xhtml example : Table 57: Sample Code - addstock.XHTML Example <html xmlns="http://www.w3.org/1999/xhtml"> <!- - HEADER START - -> ...
Page 67 - XML API Application
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 67 // DEFINE URL FROM WHERE CONTENT TO BE RETRIEVED String stockUrl = "http://ichart.yahoo.com/t?s="; // RETRIEVE THE STOCK SYMBOL FROM REQUEST String stockSymbol = "PLCM"; // DEFAULT TO PLCM if ( request.getParameter...
Page 68 - Select
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 68 A customer is browsing a company’s Web site on the internet. They come upon this web page, http://A_Web_Site/WebCallback.aspx , and enter their name and phone number as shown next. After the customer clicks Send Request, the p...
Page 69 - To develop an XML API application:
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 69 To develop an XML API application: 1 Using your integrated development environment (IDE) of choice, create a new file and name this file webcallback.aspx . Table 59: webcallback XHTML Example <%@ Page Language="C#" Auto...
Page 73 - Using Configuration Parameters
Polycom, Inc. 73 Using Configuration Parameters 5: This chapter shows you how to configure Polycom phones to run your newly-created Web application using the configuration files that accompany the Polycom® UC software. The configuration parameters dictate the behavior of the phone once it is running...
Page 74 - Configuring Web Application Parameters
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 74 Configuring Web Application Parameters The parameters shown in the following table control the home page, proxy, and size limits that are used by the microbrowser and browser when it is selected to provide services. Table 61: Micr...
Page 75 - Configuring Push Request Parameters
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 75 Configuring Push Request Parameters The <apps.push/> parameters are used to control push server controls. Requests sent to the phone’s push server must be in the format of http://<Phone IP>/push . The push control requ...
Page 77 - Configuring Phone State Polling Parameters
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 77 Configuring Phone State Polling Parameters The <apps.statePolling/> parameter is used to control state polling events. The telephone state polling notification event parameters are listed in the following table. Table 64: Te...
Page 80 - Sample Configuration
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 80 An index greater than eight is ignored. By default, a Back soft key is placed on the graphic display even if one is not defined. Note: When the Back Soft Key Doesn’t Display When mb.main.autoBackKey is set to 0, the Back soft ...
Page 81 - bob
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 81 mb.main.home is set to the URL used for the microbrowser or browser home page. For example, http://10.11.32.128:8080/sampleapps/login . apps.push.alertSound is set to 1, so a sound is played when an alert is pushed. apps.pus...
Page 83 - Getting Help; Polycom and Partner Resources; The Polycom Community
Polycom, Inc. 83 Getting Help 6: This section provides a list of Polycom documents referred to in this guide as well as partner resources you can use. If you are looking for help or technical support for your phones, the following types of documents are available on the Polycom Voice Support site: ...
Page 84 - Troubleshooting; Understanding Microbrowser Application Errors
Polycom, Inc. 84 Troubleshooting 7: The browsers that best match Polycom phone browsers are Chrome or Safari, as they are built on WebKit as well. You can use Chrome or Safari to test rendering issues on the computer before testing them on the phone’s browser. When debugging Web pages, the Inspect E...
Page 86 - Additional Information; Unsupported XHTML elements on the Microbrowser
Polycom, Inc. 86 References 8: This chapter provides you with a list of recommended references that can help you when writing your application. When writing your application, refer to the following resources for additional help. You can locate Polycom's UC Software 5.0.0 Administrators’ Guide on t...
Page 90 - JavaScript Examples for the Browser; Control of Soft Keys
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 90 Tag Type Tag Description <param> —Defines a parameter for an object JavaScript Examples for the Browser This section provides JavaScript examples that work in conjunction with the browser on Polycom ® VVX ® 500 and 1500 phon...
Page 92 - Keypad Captures
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 92 </div> <div id="eventText"> <p>Last Click: <b id='eventStuff'>0</b> </p> <p>Event Value: <b id='eventValue'>0</b> </p> </div> <div id="clickPos"&...
Polycom 1
Manual
Polycom HDX 9000
Manual
Polycom 3725-22724-003/A
Manual
Polycom VMC 1000
Manual
Polycom 7000E
Manual
Polycom 1725-22886-001/A
Manual
Polycom C8
Manual
Polycom VVX 300
Manual
Polycom SE-220
Manual
Polycom Vega Gateway
Manual
Polycom EX
Manual
Polycom SCJ408
Manual
Polycom KIRK ISDN NET5
Manual
Polycom 1725-36024-001
Manual
Polycom HA7500QT4
Manual
Polycom 623149UK
Manual
Polycom HDX
Manual
Polycom M2616
Manual
Polycom 1725-44328-001
Manual
Polycom QSXTM
Manual