Phone Guide

Cisco IP Phone Expansion Module 7914
INCLUDING LICENSE AND WARRANTY
9 Introducing the Cisco IP Phone Expansion Module 7914 Installing the Expansion Module 7914 Features of the Expansion Module 7914 Using the Expansion Module 7914 Troubleshooting the Expansion Module 7914 Technical Specifications for the Expansion Module 7914 Where to Find More Information Cisco Product Security Overview Obtaining Technical Assistance
10 Cisco One-Year Limited Hardware Warranty Terms
1 Introducing the Cisco IP Phone

Expansion Module 7914

The Cisco IP Phone Expansion Module 7914 attaches to your Cisco IP Phone, adding 14 extra line appearances or programmable buttons to your phone. Attaching a second Expansion Module to your Cisco IP Phone adds a total of 28 extra line appearances or programmable buttons to your phone. The programmable buttons can be configured for speed dial numbers or to access phone services. For the latest information about supported phone models, contact your system administrator.
Cisco IP Phone 7960G with 2 Expansion Modules

Figure 1

Before You Begin
Before you begin installing your Expansion Module 7914, read each of these sections: Package Contents, page 3 Footstand Kits, page 3

120043

Additional Equipment, page 3 Safety Information, page 4

Package Contents

Make sure that your package includes the following items: One Cisco IP Phone Expansion Module 7914 One interface cable This Cisco IP Phone Expansion Module 7914 Phone Guide

Footstand Kits

In addition to the items in the package, you also need a Footstand Kit (separate orderable item). If you are attaching one Expansion Module 7914, you need the single Footstand Kit. If you are attaching two Expansion Module 7914s, you need the double Footstand Kit. The Footstand Kit contains: One support bar (single with one thumbscrew, or double with two thumbscrews) One footstand

Additional Equipment

You also need the following equipment. Small flat head screwdriverfor use during the installation Power supply unitdepending on how many Expansion Modules you are installing and how your Cisco IP Phone is powered, you will require power supply unit(s) as follows:
Power over the Ethernet to your Cisco IP Phone
With one or two Expansion Modules, you need a power supply unit (separate orderable item).
Power supply to your Cisco IP Phone
With one Expansion Module, you do not need a power supply unit. With two Expansion Modules, you need a power supply unit (separate orderable item).
Use of a non-Cisco certified power supply unit might not work and voids the Expansion Module 7914 product warranty.

Safety Information

The following safety warnings are for the Expansion Module 7914. Read these notices before you install or use the Expansion Module 7914. For translated warnings, refer to the Regulatory Compliance and Safety Information for the Cisco IP Phone 7900 Series.

Installing and Using Your Expansion Module 7914
Read the following safety notices before installing or using your Expansion Module 7914: Warning
IMPORTANT SAFETY INSTRUCTIONS This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device. SAVE THESE INSTRUCTIONS

Warning

Read the installation instructions before you connect the system to its power source.
Ultimate disposal of this product should be handled according to all national laws and regulations.
Do not work on the system or connect or disconnect cables during periods of lightning activity.
To avoid electric shock, do not connect safety extra low voltage (SELV) circuits to telephone network voltage (TNV) circuits. LAN ports contain SELV circuits, and WAN ports contain TNV circuits. Some LAN and WAN ports use RJ-45 connectors. Use caution when connecting cables.
Using an External Power Supply
The following warnings apply when you use the external power supply with the Expansion Module 7914:
This product relies on the building's installation for short-circuit (over current) protection. Ensure that a fuse or circuit breaker no larger than 120 VAC, 15A U.S. (240 VAC, 10A international) is used on the phase conductors (all current-carrying conductors).
The device is designed to work with TN power systems.
The plug-socket combination must be accessible at all times because it serves as the main disconnecting device.
The power supply must be placed indoors.

Caution

Only use the specified Cisco-approved power supply on this product.
2 Installing the Expansion Module
Note To ensure a successful installation of the Expansion Module 7914, make sure you have read the entire Before You Begin section on page 2.
To install the Expansion Module 7914, perform the following steps. 1. Remove the Footstand from the Cisco IP Phone. 2. Connect the Support Bar to the Cisco IP Phone. 3. Connect the Expansion Module 7914 to the Support Bar. 4. Connect the Interface Cable. 5. Connect the Power Supply. 6. Connect the Footstand. 7. Connect a Laptop Cable Lock (optional). Refer to the detailed instructions and corresponding illustrations that follow for each of these high-level steps. To ensure a successful installation, verify with your system administrator that your phone is ready for the Expansion Module 7914 and that Cisco CallManager is installed and configured for the Expansion Module 7914. Make sure that you have all of the parts that you need (see the Before You Begin section on page 2).

Remove the Footstand from the Cisco IP Phone
Refer to Figure 2 and the steps that follow.
Figure 2 Removing the Footstand
Step 1 Step 2 Step 3 Step 4
Unplug the Cisco IP Phone network and power connections. Unplug the handset, and unplug the headset if one is attached to the phone. Turn the Cisco IP Phone over and lay it on a protected flat surface to prevent it from being scratched. Locate the two foot pins on the footstand.

Step 5

Use a flat head screwdriver to carefully push on one of the foot pins to release it. Then carefully push on the other foot pin to release it. You may have to lift and hold the Cisco IP Phone to support it when pushing the foot pins. When pushing on the footpins, push away from your body.

Step 6

Lift off the footstand and store it separately.
Connect the Support Bar to the Cisco IP Phone
Refer to Figure 3 and the steps that follow.
Figure 3 Connecting the Support Bar

Step 1 Step 2 Step 3

Position the support bar on the back of the Cisco IP Phone so that it fits flush with the phone. Locate the two connector pins. Use a flat head screwdriver to carefully push each of the connector pins so that the support bar is firmly fastened to the Cisco IP Phone.

140969

Connect the Expansion Module 7914 to the Support Bar
Refer to Figure 4 and the steps that follow.
Figure 4 Connecting the Expansion Module
Open slots on the Expansion Module 7914 Hooks on the support bar Thumbscrews

Step 1 Step 2

Position the phone so that the front of the phone is facing up. Line up the two open slots on the bottom of the Expansion Module 7914 with the two hooks on the support bar. Insert the hooks into the slots and then rotate the top of the Expansion Module 7914 into the support bar so that it rests flush with the bar. Tighten the thumbscrew on the back of the Expansion Module 7914. If you are installing two Expansion Modules, repeat Steps 2, 3, and 4 for the second Expansion Module.

Step 3

Step 4
Connect the Interface Cable
Refer to the following table, which depicts the in and out icons on the AUX jacks, and to Figure 5 and the steps that follow.

In icon

Out icon
On your Cisco IP Phone or Expansion Module 7914, the AUX jack may be labelled RS-232. In this case read RS-232 jack for AUX jack in Figure 5 and Steps in this section.

Figure 5

Connecting the Interface Cable
Interface cable connection to the AUX jack on the Cisco IP Phone Interface cable connection to the AUX jack labeled with the in icon on Expansion Module 1 Second interface cable connection to the AUX jack labeled with the out icon on Expansion Module 1 Second interface cable connection to the AUX jack labeled with the in icon on Expansion Module 2

Plug one end of the interface cable into the jack labeled AUX on the Cisco IP Phone. Plug the other end of the interface cable into the AUX jack with the in icon underneath on the Expansion Module 7914. If you are installing a second Expansion Module 7914, continue with Steps 3 and 4. Otherwise go to the Connect the Power Supply section on page 12.

140966

140166
Plug one end of the second interface cable into the AUX jack with the out icon underneath on the first Expansion Module (the one closest to the phone). Plug the other end of the second interface cable into the AUX jack with the in icon underneath on the second Expansion Module (the one next to the first Expansion Module).

Connect the Power Supply

Refer to Figure 6 and the steps that follow.
Figure 6 Connecting the Power Supply
Power supply connector on the back of the Expansion Module

Step 1

Depending on how your Cisco IP Phone is powered with one or two Expansion Modules, perform one of the following actions to connect the power supply: Your Cisco IP Phone is powered over the Ethernet with one Expansion Module:
connect the power supply unit to the AC
adapter port on the Expansion Module and plug the other end into a standard electrical power outlet in the wall. If your Cisco IP Phone is powered over the Ethernet with two Expansion Modules:
adapter port on the Expansion Module closest to the Cisco IP Phone and plug the other end into a standard electrical power outlet in the wall. If your Cisco IP Phone is powered with a power supply unit with one Expansion Module:
reconnect the original Cisco IP Phone power
supply unit to the AC adapter port on the Cisco IP Phone and plug the other end into a standard electrical power outlet in the wall. If your Cisco IP Phone is powered with a power supply unit with two Expansion Modules:
connect a second power supply unit to the AC
adapter port on the Expansion Module closest to the Cisco IP Phone and plug the other end into a standard electrical power outlet in the wall. Step 2 Reconnect the Cisco IP Phone handset and network connection.

Connect the Footstand

Refer to Figure 7 and the steps that follow.
Figure 7 Connecting the Footstand
Slots on the support bar Hooks on the footstand

Locate the three hooks on the footstand. Position the hooks so that they align with the open slots on the support bar. There are four positions in each of the three sets of open slots on the support bar. This lets you choose the angle of the footstand.
Insert the footstand hooks into the support bar and push in slightly to make the connection.

140968

Connect a Laptop Cable Lock (optional)
Note Supported only on phones that have a security slot on the back of the phone. Contact your system administrator for more information.
Refer to Figure 8 and the steps that follow.
Figure 8 Connecting a Laptop Cable Lock
Detach the cable lock door from the support bar. Secure the security cable to a desktop. Insert the laptop cable lock into the security slot on the back of the phone, lock it, and remove the key.

140967

Start Up Sequence
After the Expansion Module 7914 is installed, upon startup the buttons all show a steady red light. Then the LCD screen refreshes and the buttons all go off and any line appearances are displayed in the LCD screen. You can then start using the Expansion Module.

3 Features of the

The Expansion Module 7914 includes the following features.
Phone screenDisplays the phone number, speed dial number (or name or other text label), phone service, or Privacy assigned to each button. Icons indicating line status appear similar to, and function the same as, those on the Cisco IP Phone to which it is attached.
Lighted Buttons14 buttons. Each button corresponds to one line (just like on the Cisco IP Phone). The lights beneath each button indicate the state of the corresponding line as follows: Line available: light off Line in use by you: steady green light Line in use by someone else: steady red light Line ringing: flashing amber light You have a call on hold: flashing green light Someone else has a call on hold: flashing red light Call transfer: steady green light
4 Using the Expansion Module 7914
The Expansion Module 7914 functions as a line appearance or programmable button module, allowing you to keep track of calls in progress, calls on hold, and calls requiring transfer, or to access phone services. All call functions, such as answering a call, placing a call on hold, transferring a call, and so on, are performed from the Cisco IP Phone. Refer to the phone guide for your Cisco IP Phone for instructions about using your phone. Here is a typical scenario when using the Cisco IP Phone and Expansion Module 7914 combination. You receive a call for your Director at extension 12345. You look at your Expansion Module 7914 and see that your Director has a call in progress with another party and also has another call on hold. Looking down the Expansion Module 7914 screen, you note that another manager in your group has just completed a call and could possibly assist the incoming caller. You consult briefly with the incoming caller and then transfer the call to the manager.

Keeping Your Call Information Private
If Privacy is programmed for one of your buttons, you can keep your call information private from users who share your lines. If you see a button labeled Privacy, then this feature has been enabled for you by your system administrator. You toggle privacy on and off by pressing the Privacy button when receiving an incoming call. In addition, with Privacy enabled, other shared lines are blocked from joining your calls. Refer to the phone guide for your Cisco IP Phone for more information.
Configuring the Buttons on Your Expansion Module 7914
Similar to your Cisco IP Phone, you can configure speed dial numbers or program buttons to access phone services on the Expansion Module 7914. Before you can do this, ask your system administrator for the following information to access your Cisco IP Phone User Options web page: the URL your user name and password After you have this information, you can configure your speed dial numbers or program buttons to access phone services. Phone services can include, for example, weather, stock quotes, or corporate calendars and directories. Refer to the phone guide for your Cisco IP Phone for more information.

Adjusting the Contrast

Similar to your Cisco IP Phone, you can adjust the contrast on the Expansion Module 7914. Refer to the phone guide for your Cisco IP Phone for more information.

5 Troubleshooting the

The following table might help you if you are having difficulty using your Expansion Module 7914.

Problem

No display on the Expansion Module 7914.

Solution

Verify that all of the cable connections are correct. Verify that you have power to the Expansion Module 7914(s).
Buttons on the first Expansion Module 7914 are all red. Buttons on the second Expansion Module 7914 are all amber.
Verify with your system administrator that your Expansion Module 7914 is defined in Cisco CallManager. Verify with your system administrator that your Expansion Module 7914 is defined in Cisco CallManager.
If you are experiencing other difficulties, contact your system administrator.
6 Technical Specifications for the
This section provides the physical and operating environment specifications for the Cisco IP Phone Expansion Module 7914, as well as the regulatory compliance information.
Physical and Operating Environment Specifications

Specification

Operating Temperature Operating relative humidity Storage temperature Height Width Depth Weight Power

Value or Range

32 to 104F (0 to 40C) 10 to 95% (noncondensing) 14 to 140F (-10 to 60C ) 203 mm, 8.0 in. 121 mm, 4.75 in. 51 mm, 2.0 in. 366 g, 0.82 lb. 48 VDC, 40mA max

Cable Specifications

2 RJ-11 jacks with 6-pin connectors for the interface cable connections 48-V power connector. The diameter of the center pin in the Expansion Module power jack (Switchcraft 712A) is 0.1 in. (2.5 mm). The center pin is positive (+) voltage. The miniature power plug required to mate with the power jack on the Expansion Module is a Switchcraft 760 or equivalent.
7 Where to Find More Information
The following sections provide sources for obtaining additional documentation from Cisco Systems.

Related Documentation

The following documents provide additional information. Cisco IP Phone Administration Guide for Cisco CallManagerProvides instructions for the system administrator about configuring the Expansion Module 7914 in Cisco CallManager. http://www.cisco.com/univercd/cc/td/doc/product/voice/ c_ipphon/index.htm Phone guide for your Cisco IP PhoneProvides instructions for using the Cisco IP Phone. http://www.cisco.com/univercd/cc/td/doc/product/voice/ c_ipphon/index.htm Cisco CallManager documentationProvides instructions for using the Cisco CallManager Administration application to configure Cisco IP Phones and services. http://www.cisco.com/univercd/cc/td/doc/product/voice/ c_callmg/index.htm

Obtaining Documentation

Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com

You can access the most current Cisco documentation at this URL: http://www.cisco.com/techsupport
You can access the Cisco website at this URL: http://www.cisco.com You can access international Cisco websites at this URL: http://www.cisco.com/public/countries_languages.shtml
Product Documentation DVD
Cisco documentation and additional literature are available in the Product Documentation DVD package, which may have shipped with your product. The Product Documentation DVD is updated regularly and may be more current than printed documentation. The Product Documentation DVD is a comprehensive library of technical product documentation on portable media. The DVD enables you to access multiple versions of hardware and software installation, configuration, and command guides for Cisco products and to view technical documentation in HTML. With the DVD, you have access to the same documentation that is found on the Cisco website without being connected to the Internet. Certain products also have.pdf versions of the documentation available. The Product Documentation DVD is available as a single unit or as a subscription. Registered Cisco.com users (Cisco direct customers) can order a Product Documentation DVD (product number DOC-DOCDVD=) from Cisco Marketplace at this URL: http://www.cisco.com/go/marketplace/

Ordering Documentation

Beginning June 30, 2005, registered Cisco.com users may order Cisco documentation at the Product Documentation Store in the Cisco Marketplace at this URL: http://www.cisco.com/go/marketplace/ Nonregistered Cisco.com users can order technical documentation from 8:00 a.m. to 5:00 p.m. (0800 to 1700) PDT by calling 463-3487 in the United States and Canada, or elsewhere by calling 519-5055. You can also order documentation by e-mail at
tech-doc-store-mkpl@external.cisco.com or by fax at 519-5001 in the United States and Canada, or elsewhere at 519-5001.

Documentation Feedback

You can rate and provide feedback about Cisco technical documents by completing the online feedback form that appears with the technical documents on Cisco.com. You can send comments about Cisco documentation to bug-doc@cisco.com. You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address: Cisco Systems Attn: Customer Document Ordering 170 West Tasman Drive San Jose, CA 95134-9883 We appreciate your comments.
Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online and printed sources. Cisco Marketplace provides a variety of Cisco books, reference guides, documentation, and logo merchandise. Visit Cisco Marketplace, the company store, at this URL: http://www.cisco.com/go/marketplace/ Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press at this URL: http://www.ciscopress.com
Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Each quarter, Packet delivers coverage of the latest industry trends, technology breakthroughs, and Cisco products and solutions, as well as network deployment and troubleshooting tips, configuration examples, customer case studies, certification and training information, and links to scores of in-depth online resources. You can access Packet magazine at this URL: http://www.cisco.com/packet iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies learn how they can use technology to increase revenue, streamline their business, and expand services. The publication identifies the challenges facing these companies and the technologies to help solve them, using real-world case studies and business strategies to help readers make sound technology investment decisions. You can access iQ Magazine at this URL: http://www.cisco.com/go/iqmagazine or view the digital edition at this URL: http://ciscoiq.texterity.com/ciscoiq/sample/ Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL: http://www.cisco.com/ipj Networking products offered by Cisco Systems, as well as customer support services, can be obtained at this URL: http://www.cisco.com/en/US/products/index.html

Networking Professionals Connection is an interactive website for networking professionals to share questions, suggestions, and information about networking products and technologies with Cisco experts and other networking professionals. Join a discussion at this URL: http://www.cisco.com/discuss/networking World-class networking training is available from Cisco. You can view current offerings at this URL: http://www.cisco.com/en/US/learning/index.html
8 Cisco Product Security Overview
Cisco provides a free online Security Vulnerability Policy portal at this URL: http://www.cisco.com/en/US/products/products_security_vulne rability_policy.html From this site, you can perform these tasks: Report security vulnerabilities in Cisco products. Obtain assistance with security incidents that involve Cisco products. Register to receive security information from Cisco. A current list of security advisories and notices for Cisco products is available at this URL: http://www.cisco.com/go/psirt If you prefer to see advisories and notices as they are updated in real time, you can access a Product Security Incident Response Team Really Simple Syndication (PSIRT RSS) feed from this URL: http://www.cisco.com/en/US/products/products_psirt_rss_feed. html
Reporting Security Problems in Cisco Products
Cisco is committed to delivering secure products. We test our products internally before we release them, and we strive to correct all vulnerabilities quickly. If you think that you might have identified a vulnerability in a Cisco product, contact PSIRT: Emergencies security-alert@cisco.com An emergency is either a condition in which a system is under active attack or a condition for which a severe and urgent security vulnerability should be reported. All other conditions are considered nonemergencies. Nonemergencies psirt@cisco.com In an emergency, you can also reach PSIRT by telephone: 228-408 525-6532 We encourage you to use Pretty Good Privacy (PGP) or a compatible product to encrypt any sensitive information that you send to Cisco. PSIRT can work from encrypted information that is compatible with PGP versions 2.x through 8.x. Never use a revoked or an expired encryption key. The correct public key to use in your correspondence with PSIRT is the one linked in the Contact Summary section of the Security Vulnerability Policy page at this URL: http://www.cisco.com/en/US/products/products_securi ty_vulnerability_policy.html The link on this page has the current PGP key ID in use.

9 Obtaining Technical Assistance
Cisco Technical Support provides 24-hour-a-day award-winning technical assistance. The Cisco Technical Support & Documentation website on Cisco.com features extensive online support resources. In addition, if you have a
valid Cisco service contract, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not have a valid Cisco service contract, contact your reseller.
Cisco Technical Support & Documentation Website
The Cisco Technical Support & Documentation website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, at this URL: http://www.cisco.com/techsupport Access to all tools on the Cisco Technical Support & Documentation website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL: http://tools.cisco.com/RPF/register/register.do Use the Cisco Product Identification (CPI) tool to locate your product serial number before submitting a web or phone request for service. You can access the CPI tool from the Cisco Technical Support & Documentation website by clicking the Tools & Resources link under Documentation & Tools. Choose Cisco Product Identification Tool from the Alphabetical Index drop-down list, or click the Cisco Product Identification Tool link under Alerts & RMAs. The CPI tool offers three search options: by product ID or model name; by tree view; or for certain products, by copying and pasting show command output. Search results show an illustration of your product with the serial number label location highlighted. Locate the serial number label on your product and record the information before placing a service call.
Submitting a Service Request
Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool provides recommended solutions. If your issue is not resolved using the recommended resources, your service request is assigned to a Cisco TAC engineer. The TAC Service Request Tool is located at this URL: http://www.cisco.com/techsupport/servicerequest For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco TAC engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly. To open a service request by telephone, use one of the following numbers: Asia-Pacific: +(Australia: 805 227) EMEA: +55 USA: 553-2447 For a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/techsupport/contacts

You must have Adobe Acrobat Reader to view and print PDF files. You can download the reader from Adobes website: http://www.adobe.com
3. To read translated and localized warranty information about your product, follow these steps: a. Enter this part number in the Warranty Document Number field: 78-10747-01C0 b. Select the language in which you would like to view the document. c. Click Go. The Cisco warranty page appears. d. Read the document online, or click the PDF icon to download and print the document in Adobe Portable Document Format (PDF). You can also contact the Cisco service and support website for assistance: http://www.cisco.com/public/Support_root.shtml.
Duration of Hardware Warranty One (1) Year Replacement, Repair, or Refund Policy for Hardware Cisco or its service center will use commercially reasonable efforts to ship a replacement part within ten (10) working days after receipt of a Return Materials Authorization (RMA) request. Actual delivery times can vary, depending on the customer location.
Cisco reserves the right to refund the purchase price as its exclusive warranty remedy.
To Receive a Return Materials Authorization (RMA) Number Contact the company from whom you purchased the product. If you purchased the product directly from Cisco, contact your Cisco Sales and Service Representative.
Complete the information below, and keep it for reference.
Company product purchased from Company telephone number Product model number Product serial number Maintenance contract number
Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA www.cisco.com Tel: 408 526-553-NETS (6387) Fax: 408 526-4100
European Headquarters Cisco Systems International BV Haarlerbergpark Haarlerbergweg 13-CH Amsterdam The Netherlands www-europe.cisco.com Tel: 1000 Fax: 1100
Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA www.cisco.com Tel: 408 526-7660 Fax: 408 527-0883
Asia Pacific Headquarters Cisco Systems, Inc. 168 Robinson Road #28-01 Capital Tower Singapore 068912 www.cisco.com Tel: +7777 Fax: +7799
Cisco Systems has more than 200 offices in the following countries. Addresses, phone numbers, and fax numbers are listed on the
Cisco Website at www.cisco.com/go/offices
Argentina Australia Austria Belgium Brazil Bulgaria Canada Chile China PRC Colombia Costa Rica Croatia Cyprus Czech Republic Denmark Dubai, UAE Finland France Germany Greece Hong Kong SAR Hungary India Indonesia Ireland Israel Italy Japan Korea Luxembourg Malaysia Mexico The Netherlands New Zealand Norway Peru Philippines Poland Portugal Puerto Rico Romania Russia Saudi Arabia cotland Singapore Slovakia Slovenia South Africa Spain Sweden Switzerland Taiwan Thailand Turkey Ukraine United Kingdom United States Venezuela Vietnam Zimbabwe

CCSP, CCVP, the Cisco Square Bridge logo, Follow Me Browsing, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Access Registrar, Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, FormShare, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect, RateMUX, ScriptShare, SlideCast, SMARTnet, StrataView Plus, TeleRouter, The Fastest Way to Increase Your Internet Quotient, and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries. All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0502R)
2005 Cisco Systems, Inc. All rights reserved. Printed in Malaysia

78-13014-07

CONTENTS

Preface vii

CHAPTER

Overview 1-1 CiscoIPPhone XML Objects 2-1 Understanding Object Behavior 2-1 XML Object Definitions 2-3 CiscoIPPhoneMenu 2-4 CiscoIPPhoneText 2-4 CiscoIPPhoneInput 2-6 CiscoIPPhoneDirectory 2-8 Custom Directories 2-9 CiscoIPPhoneImage 2-9 CiscoIPPhoneImageFile 2-12 CiscoIPPhoneGraphicMenu 2-14 CiscoIPPhoneGraphicFileMenu 2-15 CiscoIPPhoneIconMenu 2-16 CiscoIPPhoneIconFileMenu 2-18 CiscoIPPhoneStatus 2-19 CiscoIPPhoneStatusFile 2-22 CiscoIPPhoneExecute 2-23 CiscoIPPhoneResponse 2-24 CiscoIPPhoneError 2-25 Custom Softkeys 2-25

Customer Order Number:

Cisco Unified IP Phone Services Application Development Notes OL-142197

Contents

XML Considerations 2-27 Mandatory Escape Sequences 2-27 XML Encoding 2-28
Internal URI Features 3-1 Supported URIs by Phone Model 3-1 URIs for Pressing Buttons on the Phone 3-2 Key 3-3 URIs for Invoking Softkey Functionality 3-4 SoftKey 3-4 QueryStringParam URI 3-5 URIs to Control RTP Streaming 3-7 RTPRx 3-9 RTPTx 3-10 RTPMRx 3-10 RTPMTx 3-11 Miscellaneous URIs 3-11 Init 3-11 Dial 3-12 EditDial 3-12 Play 3-13 Display 3-14 Vibrate 3-15
Cisco IP Services Software Development Kit (SDK) 4-1 SDK Components 4-1 Sample Services Requirements 4-4

OL-142197

HTTP Requests and Header Settings 5-1 HTTP Client Requests (HTTP GET) 5-1 HTTP Server Requests (HTTP POST) 5-2 HTTP Header Settings 5-3 HTTP Refresh Setting 5-3 MIME Type and Other HTTP Headers 5-5 Audio Clips 5-5 Content Expiration Header Setting 5-6 Set-Cookie Header Setting 5-7 HTTP Encoding Header Setting 5-8 HTTP Response Headers: Content-Type 5-9 Identifying the Capabilities of IP Phone Clients 5-9 x-CiscoIPPhoneModelName 5-10 x-CiscoIPPhoneDisplay 5-10 x-CiscoIPPhoneSDKVersion 5-11 Accept Header 5-11 Accessing IP Phone Information 5-12
IP Phone Service Administration and Subscription 6-1 Overview 6-1 Adding a Phone Service 6-2 Defining IP Phone Service Parameters in Cisco Unified Communications Manager Administration 6-4 User Service Subscription 6-5
Troubleshooting Cisco Unified IP Phone Service Applications 7-1 Troubleshooting Tips 7-1 XML Parsing Errors 7-2

Error Messages 7-2

DeviceListX Report 8-1 Benefits 8-2 Restrictions 8-2 Integration Considerations and Interoperability 8-3 Performance and Scalability 8-3 Security 8-3 Related Features and Technologies 8-4 Supported Platforms 8-4 Prerequisites 8-4 Message and Interface Definitions 8-4 DeviceList XML Object 8-5 Troubleshooting DeviceListX Reports 8-6 Error Codes 8-6 Determining Problems With the Interface 8-7

CiscoIPPhoneInput objects do not use the HTTP POST method. The InputItem tag delimits each item in the list. The number of InputItems must not exceed five. Each input item includes a DisplayName, which is the prompt that is written to the display for that particular item. Each item also has a QueryStringParam, which is the name of the parameter that is appended to the URL when it is sent out after input is complete. Each input item can also use the DefaultValue tag to set the default value to be displayed. The final attribute for each input item comprises a set of InputFlags. The following table describes the input types that are currently defined. InputFlag A T N E U L P Description Plain ASCII textuse the DTMF keypad to enter text that consists of uppercase and lowercase letters, numbers, and special characters. Telephone numberenter only DTMF digits for this field. The acceptable input includes numbers, #, and *. Numericenter numbers as the only acceptable input. Equationenter numbers and special math symbols. Uppercaseenter uppercase letters as the only acceptable input. Lowercaseenter lowercase letters as the only acceptable input. Password fieldenter individual characters using the standard keypad-repeat entry mode. The system automatically converts accepted characters into an asterisk, keeping the entered value private.
P specifies the only InputFlag that works as a modifier. For example, specify a value of AP in the InputFlag field to use plain ASCII as the input type and to mask the input as a password by using an asterisk (*).
During text entry, Cisco Unified IP Phones display softkeys to assist users with text entry. Users can navigate between fields with the vertical scroll button that is used to navigate menus, and so on.

CiscoIPPhoneDirectory

The phone originally incorporated the CiscoIPPhoneDirectory XML object to support the Directory operation of Cisco Unified IP Phones, but it is available for your development purposes also. Figure 2-2 shows how an XML CiscoIPPhoneDirectory object displays on the phone.
Figure 2-2 CiscoIPPhoneDirectory Object Display Sample
<CiscoIPPhoneDirectory> <Title>Directory title goes here</Title> <Prompt>Prompt text goes here</Prompt> <DirectoryEntry> <Name>The name of the directory entry</Name> <Telephone>The telephone number for the entry</Telephone> </DirectoryEntry> </CiscoIPPhoneDirectory>
For the directory listing, the Cisco Unified IP Phone displays the appropriate softkeys that are needed to dial the numbers that are listed on the display. The softkeys include the Edit Dial softkey, which allows users to insert access codes or other necessary items before dialing. The Title and Prompt tags in the XML object have the usual semantics. A single CiscoIPPhoneDirectory object can contain a maximum of 32 DirectoryEntry objects. If more than 32 entries must be returned, use multiple CiscoIPPhoneDirectory objects in subsequent HTTP requests.

If the number of colors in the image is not reduced to match the phone capabilities, the image will be dithered by the phone and yield less than desirable results in most cases. To reduce the number of colors in a graphics editing program, such as Adobe Photoshop, use the Posterize command. The Posterize command takes one value as input for the number of color tones per color channel. For example, using the value of 16 (4-bits per channel = 16 tones per channel) will correctly dither the color palette of the image for the best display results on the Cisco Unified IP Phone 7970. Figure 2-4 shows a CiscoIPPhoneImageFile object on a Cisco Unified IP Phone 7970 display.
Figure 2-4 Cisco Unified IP Phone 7970 Image File Display
<CiscoIPPhoneImageFile> <Title>Image Title goes here</Title> <Prompt>Prompt text goes here</Prompt> <LocationX>Horizontal position of graphic</LocationX> <LocationY>Vertical position of graphic</LocationY> <URL>Points to the PNG image</URL> </CiscoIPPhoneImageF

CiscoIPPhoneGraphicMenu

Graphic menus serve the same purpose as text menus: they allow a user to select a URL from a list. Use graphic menus in situations when the items may not be easy to display in a text list. For example, users might prefer to have their choices presented in a non-ASCII character set such as Kanji or Arabic. When using non-ASCII character sets, the system presents the information as a bitmap graphic. To select a menu, the user enters a number from 1 to 12 using the numeric keypad (* and # are not active).
<CiscoIPPhoneGraphicMenu> <Title>Menu title goes here</Title> <Prompt>Prompt text goes here</Prompt> <LocationX>Position information of graphic</LocationX> <LocationY>Position information of graphic</LocationY> <Width>Size information for the graphic</Width> <Height>Size information for the graphic</Height> <Depth>Number of bits per pixel</Depth> <Data>Packed Pixel Data</Data> <MenuItem> <Name>The name of each menu item</Name> <URL>The URL associated with the menu item</URL> </MenuItem> </CiscoIPPhoneGraphicMenu>
Menu items in the graphic menu have a name, like the text menu counterparts. Although the name does not display to the user, it still performs a function. The name of the menu item provides the default title that is used when the URL for the chosen item is loaded. If the loaded page has a title of its own, the phone uses that title instead.

The RTPRx URI instructs the phone to receive a Unicast RTP stream or to stop receiving Unicast or Multicast RTP streams. URI Formats:

RTPRx:i:p:v RTPRx:Stop

Where i = the IP Address from which the stream is coming. p = the UDP port on which to receive the RTP stream. Ensure that this is an even port number within the decimal range of 20480 to 32768. If no port is specified, the phone chooses a port and returns it when initiated by a push request. Stop = the parameter that will stop any active RTP stream from being received on channel one v = the optional volume setting that controls the volume of stream playout. The supplied value is a percentage of the maximum volume level of the device and must be in the range 0-100. The phone converts the specified percentage into the closest device-supported volume level setting and uses it. After the initial volume level gets set and the stream starts, you can manually change the volume level as needed. If the optional volume parameter does not get included, the current volume setting on the phone gets used as the default.
Use the RTPTx URI to instruct the phone to transmit a Unicast RTP stream or to stop transmitting Unicast or Multicast RTP streams. URI Formats:

RTPTx:i:p RTPTx:Stop

Where i = the IP Address to which an RTP stream is transmit ed. p = the UDP port on which to transmit the RTP stream. Ensure that this is an even port number within the decimal range of 20480 to 32768. Stop = the parameter that will stop any active RTP stream from being transmitted on channel one.

RTPMRx

The RTPMRx URI instructs the phone to receive a Multicast RTP URI Format:

RTPMRx:i:p:v

Where i = the Multicast IP Address from which to receive an RTP stream. p = the Multicast UDP port from which to receive the RTP stream. Ensure that this is an even port number within the decimal range of 20480 to 32768. v = the optional volume setting that controls the volume of stream playout. The supplied value is a percentage of the maximum volume level of the device and must be in the range 0-100. The phone converts the specified percentage into the closest device-supported volume level setting and uses it. After the initial volume level gets set and the stream starts, you can manually change the volume level as needed. If the optional volume parameter does not get included, the current volume setting on the phone gets used as the default.
Internal URI Features Miscellaneous URIs

RTPMTx

The RTPMTx URI instructs the phone to transmit a Multicast RTP stream. URI Formats:

RTPTx:i:p

Where i = the Multicast IP Address to which an RTP stream is transmitted. p = the Multicast UDP port on which to transmit the RTP stream. Ensure that this is an even port number within the decimal range of 20480 to 32768.

Audio Clips

You can serve audio clips to the phone from a web server by using the audio/basic MIME type setting. When this MIME type is used, the body of the response should contain raw audio data in the same format that is used for custom Cisco Unified IP Phone rings. Refer to the chapter on Custom Phone Rings in the Cisco Unified Communications Manager System Guide (also available in the online help).
The audio file should not be longer than 5 seconds. Use the following ASP sample script to set the MIME type and to serve the file that is specified in the #include command:
<%@ Language=JavaScript%> <% Response.ContentType = "audio/basic"; %><!--#include file="filename.raw" --><% Response.End();%>
Using script to generate the MIME header when playing a sound provides an advantage because you may also include a refresh header to take the phone to a subsequent URL. Usually, you can set the MIME type for pages in any web server by simply performing an association to the.xml or.raw file extension. Your web server documentation should explain how to accomplish this. This action allows you to serve static pages without the need for writing script.
Content Expiration Header Setting
The expiration header can control which URLs are added to the phone URL history. This behavior differs slightly from traditional web browsers but is implemented to perform the same function. Disable the back button functionality to avoid calling a URL twice. This functionality allows you to make the content of any page that is sent to the phone expire. When a user presses the Exit softkey, the user goes back to the last URL that did not expire when it was loaded. This differs from traditional browsers by not considering the current freshness of the data but the freshness of the data when the URL was requested. This requires you to have a page expire when it is first loaded and to not set a time and date in the future. The following example shows how to have content on IIS expire by using Active Server Page (ASP):
<%@ Language=JavaScript %> <% Response.ContentType = "text/xml"; Response.Expires = -1; %>

HTTP standards state that if the encoding is not explicitly specified, ISO-8859-1 is the default.Cisco Unified IP Phones are typically compatible with this spec, but not fully compliant. If 'charset' is not specified, the phones will use the default encoding for the currently configured user locale. So to avoid possible problems where the phone's default encoding may NOT be ISO-8859-1, the web server should explicitly set the Content-Type charset (which must match one of the Accept-Charset values specified by the phone).
Identifying the Capabilities of IP Phone Clients
Because XML services are now supported across a wide range of Cisco Unified IP Phones, web application servers now need to identify the capabilities of the requesting IP phone to optimize the content returned to the phone. For example, if the requesting phone is a Cisco Unified IP Phone 7960, which cannot support color PNG images, the application server must be able to identify this and return a gray scale CIP image instead. The IP phone client request to send the relevant information from the IP phone to the web server application includes three (3) HTTP headers:
Chapter 5 Identifying the Capabilities of IP Phone Clients
x-CiscoIPPhoneModelName x-CiscoIPPhoneDisplay x-CiscoIPPhoneSDKVersion

x-CiscoIPPhoneModelName

This Cisco-proprietary header contains the Cisco manufacturing Model Name of the device, which can typically be found by going to Settings > Model Information, but varies between different models. Some examples of manufacturing Model Names are CP-7960, CP-7960G, CP-7940G, CP-7905G, and CP-7970G.

x-CiscoIPPhoneDisplay

This Cisco-proprietary header contains the display capabilities of the requesting device with the following four parameters (listed in the order in which they appear):
Width (in pixels) Height (in pixels) Color depth (in bits) A single character indicating whether the display is color (''C'') or gray scale (''G'')
These parameters get separated by commas as shown in the following example of a Cisco Unified IP Phone 7970 header:
x-CiscoIPPhoneDisplay: 298, 168, 12, C
The pixel resolutions advertised by the device define the area of the display accessible by the phone services; not the actual resolution of the display.
HTTP Requests and Header Settings Accept Header

x-CiscoIPPhoneSDKVersion

This Cisco-proprietary header contains the version of the IP Phone Services SDK that the requesting phone supports. The HTTP header does not specify which URIs are supported. Therefore, you must check the Supported URIs matrix in the IP Phone Services SDK to determine which URIs are supported based on the Phone Model Name and supported SDK version. See the URIs Supported for Release Cisco Unified IP Phone Services SDK table to find which IP phone models support the URIs documented in this SDK.

http://x.x.x.x/CCMAdmin/reports/devicelistx.asp where x.x.x.x can either be the IP address or hostname of the Cisco Unified CallManager system that contains the report.
Beginning with Cisco Unified CallManager 4.1 release, the DeviceListX report can only be accessed via secure HTTP (HTTPS), so the URL must begin with https: rather than http:.
DeviceListX Report DeviceList XML Object

DeviceList XML Object

Third-party applications that reside elsewhere on the network commonly use the interface. The application makes an HTTP request for the report and gets a response that contains a DeviceList XML object. The XML object follows:
<?xml version="1.0" encoding="iso-8859-1"?> <DeviceList> <Device t="" n="" d="" c="" p="" i="" s="" /> </DeviceList>

Table 8-1

DeviceList XML Object Attributes
Attribute Name t n d c p i
Field Name Device Type Device Name Device Description Device Calling Search Space Device Pool Device IP Address
Description Numeric enumeration value that is specified in the database. String value that specifies the device name. String value that is specified in the database. String value that is specified in the database. String value that is specified in the database. Last known IP address as reported by the Real-Time Information Service "" = No known IP address "x.x.x.x" = Last known IP address

Device Status

Numeric enumeration for the current device status as reported by the Real-Time Information Service "" = Device not found "1" = Device registered "2" = Device found but not currently registered

Example 8-1

DeviceList Object with Data
<?xml version="1" encoding="iso-8859-1"?> <DeviceList> <Device t="35" n="SEP000123456789" d="Auto 2010" c= p="Default" i="10.1.1.1" s="1"/> </DeviceList>
Chapter 8 Troubleshooting DeviceListX Reports
Troubleshooting DeviceListX Reports
These sections can assist you in troubleshooting DeviceListX Reports:
Error Codes Determining Problems With the Interface

Error Codes

The error codes that are specific to this report interface follow.
Error Message 1001 Too many simultaneous requests for Device List. Please wait at least 60 seconds and try again. Explanation When two or more clients attempt to get the list at the same time, or if the list is long, overlapping requests can result (first request is processing when the second request attempts processing). Recommended Action Request information only as often as necessary.

Cisco recommends that you wait longer than 60 seconds between requests.
Error Message 1002 Too many consecutive requests for Device List. Please wait at least 60 seconds and try again. Explanation Because the system is busy, it cannot process a Device List. Recommended Action Request information only as often as necessary. Because the real-time status of every device gets checked, Device List represents a CPU-intensive process.
DeviceListX Report Troubleshooting DeviceListX Reports
Determining Problems With the Interface
Use the following procedure to determine whether a problem exists with the interface and determine the root cause of the problem.

Step 1

Check the Windows NT Event Logs for error messages that pertain to the IIS server and the SQL server. Start > Programs > Administrative Tools > Event Viewer Check for error messages or successful completion of a request in the IIS log files, which are typically located in C:\WINNT\System32\LogFiles\W3SVC1 The date of the log provides part of the log name. All times in the log files specify GMT for noted events. The IIS logs appear in chronological order and can easily be searched by specific query event.

Step 2

Step 3
Use a web browser, such as IE, to request the URL of the devicelistx.asp web page. A successful request yields a well-formed XML object of all the device information. Use a Sniffer trace to view the HTTP GET request and response transaction between the third-party application and the report. If you need further assistance, see the Obtaining Documentation, Obtaining Support, and Security Guidelines section on page x.

Step 4 Step 5

CiscoIPPhone XML Object Quick Reference
Table A-1 provides a quick reference of the CiscoIPPhone XML objects and the definitions that are associated with each.
Table A-1 CiscoIPPhone XML Object Quick Reference

Object

<CiscoIPPhoneMenu> <Title>Title text goes here</Title> <Prompt>Prompt text goes here</Prompt> <MenuItem> <Name>The name of each menu item</Name> <URL>The URL associated with the menu item</URL> </MenuItem> </CiscoIPPhoneMenu> <CiscoIPPhoneText> <Title>Title text goes here</Title> <Prompt>The prompt text goes here</Prompt> <Text>Text to display as the message body goes here</Text> </CiscoIPPhoneText>

</xsd:element> <xsd:element name="Depth"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="1"/> <xsd:maxInclusive value="2"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Data" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:hexBinary"> <xsd:maxLength value="2162"/> <xsd:minLength value="0"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MenuItem" type="CiscoIPPhoneMenuItemType" minOccurs="0" maxOccurs="12"/> <xsd:element name="SoftKeyItem" type="CiscoIPPhoneSoftKeyType" minOccurs="0" maxOccurs="8"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneGraphicFileMenuType"> <xsd:sequence> <xsd:element name="Title" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Prompt" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="LocationX" default="0" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:short"> <xsd:minInclusive value="-1"/> <xsd:maxInclusive value="297"/> </xsd:restriction> </xsd:simpleType>
</xsd:element> <xsd:element name="LocationY" default="0" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:short"> <xsd:minInclusive value="-1"/> <xsd:maxInclusive value="167"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="URL"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:maxLength value="256"/> <xsd:minLength value="1"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MenuItem" type="CiscoIPPhoneTouchAreaMenuItemType" minOccurs="0" maxOccurs="32"/> <xsd:element name="SoftKeyItem" type="CiscoIPPhoneSoftKeyType" minOccurs="0" maxOccurs="8"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneTouchAreaMenuItemType"> <xsd:sequence> <xsd:element name="Name" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="URL" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="256"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="TouchArea" type="CiscoIPPhoneTouchArea" minOccurs="0"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneTouchArea"> <xsd:attribute name="X1" type="xsd:unsignedShort" use="required"/>

<xsd:attribute name="Y1" type="xsd:unsignedShort" use="required"/> <xsd:attribute name="X2" type="xsd:unsignedShort" use="required"/> <xsd:attribute name="Y2" type="xsd:unsignedShort" use="required"/> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneDirectoryEntryType"> <xsd:sequence> <xsd:element name="Name" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:maxLength value="32"/> <xsd:minLength value="0"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Telephone" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:maxLength value="32"/> <xsd:minLength value="0"/> </xsd:restriction> </xsd:simpleType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneDirectoryType"> <xsd:sequence> <xsd:element name="Title" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Prompt" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DirectoryEntry" type="CiscoIPPhoneDirectoryEntryType" minOccurs="0" maxOccurs="32"/> <xsd:element name="SoftKey" type="CiscoIPPhoneSoftKeyType" minOccurs="0" maxOccurs="8"/> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="CiscoIPPhoneMenuItemType"> <xsd:sequence> <xsd:element name="Name" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="64"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="URL" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:maxLength value="256"/> <xsd:minLength value="0"/> </xsd:restriction> </xsd:simpleType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneIconItemType"> <xsd:sequence> <xsd:element name="Index" type="xsd:unsignedShort"/> <xsd:element name="Width"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="1"/> <xsd:maxInclusive value="16"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Height"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="1"/> <xsd:maxInclusive value="10"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Depth"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="1"/> <xsd:maxInclusive value="2"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Data" minOccurs="0">

<xsd:element name="Depth"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="1"/> <xsd:maxInclusive value="2"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Data" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:hexBinary"> <xsd:minLength value="0"/> <xsd:maxLength value="557"/> </xsd:restriction> </xsd:simpleType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneStatusFileType"> <xsd:sequence> <xsd:element name="Text" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Timer" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="0"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="LocationX" default="0" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:short"> <xsd:minInclusive value="-1"/> <xsd:maxInclusive value="261"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="LocationY" default="0" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:short"> <xsd:minInclusive value="-1"/> <xsd:maxInclusive value="49"/>
</xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="URL"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="1"/> <xsd:maxLength value="256"/> </xsd:restriction> </xsd:simpleType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneIconFileItemType"> <xsd:sequence> <xsd:element name="Index"> <xsd:simpleType> <xsd:restriction base="xsd:unsignedShort"> <xsd:minInclusive value="0"/> <xsd:maxInclusive value="9"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="URL"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="1"/> <xsd:maxLength value="256"/> </xsd:restriction> </xsd:simpleType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="CiscoIPPhoneIconFileMenuType"> <xsd:sequence> <xsd:element name="Title" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Prompt" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="0"/> <xsd:maxLength value="32"/>

Symbols

<< softkey 3-5
Parameter is Required field 6-4 Parameter Name field 6-4 Service Description field 6-2 Service Name field 6-2 Service URL field 6-3 subscribing to services 6-5 Cisco IP Phone models accessing information about 5-12 supported displays and colors 2-12 supported URIs 3-1 supported XML objects 2-2, 2-21, 2-22 CiscoIPPhone XML Objects CiscoIPPhoneDirectory 2-8 CiscoIPPhoneError 2-25 CiscoIPPhoneExecute 2-23 CiscoIPPhoneGraphicFileMenu 2-15 CiscoIPPhoneGraphicMenu 2-14 CiscoIPPhoneIconFileMenu 2-18 CiscoIPPhoneIconMenu 2-16 CiscoIPPhoneImage 2-9 CiscoIPPhoneImageFile 2-12 CiscoIPPhoneInput 2-6 CiscoIPPhoneMenu 2-4 CiscoIPPhoneResponse 2-24
accept header, support for 5-11 audio types, supported 5-5
Cancel softkey 3-5 CGI script Execute 5-13 Screenshot 5-13 Character Set field 6-3 Cisco CallManager adding services 6-2 Character Set field 6-3 Default Value field 6-4 defining service parameters 6-4 Parameter Description field 6-4 Parameter Display Name field 6-4 Parameter is a Password field 6-4
CiscoIPPhoneStatus 2-19 CiscoIPPhoneStatusFile 2-22 CiscoIPPhoneText 2-4 supported phone models 2-2 understanding 2-1 Cisco IP Services Software Development Kit (SDK) components 4-1 development tools 4-2 sample services description 4-2 requirements 4-4 client requests, using HTTP 5-1 content expiration, header setting 5-6 cookie behavior 5-7
creating 2-8 customizing 2-9 documentation additional 1-ix
EditDial, used as URI 3-12 EditDial softkey 3-5 error codes, description 2-25, 3-7 EthernetInformation 5-12 Execute, CGI script 5-13 executing items priority levels 2-24 sending requests 2-23 Exit softkey 3-5
Default Value field 6-4 development tools, included with SDK 4-2 DeviceInformation 5-12 device information URLs 5-12 DeviceList XML Object attributes 8-5 description 8-5 DeviceListX Report 8-1 DeviceLog 5-12 Dial, used as URI 3-12 Dial softkey 3-5 directories
graphic menus, creating 2-14 graphics displaying color images 2-12 displaying grayscale images 2-9 PNG support 2-12, 2-18 using with status 2-19
header settings, for HTTP 5-3
HTML URL DeviceInformation 5-12 DeviceLog?n 5-12 EthernetInformation 5-12 EthernetInformation?n 5-12 NetworkConfiguration 5-12 StreamingStatistics?n 5-12 HTTP client requests 5-1 header settings 5-3 accept 5-11 content expiration 5-6 MIME type 5-5 refresh setting 5-3 set-cookie 5-7 x-CiscoIPPhoneDisplay 5-10 x-CiscoIPPhoneModelName 5-10 x-CiscoIPPhoneSDKVersion 5-11 how used 5-1 server requests 5-2 HTTP GET 5-1 HTTP POST 5-2
input forms creating 2-6 supported input types 2-7

key, used as URI 3-3

menus graphic 2-14 icon, color 2-18 icon, grayscale 2-16 text 2-4 MIME type, for HTTP 5-5
NetworkConfiguration 5-12 Next softkey 3-5
Parameter Description field 6-4 icon menus, creating color 2-18 grayscale 2-16 Init, used as URI 3-11 Parameter Display Name field 6-4 Parameter is a Password field 6-4 Parameter is Required field 6-4 Parameter Name field 6-4
Play, used as URI 3-13 PNG images displaying on screen 2-12 using in menus 2-18 PortInformation 5-12 priority levels, for executing items 2-24
services adding to Cisco CallManager 6-2 defining parameters of in Cisco CallManager 6-4 requirements for samples 4-4 samples included with SDK 4-2 subscribing to in Cisco CallManager 6-5 Service URL field 6-3
QueryStringParam, used as URI 3-5
set-cookie, header setting 5-7 softkey << 3-5 Cancel 3-5
refresh setting, for HTTP 5-3 RTPMRx, used as URI 3-10 RTPMTx, used as URI 3-11 RTPRx, used as URI 3-9 RTPTx, used as URI 3-10
Dial 3-5 EditDial 3-5 Exit 3-5 Next 3-5 Search 3-5 Select 3-5 Submit 3-5 Update 3-5 used as URI 3-4 valid actions for object types 3-5 status, displaying for applications 2-19, 2-22 StreamingStatistics 5-12 Submit softkey 3-5
Screenshot, CGI script 5-13 SDK. See Cisco IP Services Software Development Kit (SDK) Search softkey 3-5 Select softkey 3-5 server requests, using HTTP 5-2 Service Description field 6-2 Service Name field 6-2
text menus, creating 2-4 text messages, displaying 2-4
troubleshooting error messages 7-2 tips 7-1 XML parsing errors 7-2
x-CiscoIPPhoneDisplay 5-10 x-CiscoIPPhoneModelName 5-10 x-CiscoIPPhoneSDKVersion 5-11 XML schema file B-1 XML URL DeviceInformationX 5-12 DeviceLogX?n 5-12 EthernetInformationX 5-12 NetworkConfigurationX 5-12 PortInformationX?nX 5-12 StreamingStatisticsX?n 5-12
uniform resource identifiers (URI) description 3-1 for pressing buttons 3-2 key 3-3 miscellaneous 3-11 Dial 3-12 EditDial 3-12 Init 3-11 Play 3-13 phone model support for 3-1 to control RTP streaming 3-7 RTPMRx 3-10 RTPMTx 3-11 RTPRx 3-9 RTPTx 3-10 to invoke softkeys 3-4 QueryStringParam 3-5 softkey 3-4 Update softkey 3-5 URI. See uniform resource identifiers