Cisco Systems OL-20949-01 manual

Americas Hea dquarters Cisc o Syst ems , Inc . 170 West Ta sman Drive San Jos e, CA 95 134-1706 USA http://www.ci sco.com Tel: 408 526-4000 800 553- NETS (638 7) Fax: 408 527-0883 Cisco Unif ie d IP P hone S er vice s Application De v elopment Notes Suppor ting XML Applications R ele ase 7 .1(3 ) Text Pa rt Numbe r: OL -20949 -01[...]

THE SPECIFICATIONS AND INFORMATION REGARDI NG THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NO TICE. ALL STATEMENT S, INFORMATI ON, AND RE COMMENDATIONS IN T HIS MA NUAL ARE BELI EVED TO BE A CCURATE BUT ARE P RESENTED WI THOUT WARRANTY OF ANY KIND, E XPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR AP PLICATION OF ANY P[...]

iii Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 CONTENTS Preface vii Overvi ew vii Revisi on Hist ory vii Audienc e vii Cisco Dev elope r Support Progr am vii Organi zation viii Relat ed D ocum ent ation ix Obtain ing Docu mentati on and Sub mitting a Servic e Reque st i-ix Cisco Pr oduct Securit y Overview x Document[...]

Cont ent s iv Cisco Unified IP Phone Services Application Development No tes OL-20949-01 CiscoI PPhon eResponse 3-19 CiscoI PPhon eError 3-1 9 Custom Sof tkeys 3-19 XML C onside rat ions 3-20 Mandator y Escap e Sequences 3-21 XML En cod ing 3-21 Applic atio n Event Handl ers 3-22 CHAPTER 4 Componen t APIs 4-1 Applic atio n Managemen t API 4-1 RTP S[...]

Content s v Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Applic atio n Managemen t URIs 5-16 Init 5-16 Notify 5-16 Applic atio n 5-18 CHAPTER 6 HTTP R equests a nd Heade r Setti ngs 6-1 HTTP Cli ent Reques ts (HTT P GET) 6-1 HTTP Ser ver R equ ests ( HTT P PO ST) 6-1 HTTP Head er S ett ings 6-2 HTTP Refr esh Set ting 6[...]

Cont ent s vi Cisco Unified IP Phone Services Application Development No tes OL-20949-01 User S ervi ce Subs crip tion 9-4 CHAPTER 10 DeviceLi stX Repor t 10-1 Benefi ts 10-2 Restri ctions 10-2 Integr ation Co nside rations and Inter opera bilit y 10-2 Perfor mance an d Scalabi lity 10-2 Securi ty 10-3 Relat ed F eat ures and Tec hnol ogies 10-3 Su[...]

vii Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Preface Overview Use this document with Cisc o Unified Commun icati ons Manage r, Rele ase 7.1 (3) to develop and depl oy customized client ser vices f or the Cisco Unif ied IP Phones t hat su ppo rt C is co U nified Pho ne se rvic es. Because of the comp lexity of a Uni[...]

viii Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Preface formali zed process provi des access to CDN Engineers who ar e an extension of the produc t technology engine eri ng te am s. CDN En gine ers have access to t he re sou rces nece ssar y to pr ovide exper t supp ort i n a timely ma nner . The C isco Developer Net[...]

ix Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Pre face Obtaining Documentation and Submitting a Service Request Related Documentation For more inform at i on about Cisco Unified IP Phones or Cisc o Un ified Communica tions Mana ger , refer to the follo wing publications: Cisco Unified IP Phone 7900 Series These publi[...]

x Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Preface Obtainin g Docume ntation and Submitt ing a Servic e Request Cisco Product Security Overview This pr odu ct co ntai n s c rypt ogr aphi c fea ture s a nd is su bj ect t o Uni te d Sta tes an d loca l c ou ntry laws governing impor t , export , t ransf er and use . [...]

xi Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Pre face Obtaining Documentation and Submitting a Service Request T imesaver Means the descri bed ac tion sa ves t ime . Y ou can s a ve time b y pe rform ing th e actio n desc ribe d in the paragr aph. War ni n g Means reader be warned . In t his situation, you might per[...]

xii Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Preface Obtainin g Docume ntation and Submitt ing a Servic e Request[...]

CH A P T E R 1-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 1 Overview Y o u can use Cisco Unifi ed IP Phones to dep lo y cust omized clien t ser vices with w hich us ers ca n in teract via the keypad and display . Services deploy us ing the HTT P protocol fro m standa rd web servers. User s a cce ss th es e f e at u[...]

1-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Ch apter 1 Ov erv iew Figur e 1 -2 Gra phic Me nu on a Cisc o Unified IP Phone Sampl e Phone use rs ca n navigate a text m enu by usi ng the Navigation butt on fol lowed by the Sel ect softkey , or by using t he n ume ric keypad t o ent er a sel ect ion dire c tly . G ra[...]

1-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 1 Overview Note HTML Disclaimer : Phone se rvic e developers mu st ta ke int o con si der ation tha t th e p hone i s no t a web browser and c an not p arse HTM L. Alt hough c onte nt is de livered to th e pho ne thr oug h HT TP me ssage s by using a web serv e r[...]

1-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Ch apter 1 Ov erv iew[...]

CH A P T E R 2-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 2 New and Changed Information This ch apter gi ves details on the new and ch anged information in the XML service in terface for the lat est releases of Cisco Unif ied Communication Ma nager . New Information for Cisco Unified Communication s Manager 7.1(3) [...]

2-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 2 New and Changed Information New Inf ormati on for Cisc o Unifie d Commu nication s Mana ger 7.1( 3)[...]

CH A P T E R 3-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 3 CiscoIPPhone XML Objects The fo llowing section s describ e the genera l behavior an d use of XML obje cts: • Understandi n g Obje ct Behavior • XML Object Def initions • Custom Softkeys • XML Conside rat ions • Applica tion Eve nt Handle rs Unde[...]

3-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts Underst anding O bject Beh avio r Ta b l e 3-1 shows th e supported XML object s for this relea se. Ta b l e 3-1 XML Objec ts Suppo rt ed f or Release 7 .1(3) Cisco Unified IP Phone Servic es SDK Phone Mo del XML Obje ct 7905G 7906G[...]

3-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions XML Object Definitions The fol lo wing sectio ns pro vide def initions and descr iptions o f each Cisco IPPhone XML object : • CiscoIPPhoneM enu • CiscoIPPhoneT ext • CiscoIPPhoneIn put • CiscoIPPhoneD i[...]

3-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions When a m enu is loa ded, the p hone beha ve s the sam e as for bu ilt-in phone menus. The user na vigates through the list of menu i tems and eventually cho oses one by using ei ther the Select softkey or th[...]

3-5 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions CiscoIPPho neInpu t When a Cisco Unifie d IP Phone rece i ves an XML obje ct of type CiscoIPPhoneInput , it constructs an input f orm and displays it. T he user then enters data in to each input it em an d send [...]

3-6 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions During te xt entry , Cisco Unif ied IP Phones displa y softkeys to assist u sers with text entry . Users c an navigate betwee n fields with the verti cal scroll butto n that is used t o navigate menus, and s[...]

3-7 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions </DirectoryEntry> </CiscoIPPhoneDirectory> Note For the dire ctory listing, the Ci sco Unifi ed IP Phone di splays th e approp riate sof tke ys that ar e needed to dial the numbe rs that a re listed [...]

3-8 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions <Depth>Number of bits per pixel</Depth> <Data>Packed Pixel Data</Data> <SoftKeyItem> <Name>Name of the softkey</Name> <URL>URL of softkey</URL> <Posit[...]

3-9 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions Exam ple The fol lowing XML code d efines a CiscoIPPhoneImage obj ect that displays the seque nce of pixels shown in Figure 3- 3 as a graph ic posit ioned at th e center of the phone disp lay: <CiscoIPPhoneIm[...]

3-10 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions If the number of color s in the image is not reduced to match the phon e capabilities, the image will be dithere d by the phone and y ield le ss than de sirable results i n most ca ses. T o redu ce the n um[...]

3-11 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions CiscoIPPho neGraphicM enu Graphic m enus serv e the same purpose as te xt menu s: th e y allo w a user to select a URL fr om a list. Use graphic m enus in sit uations wh en the ite ms may n ot be easy to displa[...]

3-12 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions Figure 3-5 shows the dis pla y of the Cisc oIPPh oneGr aphi cFil eMenu. Figur e 3-5 CiscoIPPhoneG r aphicFil eMenu If the coordina tes that are supplied in <Tou chArea> tag exceed the di mension s of [...]

3-13 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions Icons in the CiscoI PPhoneMen u object have a maximum width of 16 pixels and a maximum he ight of 10 pixels. Figure 3-6 sh ows an IconMe nu on a Cisco Unif ied IP Phone. Figur e 3-6 IconMenu on a Cisco Unified [...]

3-14 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions CiscoIPPho neIcon FileMenu This icon menu is simi lar to CiscoIPPhon eMenu , but it uses colo r PNG icons rather than graysca le CIP icons. Us e icon me nus in si tua tio ns when you want to provi de add i [...]

3-15 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions The Sta tus o bject cann ot be close d or cleare d b y the use r (fo r ex ampl e, b y pr essin g Serv ices) becaus e the Statu s object is only pr esent on th e Call pla ne. In orde r to clear the ob ject , the[...]

3-16 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions The Appl icati on Status window contains three main areas: (see Figure 3-9 ): • Te x t A r e a • Ti m e r A r e a • Image A rea Figur e 3-9 Elements o f Applica tion Stat us Windo w Note Self-term ina[...]

3-17 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Object Definitions Note Th e Cisco I P Ph one mode ls 9 951 , 997 1, an d 896 1 d oes no t sup por t Ci scoI PPhoneSt atu s obj ect. See Ta b l e 3- 1 on pa ge 3-2 for informat ion on XML obj ects supp orted on various phone mode[...]

3-18 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Obj ect Definit ions Note that in st ead of us i ng t he <Da ta> tag to embed th e image d ata, this ob ject uses a <URL> tag to point to the PNG imag e file to be used fo r the graph ics area. CiscoIPPho neEx ecute[...]

3-19 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects Custom Softkeys <ExecuteItem Priority=”1” URL=”http://server/textmessage.xml”/> </CiscoIPPhoneExecute> CiscoIPPho neRes ponse The CiscoI PPhone Respons e object ite ms provide messages an d informa tion result ing[...]

3-20 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts XML Consi deration s Note Th e <UR LD own> tag can on ly contai n Intern al UR Is— it can not cont ain an H TTP URL . The “URL ” in the name “URL D own” does no t si gnif y th at an H TTP U RL ca n b e use d. Defini[...]

3-21 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects XML Consi derati ons Note A ll Cisco IPPho ne elem ent names an d attribute na mes ar e case sensitive. Mandatory Escap e Sequ ences By XM L con ven tion, t he XML parse r also requ ires th at you pro vide escape v alues for a fe w s[...]

3-22 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts Applic ation Eve nt Handl ers Application Eve nt Handlers The App lication Ma nager API (see “ Appli cation ” section on page 5-18 ) in clu d es an Ap pl i cat io n Managem ent Event Hand ler which is sup ported by any displ ay[...]

3-23 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPPhone XML O bjects Applicati on Event Ha ndlers Attribute Description appID Iden tifi es the applic ation to which this di splayable XSI o bject be longs. The for mat of the appID attr ib ute should be in th e forma t vendor/ product , s uch as Cisco/U[...]

3-24 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 3 Cis coIPP hone X ML Obje cts Applic ation Eve nt Handl ers Event H andler Schem a <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attr[...]

CH A P T E R 4-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 4 Component APIs In add ition to the primary p hone XSI A PI, two addi tional componen t APIs ar e a vailable: • Applicat ion Man agemen t API, page 4-1 • R TP Strea ming API, page 4-1 Application Mana gement API T o addr ess the l imited applic a tion m[...]

4-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapt er 4 Component APIs RTP Streaming API Interaction Rules with Legacy RTP U RI Streams The R TP Streaming API a llows a full -duplex stre am (mo de=send Receive) to be se tup as a sing le strea m request whic h simplif ies the usag e of the API. Howe ver , in s ome c[...]

4-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 4 Component APIs RTP Strea ming AP I <xs:complexType> <xs:all> <xs:element name="mediaStream"> <xs:complexType> <xs:attribute name="id" type="xs:string" use="required"/> </xs:complexType>[...]

4-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapt er 4 Component APIs RTP Streaming API </xs:element> <xs:element name="port" minOccurs="0"> <xs:simpleType> <xs:restriction base="xs:unsignedShort"> <xs:minInclusive value="20480"/> <xs:maxIncl[...]

4-5 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 4 Component APIs RTP Strea ming AP I Examples Star t Me dia • Request HTTP POST /C GI/E xecute <startMed ia> <mediaS tre am onS top ped= ”Notif y:h ttp:ser ver :80 :path/ page ” rec eiv eVol ume=”5 0”> < typ e>au dio</t ype > <[...]

4-6 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapt er 4 Component APIs RTP Streaming API Request object doe s not comply with th e API’ s XML schema all 400 (B adReq uest) Infalid XML <pars er er ror descript ion> Media can not be st arted be cause no DSP resources is av ailable to ha ndle the media startMe[...]

CH A P T E R 5-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 5 Internal URI Features Intern al uni form res ource ident ifiers (URIs) provide ac cess to embedd ed pho ne feat ures such as pl acin g calls, play ing audio f iles, and i n voking b uilt-in object features. These se ctions pr ovide details a bout the a vai[...]

5-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Device C ontro l URIs Device Control URIs These sect ions de scri be t he d evice cont rol URI s: • Key • Display Key The K e y URI allo ws a programmer to send an e vent that a ke y has been pre ssed. Th e system initiat es the e ven[...]

5-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Device Contro l URIs Ta b l e 5-2 lists the Ke y URIs and the phone models in which these are supported. Ta b l e 5-2 Ke y UR Is With Suppor ted Phone Models Key U RI s 7905G 7912G 7906G 7911G 7931G 7920G 7921G 7925G 7940G 796 0G 7941G/79[...]

5-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Device C ontro l URIs Unsupported Key URIs and Alternate Options This se ction de scribes t he unsup ported Ke y URIs in the ph one m odels and provides a lternative options, if any , for the un supporte d URIs. Key:Fi xedFeature 1 Ye s Y[...]

5-5 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Device Contro l URIs Display The Display URI is a va ilable only on those Cisco Unif ied IP Phones that have a color backlight on the phone disp lay , includi ng the Ci sco Un ified IP Phone 7 970G and 7 971G-GE. Using the Displ ay URI , [...]

5-6 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features XML Displ ayable O bject URI s XML Displayable Object URIs These sec tions de scri be t he X ML di splaya ble ob ject URI s: • SoftKe y • QueryS tringPa ram SoftKey Y o u can execute native softke y functiona lity when t he phone exec[...]

5-7 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures XML Displayable Object URIs The new generati on 8900 / 9900 ser ies IP phones have the following enha nceme nts to thei r display: • The positio ns of the sofke ys ha ve been chang ed. Movi ng from left to right, the Exit is the first s[...]

5-8 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features XML Displ ayable O bject URI s <Name>Delete</Name> <URL>http://server/delete.asp</URL> </SoftKeyItem> </CiscoIPPhoneMenu> Exam ple 5- 1 sho ws ho w to use the Qu eryStringP aram URI in a CiscoIPPh oneMe[...]

5-9 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Multimedia URIs Multimedia URIs These sectio ns describ e the multimedia URI s: • R TP Streaming • Play • Vi b r a t e RTP Stream ing Y ou can in voke R TP stream ing via URI s in servi ces. Y ou can instr uct the pho ne to transm i[...]

5-10 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Mult im edia URIs The user has no ex plicit mecha nism for terminatin g the Rx URI stream independen t of the call. Thus, i f the Rx stream is not terminat ed automatica lly , it w ould continu e to play . For e xample, a user is listeni[...]

5-11 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Multimedia URIs RTPTx Use the R T PTx URI to instruct the phone to transmit a Unicast R T P stream or to stop transmitting Unicast or Multicas t R TP streams. URI Formats RTPTx:i:p RTPTx:Stop Where i = th e IP Address to which an R TP st[...]

5-12 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Mult im edia URIs Play The Play URI downloads a n au dio file from th e TFTP ser ver and play s through t he phone spe aker . Thi s same mech anism also plays rin g files, an d the format of the f iles is the same. Y ou could use the Pla[...]

5-13 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Telephon y URIs URI Format Vibrate:vibrateDuration:silenceDuration:count Where vibrateDura tion = duration (in millisec onds) in which the vibrate state remains on. V alue must be an integer rangin g from 0-6 5536 mil liseconds . silence[...]

5-14 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Telephon y URIs useA ppUI = Specifie s whether or not this applic ation will be used as the use r interfa ce for this call. A v alue of true wi ll cause the applicati on to keep UI focus whe n the c all is ma de instead o f switchi ng to[...]

5-15 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Telephon y URIs Audible feedba ck to the user can b e enabl ed or di sabled and an option al appl ication I D ca n be spec ified to ensure that the DTMF digi ts will only be sent to the call whic h is associated with a specif ic applicat[...]

5-16 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Applicat ion Man agement URI s Application Mana gement URIs Thes e sections describ e the appl icatio n manage ment URIs: • In it • Notify • Application Init The Ini t URI allo ws an applic ation to initialize a fe ature or d ata w[...]

5-17 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Application Management URIs The Not ify URI is not mad e in the co ntext of an XSI a pplic ation session and does not c ontain any HTTP cookie or sessi on infor mation. Th us, the bac k-end applica tion canno t rely on HTTP cook ies or s[...]

5-18 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Applicat ion Man agement URI s HTTP POST /path/streamhandler?event=stopped HTTP/1.1 Accept: */* Authorization: Basic 8fh4hf7s7dhf Content-Type: application/x-www-form-urlencoded; charset=”UTF-8” Host: myserver:8080 Content-Length: 23[...]

5-19 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Internal URI Fea tures Application Management URIs This pre v ents open, b ut not acti v e, applica tions which are b uried on the applicatio n “stack” fr om closing the entire ap plicatio n conte xt which wou ld also clos e the acti ve applicati on, poten[...]

5-20 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 5 Intern al URI Features Applicat ion Man agement URI s • 0—Do immediately , e ve n if user is interac ting with the phone. This pr iority is un av ailable if t he Applic ation U RI is c onta ine d wit hin a n App lica tio n Ma nage ment Event Ha ndle r (se [...]

CH A P T E R 6-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 6 HTTP Requests and He ader Settings Cisco Unifie d IP Phones use HTTP to communicate to external application s. The phone firm ware includ es both an HTTP client for makin g reques ts, and an HTT P serv er for recei ving request s. This chapter describ es t[...]

6-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapte r 6 HTTP Re quests an d Header Setting s HTTP Header Se ttings The f orm that is po sted should ha ve a case- sensiti ve f orm f ield name called “XML” th at cont ains the desir ed XML obje ct. For any HTT P POST oper ation, the s erv er must pro vide basic HT[...]

6-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 6 HTTP Reques ts and Header Set tings HTTP Head er Setti ngs HTTP Refresh Setting The HTTP h eader s that ar e sen t with an y pa ge fr om an HTTP ser v er can include a Ref re s h s ett ing . This setting compr ises two paramete rs: a time in seconds and a URL. [...]

6-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapte r 6 HTTP Re quests an d Header Setting s HTTP Header Se ttings MIME Typ e and Other HT TP Head ers Although deliv ering pages with the proper MIME type and other fo rmatting items is not diff icult, it require s moderately in de pth kno wledge of you r web serve r[...]

6-5 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 6 HTTP Reques ts and Header Set tings HTTP Head er Setti ngs This fu nc tio nalit y allows you t o ma ke the co nte nt of a ny page tha t i s sen t to t he phone expir e. Wh en a user press es the Ex it soft key , the us er goes ba ck to th e l ast URL t hat did [...]

6-6 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapte r 6 HTTP Re quests an d Header Setting s HTTP Header Se ttings HTTP Encoding Header Setting The en coding he ader con trols langua ge and char acte r settings re late d to local izatio n. Accept-Language Cisco Unifie d IP Phones popul ate the Accept- Language HT T[...]

6-7 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 6 HTTP Reques ts and Header Set tings Identifying the Capabilities of IP Phone Clients If 'c harset' is n ot specif ied, the phones will use th e defa ult encodin g for the curr ently conf igure d user locale. So to avoid possibl e prob lems wh ere th e[...]

6-8 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapte r 6 HTTP Re quests an d Header Setting s Accept Header x-CiscoIPPh oneSDKVers ion This Cis co-prop rieta ry head er contai ns the ve rsion of the IP Phone Ser vices SDK that th e reques ting phone su ppor ts. Th e HTT P he ade r does n ot sp ec ify wh ich U RI s a[...]

6-9 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 6 HTTP Reques ts and Header Set tings Accessing IP Phone Information Accessing IP Ph one Informati on Cisco Unifie d IP Phones ha v e an embed de d web se rv er t o pro vide a pro gr am min g inte rf ace for e xternal applica tions an d a debugging and mana gemen[...]

6-10 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapte r 6 HTTP Re quests an d Header Setting s Access ing IP Phone Informa tion[...]

CH A P T E R 7-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 7 Troubleshooting Cisco Unified IP Phone Service Appli cations This chap ter cont ains the foll o wing secti o ns: • Troubleshooting Tips • X ML Parsing E rro rs • Er ror M essa ges Troubleshooting Tips The fo llowing tips apply to troubles hootin g Ci[...]

7-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 7 Troubleshooting Cisco Unified IP Phone Service Applications Error M essages – CiscoIPPhone Menu Obj ect—If the field <Name > is missi ng for a < MenuIt em> , the orig inal parser would stop rende ring fr om tha t <Me nuItem > onwards. T he[...]

CH A P T E R 8-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 8 Cisco IP Phone Services Software Development Kit (SDK) The C isco IP Phone Servi c es Softwa re Dev elop me nt Kit (SD K) conta ins everything that you requ ire to creat e XML ap plicati ons, includi ng nece ssary doc umenta tion an d sample appl icati ons[...]

8-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 8 Cisco IP Phone Services Software Developmen t Kit (SDK) SDK Componen ts • D evelopment T ools – Cip.8bi— Adobe Pho toshop plug-in tha t allows .cip extension s to be viewed and sav ed. – Cip2Gif.e xe—DOS-based program that con verts .cip f iles to .gi[...]

8-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Cha pter 8 Cis co IP Ph one Serv ice s So ftwa re De velo pm ent K it ( SDK) Sample Services Requirements – Speed Dials (JSP) – Group MWI (JSP) – AutoDialer (JSP) – PhotoDirectory (JSP) – Cal lerInf o (JSP) – PushAut henticat e (ASP) – ScreenShot (ASP) – [...]

8-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 8 Cisco IP Phone Services Software Developmen t Kit (SDK) Sample S ervices Requireme nts[...]

CH A P T E R 9-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 9 IP Phone Service Administration and Subscription Cisco Unifie d Communications Man ager admi nistra tors m aintai n the list of serv ices t o which users c an subscribe. Ad ministrators m ust use Cisco Unified Communications Ma nager A dministr ation to ad[...]

9-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 9 IP Phone Ser vice Admi nistratio n and Subsc ripti on Adding a P hone Service Exam ple http:// < servername > /ccmuser/sample/sample.asp Wher e < s ervern ame > designates a fully qualif ied domain name or an IP address. Adding a Phone Service T o a[...]

9-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 9 IP Phone Servi ce Admini stration and Subscription Defining IP Phone Service Parameters Defining IP Ph one Service Para meters Each se rvice c an hav e a list of para meters. Y ou can use thes e paramet ers, whic h are ap pended t o the URL when the y are s e n[...]

9-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 9 IP Phone Ser vice Admi nistratio n and Subsc ripti on User Servic e Subscriptio n Ti p If you c hange the service UR L, remo v e a Cisco Unif ied IP Phone service p arameter , or change the Parameter Na me of a ph one servi ce param eter f or a phone servic e t[...]

CH A P T E R 10-1 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 10 DeviceListX Report The DeviceL is tX Repo rt is no lo n ger sup ported a s of Cisco Unified Communi c ation s Ma nager R elease 5.0. Retrie ving real-t ime informatio n from Cisco Unifie d C ommun ica tio ns Ma nage r is now suppor ted v ia the Cisco Uni[...]

10-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 10 DeviceL istX Report Bene fits • Device Po ol • IP Addre ss • Real-T ime Info rmat ion The complete d list of data gets formatted into a simple XML obje ct and gets returned in the HTT P Resp onse to the de ve loper . Benefits De viceListX prov ides acce[...]

10-3 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 1 0 DeviceListX Rep ort Security Security This report, which is within the Cisco Unif ied Communic ations Man ager Administra tion, inherits its security fro m that web site, so no security issues directl y relate to this report. If the Cisco Unifie d Comm unic [...]

10-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 10 DeviceL istX Report Troubles hooting D eviceL istX Re ports <?xml version="1.0" encoding="iso-8859-1"?> <DeviceList> <Device t="" n="" d="" c="" p="" i="" s="&[...]

10-5 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 1 0 DeviceListX Rep ort Troubl eshootin g DeviceList X Reports Error Message 1001 Too many simultaneous requests f or Device List. Please wait at least 60 seconds and try again. Explanati on When two or more client s attempt to get the list at the same time, or [...]

10-6 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Chapter 10 DeviceL istX Report Troubles hooting D eviceL istX Re ports[...]

A- 1 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 APPENDIX A CiscoIPPhone XML Object Quick Reference Ta b l e A-1 provid es a qu ick re fer en ce o f th e Cisc oIPPho ne X M L obj ec ts a nd the de finition s th at ar e ass oc iat ed w it h ea ch . Ta b l e A -1 CiscoIPPhone XML Object Quic k Ref erence Object Definiti[...]

A- 2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appendix A Cisco IPPho ne XML Object Qu ick Refe rence CiscoIPPhoneImage <CiscoIPPhoneImage> <Title>Image title goes here</Title> <Prompt>Prompt text goes here</Prompt> <LocationX>Position information of graphic</LocationX> <[...]

A-3 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix A CiscoIPPhone XM L Object Quick Refe rence CiscoIPPhoneIconMenu <CiscoIPPhoneIconMenu> <Title>Title text goes here</Title> <Prompt>Prompt text goes here</Prompt> <MenuItem> <IconIndex>Indicates what IconItem to display[...]

A- 4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appendix A Cisco IPPho ne XML Object Qu ick Refe rence[...]

B-1 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 APPENDIX B Cisco Unified IP Phone Services XML Schema File These sec tions provide detai ls about th e XML schem a supported on Ci sco Unified IP Phones: • U pda ted X ML Pars er a nd Sch em a E nfo rc em ent • Ci scoIPPhone .xsd Updated XML Parser and Schema Enforce[...]

B-2 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd CiscoIPPhone.xsd <?xml version="1.0" encoding="UTF-8"?> <!-- edited with XML Spy v4.4 U (http://www.xmlspy.com) by Cisco Systems, Inc. (Cisco Systems, Inc.) -[...]

B-3 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix B Cisco Unified IP Phon e Services XML Schema File CiscoIP Phone.xsd </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneTouchAreaType"> <xsd:attribute name="X1" type="xsd:unsignedShort" use=&[...]

B-4 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd <xsd:enumeration value="PE"/> <xsd:enumeration value="PU"/> <xsd:enumeration value="PL"/> </xsd:restriction> </xsd:simpleType> [...]

B-5 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix B Cisco Unified IP Phon e Services XML Schema File CiscoIP Phone.xsd <xsd:simpleType> <xsd:restriction base="xsd:hexBinary"> <xsd:maxLength value="40"/> <xsd:minLength value="0"/> </xsd:restriction> &l[...]

B-6 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd <xsd:enumeration value="KeyPad2"/> <xsd:enumeration value="KeyPad3"/> <xsd:enumeration value="KeyPad4"/> <xsd:enumeration value="Ke[...]

B-7 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix B Cisco Unified IP Phon e Services XML Schema File CiscoIP Phone.xsd <xsd:element name="URLDown" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <x[...]

B-8 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd </xsd:simpleType> </xsd:attribute> <xsd:attribute name="onAppMinimized" use="optional"> <xsd:simpleType> <xsd:restriction base="xsd:str[...]

B-9 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix B Cisco Unified IP Phon e Services XML Schema File CiscoIP Phone.xsd <xsd:restriction base="xsd:string"> <xsd:minLength value="1"/> <xsd:maxLength value="256"/> </xsd:restriction> </xsd:simpleType> <[...]

B-10 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="1"/> <xsd:maxInclusive value="2"/> </xsd:restriction> </xsd:s[...]

B-11 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix B Cisco Unified IP Phon e Services XML Schema File CiscoIP Phone.xsd </xsd:element> <xsd:element name="CiscoIPPhoneIconMenu"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="CiscoIPPhoneDisplayableType"[...]

B-12 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Depth"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort&q[...]

B-13 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 Append ix B Cisco Unified IP Phon e Services XML Schema File CiscoIP Phone.xsd <xsd:sequence> <xsd:element name="Text" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="[...]

B-14 Cisco Unified IP Phone Services Application Development No tes OL-20949-01 Appe ndix B Cisco Un ified I P P hon e Se rvic es XML Sc hema File CiscoIPPhone.xsd </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="CiscoIPPhoneStatusFile"> <xsd:complexType> <xsd:sequence> <xsd:eleme[...]

IN-1 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 INDEX Symbols << softke y 5-6 Numerics 8961 Col or dept h 3-10 Resolution 3-10 URIs supporte d 5-1, 5-3 XML Object s supported 2-1, 3-2 9951 Col or dept h 3-10 Reolution 3-10 URIs supporte d 5-1, 5-3 XML Object s supported 2-1, 3-2 9971 Col or dept h 3-10 Resoluti[...]

Index IN-2 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 client request s, using HTT P 6-1 content expiratio n, header setting 6-4 coo kie be havi or 6-5 D developm ent tools, included with SDK 8-2 Devi ce control UR I Display 5-5 Key 5-2 DeviceInf orma tion 6-9 device in format ion URLs 6- 9 DeviceL ist XML Object attr[...]

Inde x IN-3 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 I icon menus, crea ting colo r 3-14 graysc ale 3-12 Init, us ed as URI 5-16 input fo rms crea ting 3-5 supported i nput types 3- 6 M menus graphi c 3-11 icon, color 3-14 icon, grayscale 3-12 text 3-3 MIME ty pe, for HTTP 6- 4 N Networ kConfigu ration 6-9 Next so [...]

Index IN-4 Cisco Unified IP Phone Services Application Develo pment Notes OL-20949-01 tips 7-1 XML pa rsing errors 7-1 U uniform resour ce identifiers (URI) descript ion 5-1 miscella neous Dial 5-13 Edit Dia l 5-14 Init 5-16 Play 5-12 to cont rol RTP streaming 5-9 RTPMTx 5-11 Update softk ey 5-6 URI. See unif orm resource identifiers X x-Ci sc oIPP[...]