Instruction/ maintenance manual of the product 3725-49106-001 Rev A Polycom
Go to page of 92
Polycom, Inc. 1 Web Application for Polycom ® Phones DEVELOPER GUIDE UC Software 5.0.0 | Se ptember 2013 | 3725 -49106- 001 Rev A.
Polycom, Inc. 2 Copyright ©2013, Polycom, Inc. All rights reserved. No part of this document may be reproduced, translated into another language or format, or transmitt ed in any form or by any means, electronic or mechanical, for any purpose, without the express written permis sion of Polycom, Inc.
Polycom, Inc. 3 Contents About This Guide ...................................................................................................... 5 Conventions Used in Thi s Guide ........................................................................
Polycom, Inc. 4 Receiving Call Line Information ..................................................................................................... 35 Receiving Device Informati on ....................................................................
Polycom, Inc. 5 About This Guide This guide uses a number of conventio ns that help you to understa nd information and perform tasks. Conventions Used in This Guide This user guide contains term s, graphical elements, and a few t ypographic conventions.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 6 Typographic Conventions A few typographic conventions, li sted next, are used i n this guide to distinguish types of in-tex t information.
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 appl ications.
Polycom, Inc. 8 Getting Started 1: Getting Started provides you with infor mation on helpful resources and r ecommended software t ools that can aid you in Web applicat ion development on Polycom ® p hones with the Polycom UC software.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 9 The XML API is designed to provide y ou with flexibility when develo ping Polycom phone appli cations while securely integrating i nto the phone’s capabilities and functions. The XML AP I features are supported by the Polycom browser and microbrowse r, except where noted.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 10 Positioning Soft Key s Use a hard key press simulation t o test your applicat ion, provided the phone supports this functio n. When working with simul ators, simulating key press es for call screen soft keys, such as EndCall and Tr ansfer call controls, are not r eliable.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 11 Minimizing Onscreen Information Make sure you do not include too much information at o ne time on the screen of the idle brow ser.
Polycom, Inc. 12 Understanding Web Application 2: Development on Polycom Phones Polycom has two types of bro wser environments for Polycom phones running Polycom UC software: browser and microbrowser .
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 w hich Polycom phones sup port a browser or a microb rowser, see What is the Browser ? and What is the Microbrowser?.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 14 The browser display is limited by the total display area available o n each Polycom phone mo del. If you are creating an application for a specific Polycom phone model, co nsider the display area as a factor in the design of your Web applicatio n.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 15 Dynamic XHTML These pages involve dynamic information updat es of XHTML pages by an application hosted on the Web server.
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 th at mirror or extend versions of the widely-used Hyp ertext Markup Language (H TML), the language used to write Web pages.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 17 The SDK installation file installs the follo wing components on your computer: Phone Simulators The SDK Quick Start Guide .
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 18 covers the range of functional impr ovements that were int roduced with the latest UC soft ware updates from 4.0.1 to 5.0.0. Note: Supporting Legacy Phone Models Certain phone models, or legacy phones, are not supported in the Polycom UC Software 4.
Polycom, Inc. 19 Getting to Know the XML API 3: Application Interface Th e XML API provides you with flexibility in developing application s on Polycom phones while you securely integrate into the phone’s capabilities and functions. The XML API features are su pporte d by the microbrowser and browser, except where noted.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 20 The following are ways to execute a n internal URI action: If the file sent to the phone contains only internal URI a ctions, which you can send as Data Push, ensure the file content ty pe is application/x - com - polycom - spipx .
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 21 Action Type Action Tel 23 Number;LineIndex;ext=<extension_no>;postd=<DTMF> The Tel URI initiates a new call to the specified number on the specified line. The line number is optional .
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 ig nored.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 23 HTTP URL Push The HTTP URL push ena bles an application to push a URL to a phone to open its microbrowser or browser, as for example, an HTML Web page. The U RL value sent within the pu sh request is relative to the URL configured by the apps.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 24 Phone State Priority Description Important The phone will display push request immediately. Normal The phone will display push request immediately. Non -Idle State Critical The phone will display push request immediately.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 25 HTML Data Push The data push enables you to send X HTML page content directly t o a phone without the over head of the phone having to fetch the XHTML.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 26 Phone State Priority Description High The phone will display push request immediately, but it will appear after critical push requests. The phone will check whether the last processed message is of the same or a higher priority.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 27 Using Telephony Notifi cation Events Telephony events allow application pro grams insight into how the phones op erate.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 28 Attribute Permitted Values CallingPartyNumber number The number displayed on the phone. If the line is registered and the call is initiated from that line , the registered line number of the calling party is shown.
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.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 30 The following example shows the t ransmitted data for a call between two registered lin es when the telephone notification URI is set and t he incoming call event is enab led to gather information: Table 18 : Incoming Call Event <IncomingCallEvent> <PhoneIP>172.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 31 Use the following format whe n viewing the offhook event: Table 20 Code Snippet for Offhook Event <OffHookEvent> <PhoneIP.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 32 Viewing a Phone Unlock Event The phone un lock event notifies the applicatio n when the phone is un locked.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 33 Viewing a Line Registration Event The Line Registration Event occur s when a phone registers a line to a call se rver. This event is useful for flagging when the phone is on and run ning on the network.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 34 Viewing a User Login/Logout Event The UserLogin/Logout Ev ent is used to detect when a profile is u sed to sign into or out of a phon e.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 35 Two HTTP transactions o ccur: The application sends an HTTP re quest to a particular han dler in the phone. The Phone posts the state , in XML format, to a preconfigured Web server.
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.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 37 The Device Information message is ret urned in the following form at: Table 30 : Device Information <DeviceInformation> <.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 38 The Network Configuration message is returned in the following format: Table 32 : Network Configuration <NetworkConfiguration&g.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 39 Attribute Permitted Values DNSServer2 IP address The configured IP address of DNS Server 2. For e xample ‘192.168.1.250’. VLANID Null, 0 to 4094 The p hone’s 802.1Q VLAN identifier.
Polycom, Inc. 40 Writing Your Web Application 4: This chapter provides you with information you need to know while writing your Web appli cation. The topics in this chapter inclu de: Developing Yo.
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 S SL v3.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 42 Figure 2: VVX 500 Main Browser Navigati ng and Form Editing on the Main Browser Navigation and Form Editin g is slightly different on each phone. The different keyboard key s and the presence or absence of a touch-screen display affects the Navig ation and Form Editing.
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 b rowser. When an input field is invoked , t he keyboard displays at the b ottom of the screen, and the input field is centered at the top of the screen.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 44 Figure 4: VVX 500 Idle Browser Using Browser JavaSc ript DOM Extensions The browser provides access to phone- specific Document Object Model ( DOM) JavaScript ext ensions. The DOM is created by the bro wser after parsing an XHTML f ile.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 45 PolySoftKey.setSoftkey Label(int, string) Sets the label of a gi ven custom soft key (0 to 3). PolySoftKey.hideToolbar() Enables the application to hide the soft key toolbar.
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.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 47 The PolyU ri custom DOM extension example is shown next. Ta ble 35 : PolyUri DOM Extension PolyUri.shownSig.connect(appShown); PolyUri.hiddenSig.connect(appHidden); function appShown(){ // Pushes a play request whenever the browser is shown PolyUri.
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 att ributes are described in Unsupported X HTML elements on the Microbrowser .
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 49 This tag does not support any attributes. Link Ta gs The following link tag is su pported: <a> — Defines an anchor <a> Use the <a> tag to define an anchor.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 50 Note: Nesting Forms Are Supported The microbrowser supports both the GET and POST methods for submitting forms. Nesting forms within tables is supported. However, nesting of one form tag within another is not supported and can lead to unexpected results.
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.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 52 You can scroll images up and do wn; however, images that are too wide will be truncated. Various platforms have diff ering limits due to memory . There are also differing pi xel limits for devices of differing pixel depth.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 53 Table Tags The following table tags are supporte d: <table> — Defines a table <caption> — Defines a table .
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 54 An example for the <table> tag is shown next. Table 44 : <table> Tag Example { <table align=”center” border=”1px” cellpadding=”1px” cellspacing=”1px” width=”100%” /> <caption> This element defines a tabl e caption.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 55 <th> This tag defines a table header cell in a table. The text within the <th> element usually renders in bol d. The bgcolor , height , width , and nowrap attributes of the <th> element are not supported in XHTML 1.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 56 Attribute Value(s) lang language_code Sets the language. For example, EN=English, DE=German. nowrap no wrap Whether to disable or enable automatic text wrapping in this cell. Deprecated.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 57 <td> This tag defines a cell in a table. The bgc olor , height , width , and nowrap attributes of the < td > element are not supported i n XHTML 1.0 Strict DTD. The <td> tag supports the attributes listed in the following table.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 58 Attribute Value(s) charoff pixels, % Specifies the alignment offset to the first character to align on. Used if align =char. class class_rule, style_rule The class of the element. dir ltr (left to right), rtl (right to left) Sets the text direction.
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 text.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 60 <head> The < head > element contains informati on about the document. The bro wser does not display the head information. The following tags can b e in the head section: <base> , <link> , <meta> , <script> , <style> , and <title> .
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.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 62 An example of an unordere d list is shown next. Table 55 : <ul> Tag Example <ul> <li><a href="target1&qu.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 63 Whenever there is an eve nt in the phone application that requi res your attention, the telephony application is brought to the foreg round automatically.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 64 Viewing the Idle Browser The idle display microbrowser is inde pendent of the main microbrowser b ut is capable of rendering the same content. The idle browser’s home page i s configured via the mb.
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 in advertently contain li ne breaks.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 66 To develop a dynami c XML application: 1 Use the following to create a addstock.xhtml example : Table 57 : Sample Code - addstock.
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.
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.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 69 To develop an XML API application: 1 Using your integrated development envi ronment (IDE) of choice, create a new file and name t his file webcallback.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 70 2 Using the IDE of your choice, create a file called webcallback.aspx.cs . Table 60 : webcallback.aspx.cs Example using System; using System.IO; using System.Text; using System.Data; using System.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 71 string result = ""; // Create the web request HttpWebRequest request = (HttpWebRequest)WebRequest.Create(strLoc); WebRequestState myRequestState = new WebRequestState(); myRequestState.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 72 } } public class WebRequestState { public String postData = null; public WebRequest request; public WebRequestState() { request = .
Polycom, Inc. 73 Using Configuration Parameters 5: This chapter shows you how to configure Polycom phones to run your newly-created Web applicatio n us ing the configuration file s that accompany the Polycom® UC software.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 74 Configuring Web Application Parameters Th e parameters shown in the followin g table control the home pag e, proxy, and size limits tha t are used by the microbrowser and brow ser when it is selected to provide s ervices.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 75 Configuring Push Request P arameters The < apps.push/> parameters are used to control pus h server controls. Requests sent to the phone’s push server must be in the f ormat of http://<Phone IP>/push .
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 76 Configuring Telephone Event Notification Parameters The < apps.telNotification/> parameter is used to contr ol telephone notification eve nts. The telephone event notificatio n parameters are listed in the followi ng table.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 77 Configuring Phone State Polling Paramet ers The < apps.statePolling/> parameter is used to control state polling events. The telephone state polling notification event parameter s are listed in the following table.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 78 The <softkey> tag supports the attributes listed in the following table. Table 65 : <softkey> Tag Attributes Attribute Permitted Values index Numeric, 1 to 8 Position of the soft key.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 79 Action Default Action Name Description Key:Handsfree Hands-free Enables use of speaker Key:Messages Messages Opens the Messages me.
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 n ot defined. Note: When the Back Soft Key Doesn’t Display W hen mb.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 81 mb.main.home is set to the URL used for the microb rowser or browser home page. For exa mple, http://10.11.32.128:8080/sampleapps/login . apps.push.alertSound is set to 1, so a sound is played w hen an alert is pushed.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 82 apps.telNotification.callStateChange is set to 1 to enable notifications for call state change events. apps.statePolling.URL is set to the location where requested state polling information should be sent.
Polycom, Inc. 83 Getting Help 6: This section provides a list of Polycom documents referred t o in this guide as well as partner r esources you can use.
Polycom, Inc. 84 Troubleshooting 7: The browsers that best match Polycom phone browsers are Chrome or S afari, as they are built on WebKi t as well. You can use Chrome or S afari to test rendering is sues on the computer before testing them on the phone’s browser.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 85 The following table describes po ssible solutions to brow ser application errors Table 70 : Troubleshooting Browser Application Errors Pushed message is not display ing in browser. Push message is displayed i n the browser based on the priority of the message.
Polycom, Inc. 86 References 8: This chapter provides you with a list of recommen ded references that can help y ou when writing your application. When writing your appli cation, refer to the followin g resources for additional hel p. You can locate Polycom's UC Softwa re 5.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 87 Tag Type Tag Description <big> — Defines big text. <strong> — Defines strong text. <small> — Defines small text. <sup> — Defines superscripted text. <sub> — Defines subscripted text.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 88 Tag Type Tag Description <link> — Defines a resource reference. Frame Tags <frame> — Defines a sub window (frame). <frameset> — Defines a set of frames. <noframes> — Def ines a noframe section.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 89 Tag Type Tag Description Image Tags <img>-Defines an image. The following attributes are not supported: alt, align, border, hspace, ismap, longdesc, usemap, vspace, id, class, title, style, xml:lang, and lang <map> — Defines an image map.
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 B rowser This section provides JavaScript examples that work in conjunction with t he browser on Polycom ® VVX ® 500 and 1500 phones.
Web Application for Polycom Phones UC Software 5.0.0 Polycom, Inc. 91 break; case 3: document.getElementById("eventStuff").innerHTML = "SK 4 was pressed"; break; } document.getElementById("eventValue").innerHTML = skEvent; } // hide the tool bar function hideSKs(){ PolySoftKey.
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> &.
An important point after buying a device Polycom 3725-49106-001 Rev A (or even before the purchase) is to read its user manual. We should do this for several simple reasons:
If you have not bought Polycom 3725-49106-001 Rev A yet, this is a good time to familiarize yourself with the basic data on the product. First of all view first pages of the manual, you can find above. You should find there the most important technical data Polycom 3725-49106-001 Rev A - thus you can check whether the hardware meets your expectations. When delving into next pages of the user manual, Polycom 3725-49106-001 Rev A you will learn all the available features of the product, as well as information on its operation. The information that you get Polycom 3725-49106-001 Rev A will certainly help you make a decision on the purchase.
If you already are a holder of Polycom 3725-49106-001 Rev A, but have not read the manual yet, you should do it for the reasons described above. You will learn then if you properly used the available features, and whether you have not made any mistakes, which can shorten the lifetime Polycom 3725-49106-001 Rev A.
However, one of the most important roles played by the user manual is to help in solving problems with Polycom 3725-49106-001 Rev A. Almost always you will find there Troubleshooting, which are the most frequently occurring failures and malfunctions of the device Polycom 3725-49106-001 Rev A along with tips on how to solve them. Even if you fail to solve the problem, the manual will show you a further procedure – contact to the customer service center or the nearest service center
