Cisco IOS Telephony Services Version 3.0System Administrator Guide July 7, 2003
Corporate HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706 USAhttp://www.cisco.comTel: 408 526-4000
800 553-NETS (6387)Fax: 408 526-4100
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco IOS Telephony Services System Administrator Guide Version 3.0Copyright © 2003 Cisco Systems, Inc. All rights reserved.
CCIP, CCSP, the Cisco Arrow logo, the Cisco Powered Network mark, the Cisco Systems Verified logo, Cisco Unity, Follow Me Browsing, FormShare, iQ Net Readiness Scorecard, Networking Academy, and ScriptShare are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn, The Fastest Way to Increase Your Internet Quotient, and iQuick Study are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCNA, CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, the Cisco IOS logo, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherSwitch, Fast Step, GigaStack, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, LightStream, MGX, MICA, the Networkers logo, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, RateMUX, Registrar, SlideCast, SMARTnet, StrataView Plus, Stratm, SwitchProbe, TeleRouter, TransPath, and VCO are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other countries.
All other trademarks mentioned in this document or Web site 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. (0303R)
Cisco IOS Telep
C O N T E N T S
Preface xi
Documentation Objectives xi
Audience xi
Documentation Organization xi
Document Conventions xiii
Obtaining Documentation xv
Cisco.com xv
Documentation CD-ROM xv
Ordering Documentation xv
Documentation Feedback xvi
Obtaining Technical Assistance xvi
Cisco TAC Website xvi
Opening a TAC Case xvi
TAC Case Priority Definitions xvii
Obtaining Additional Publications and Information xvii
C H A P T E R 1 Cisco IOS Telephony Services Overview 1-1
Contents 1-5
Cisco IOS Telephony Services 1-5
Cisco IOS Telephony Services Network Scenarios 1-6
Additional Features 1-7
Provisioning 1-7
Connecting Cisco IP Phones 1-7
Prerequisites 1-8
License Prerequisites 1-8
Memory Prerequisites 1-8
Network Prerequisites 1-9
Software Prerequisites 1-9
Cisco IOS Software 1-9
Cisco IOS Telephony Services Version 3.0 Files 1-9
Restrictions 1-12
Information About Setting Up an ITS System 1-13
Before You Start: Basic ITS Concepts 1-15
Ephones 1-16
iiihony Services Version 3.0 System Administrator Guide
Contents
Ephone-dns 1-16
Single-Line Ephone-dn 1-17
Dual-Line Ephone-dn 1-18
Two Ephone-dns with One Number 1-18
Dual-Number Ephone-dn 1-20
Shared Ephone-dn 1-20
Overlay Ephone-dn 1-21
Phone Number Plan 1-22
Direct Inward Dialing 1-23
PBX or Keyswitch Model 1-24
What to Do Next 1-24
Additional References 1-24
Related Documents 1-25
Standards 1-25
MIBs 1-26
RFCs 1-26
Technical Assistance 1-26
C H A P T E R 2 Setting Up an ITS System 2-1
Contents 2-1
Information About Setting Up an ITS System 2-1
Prerequisites 2-1
Setting Network Parameters for ITS 2-2
Setting Up DHCP Service for ITS 2-2
Defining a Single DHCP IP Address Pool 2-2
Defining a Separate DHCP IP Address Pool for Each Cisco IP Phone 2-3
Defining a DHCP Relay Server 2-4
Configuring Network Time Protocol 2-5
Upgrading from ITS V2.1 to ITS V3.0 2-6
Downgrading the Cisco IOS Software Image to an Earlier Version 2-8
Verifying the Configuration 2-8
What to Do Next 2-9
C H A P T E R 3 Setting Up Phones in an ITS System 3-1
Contents 3-1
Information About Setting Up Phones in an ITS System 3-1
Specifying ITS Parameters 3-2
Setting Up Initial Extensions and Phones 3-5
ivCisco IOS Telephony Services Version 3.0 System Administrator Guide
Contents
Automated Phone Setup Using the ITS Setup Tool 3-6
Prerequisites 3-6
Restrictions 3-7
ITS Setup Tool Dialog 3-7
Configurations Resulting from the ITS Setup Tool Dialog 3-10
Partially Automated Setup Using Router CLI 3-12
Prerequisites 3-12
Restrictions 3-12
Manual Setup Using Router CLI 3-14
Prerequisites 3-14
Specifying Phone-Related Parameters 3-19
DTMF Relay 3-19
Configuring DTMF Relay for H.323 Networks 3-19
Configuring DTMF Relay for SIP Networks 3-20
Dial-Plan Pattern 3-22
SIP Register Support 3-23
Translation Rules 3-25
International Language, Date Formats, and Tone Support 3-26
Restrictions 3-26
Resetting and Restarting ITS Phones 3-29
Rebooting Phones Using the reset Command 3-29
Rebooting One Phone Using the restart Command 3-31
Rebooting All Phones Using the restart Command 3-31
Verifying ITS Phone Configuration 3-32
Configuration Example 3-34
What to Do Next 3-37
C H A P T E R 4 Configuring Call Transfer 4-1
Contents 4-1
Information About Configuring Call Transfer 4-1
Configuring H450.2-Standard Call Transfer for IP Phones 4-2
Prerequisites 4-2
Restrictions 4-2
Configuring Cisco-Proprietary Call Transfer 4-6
Restrictions 4-6
What to Do Next 4-7
vCisco IOS Telephony Services Version 3.0 System Administrator Guide
Contents
C H A P T E R 5 Configuring Call Forwarding 5-1
Contents 5-1
Information About Configuring Call Forwarding 5-1
Configuring H.450.3-Standard Call Forwarding for IP Phones 5-2
Prerequisites 5-2
Restrictions 5-2
Configuring Cisco-Proprietary Call Forwarding 5-4
What to Do Next 5-5
C H A P T E R 6 Setting Up the ITS GUI 6-1
Contents 6-1
Information About Setting Up the ITS GUI 6-1
Prerequisites 6-2
Restrictions 6-2
Setting Up GUI Access for the System Administrator 6-2
Enabling an HTTP Server and Setting the HTTP Path 6-3
Setting Up GUI Access for the System Administrator 6-3
Troubleshooting Tips 6-5
Accessing the Cisco ITS GUI 6-5
Creating Additional GUI Login Accounts 6-7
Setting Up GUI Access for Customer Administrators 6-7
Creating and Loading an XML Configuration File 6-8
Defining a Customer Administrator 6-11
Setting Up GUI Access for Phone Users 6-13
What to Do Next 6-15
C H A P T E R 7 Setting Up Optional ITS System Features 7-1
Contents 7-1
Secondary Dial Tone 7-1
Interdigit Timeout 7-2
Ringing Timeout 7-3
Music on Hold 7-4
Configuring Music on Hold from an Audio File 7-5
Prerequisites 7-5
Restrictions 7-5
Configuring Music on Hold from a Live Feed 7-7
Restrictions 7-7
viCisco IOS Telephony Services Version 3.0 System Administrator Guide
Contents
C H A P T E R 8 Configuring ITS Phone Features 8-1
Contents 8-1
Related Features 8-1
Automatic Line Selection 8-2
On-Hook Dialing 8-3
Three-Party G.711 Conference Calls 8-4
Caller ID Blocking on Outbound Calls 8-5
Restrictions 8-5
Caller ID Blocking per Call 8-6
Callback Busy Subscriber 8-7
Speed-Dial Features 8-7
Speed-Dial Buttons 8-7
Defining Speed-Dial Button Information from ITS Router CLI 8-8
Changing Existing Speed-Dial Button Information from an IP Phone 8-10
Local Speed Dial 8-11
Prerequisites 8-11
Personal Speed Dial 8-13
Configurable Phone Displays 8-14
IP Phone Header Bar 8-14
System Text Message for the Cisco IP Phone 7940 and Cisco IP Phone 7960 8-15
System Display Message (Idle URL) for the Cisco IP Phone 7940 and Cisco IP Phone 7960 8-16
URL Provisioning for Customized Function Buttons 8-18
C H A P T E R 9 Integrating Voice Mail with ITS 9-1
Contents 9-1
Configuring ITS for Cisco Unity Voice Mail 9-1
Configuring an Access Number for Voice Mail 9-2
Configuring the Router for Cisco Unity Voice Mail Integration Using SCCP 9-2
Associating a Voice-Mail Device 9-3
Configuring Message Waiting Indication 9-5
Information About the MWI Mechanism 9-5
Information About the MWI Relay Mechanism 9-7
Configuring the SIP-Based MWI Server 9-7
Configuring MWI for Each ephone-dn 9-8
Configuring an ephone-dn for MWI Notification 9-9
Configuring MWI Relay 9-10
viiCisco IOS Telephony Services Version 3.0 System Administrator Guide
Contents
Configuring DTMF for Legacy Voice-Mail Devices 9-12
Configuring DTMF Patterns on the Router 9-12
Configuring Integration Files on Legacy Voice-Mail Systems 9-14
C H A P T E R 10 Configuring an Attendant for Primary Call Coverage 10-1
Contents 10-1
Related Features 10-1
Label Support 10-2
Monitor Lamp and Direct Station Select 10-3
Silent Ring 10-5
On-Hold Call Notification 10-6
Night Service 10-8
IVR Auto-Attendant 10-12
C H A P T E R 11 Configuring Call Blocking 11-1
Contents 11-1
Call-Blocking (Toll Bar) Based on Time of Day and Day of Week or Date 11-1
Call-Blocking (Toll Bar) Override 11-4
Restrictions 11-4
Do Not Disturb Service 11-6
Class of Restriction 11-6
C H A P T E R 12 Configuring Secondary Call Coverage 12-1
Contents 12-1
Related Features 12-1
Information About Configuring Call Coverage 12-1
Ephone-dn Overlays 12-2
Ephone-dn Dial-Peer Preference 12-4
Huntstop 12-5
Ephone Hunt Groups 12-7
Configuring Sequential Ephone Hunt Groups 12-9
Configuring Peer Ephone Hunt Groups 12-11
Call-Pickup Groups 12-13
viiiCisco IOS Telephony Services Version 3.0 System Administrator Guide
Contents
C H A P T E R 13 Configuring Directories 13-1
Contents 13-1
Local Directory Order 13-1
Additional Directory Entries 13-2
Local Directory Disable 13-3
C H A P T E R 14 Configuring Productivity Tools 14-1
Contents 14-1
Related Features 14-1
Flash Soft Key for Hookflash Functionality 14-2
Intercom 14-3
Paging 14-6
Restrictions 14-7
Configuring Paging for a Single Group 14-8
Configuring Paging for a Combined Group 14-11
Prerequisites 14-11
Account Code Entry by User 14-14
Applications Integration with Cisco ITS 14-14
Downloading and Setting Up Cisco IOS TSP 14-15
Prerequisites 14-15
Modifying a TSP Configuration 14-17
Removing TSP 14-19
Verifying Basic TAPI Operation 14-19
Troubleshooting TSP 14-19
Troubleshooting TSP on the ITS Router 14-19
Troubleshooting TSP on a PC 14-21
C H A P T E R 15 Monitoring and Managing an ITS System 15-1
C H A P T E R 16 Troubleshooting an ITS System 16-1
CR -1
GL O S S A R Y
I N D E X
ixCisco IOS Telephony Services Version 3.0 System Administrator Guide
Contents
xCisco IOS Telephony Services Version 3.0 System Administrator Guide
Preface
This preface discusses the objectives, audience, organization, and conventions of this document. It also provides sources for obtaining documentation and technical assistance from Cisco Systems.
Documentation ObjectivesThis document describes the tasks and commands necessary to configure and maintain Cisco IOS Telephony Services (ITS).
AudienceThis document is intended primarily for system administrators who configure and maintain Cisco ITS but who may not be familiar with the tasks, the relationship between tasks, or the Cisco IOS software commands necessary to perform particular tasks. This configuration guide is also intended for those users experienced with Cisco ITS who need to know about new features, new configuration options, and new software characteristics in the current Cisco IOS software release.
System administrators who are setting up a Cisco ITS system should be familiar with the following:
• TCP/IP fundamentals: IP addressing, routing, DHCP, HTTP, NTP, TFTP
• Cisco IOS fundamentals: CLI operation, VLAN configuration, flash and TFTP file management
• VoIP fundamentals: Configuring and verifying dial peers and voice ports
Documentation OrganizationThis document includes the following chapters:
• Chapter 1, “Cisco IOS Telephony Services Overview,” contains a high-level explanation of Cisco ITS.
• Chapter 2, “Setting Up an ITS System,” lists ITS prerequisites and explains how to set up a router to support ITS.
• Chapter 3, “Setting Up Phones in an ITS System,” describes the basic steps to set up IP phones.
xiCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceDocumentation Organization
• Chapter 4, “Configuring Call Transfer,” explains the types of call transfer that can be used in an ITS system and how to enable each type.
• Chapter 5, “Configuring Call Forwarding,” explains the types of call forwarding that can be used in an ITS system and how to enable each type.
• Chapter 6, “Setting Up the ITS GUI,” explains how to set up the ITS graphical user interface (GUI), which provides a web-browser-based interface for administrators to enable and change phone configurations and for phone users to search directories and change their own speed-dial information.
• Chapter 7, “Setting Up Optional ITS System Features,” explains the following features that affect all ITS users on a systemwide basis:
– Interdigit timeout
– Secondary dial tone
– Ringing timeout
– Music on hold (MOH)
• Chapter 8, “Configuring ITS Phone Features,” describes the following optional features that people use or see on their phones:
– Automatic line selection
– On-hook dialing
– Three-party G.711 conference calls
– Caller ID blocking
– Caller ID blocking per call
– Callback busy subscriber
– Speed-dial features
– Configurable phone displays
• Chapter 9, “Integrating Voice Mail with ITS,” describes how to integrate an ITS system with several types of existing voice-mail systems.
• Chapter 10, “Configuring an Attendant for Primary Call Coverage,” explains the following features that are designed to enhance systems in which a single number is used for incoming contact:
– Label support
– Busy monitor lamp and direct station select
– Silent ringing
– On-hold call notification
– Night service
– Busy attendant announcement
– IVR auto-attendant
• Chapter 11, “Configuring Call Blocking,” describes selective restrictions on outgoing calls.
• Chapter 12, “Configuring Secondary Call Coverage,” explains the following features that can be used to provide call coverage by routing incoming calls:
– Ephone-dn overlays
– Ephone-dn dial-peer preference
xiiCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceDocument Conventions
– Huntstop
– Ephone hunt groups
– Call pickup and call pickup groups
• Chapter 13, “Configuring Directories,” explains features that relate to directories of numbers that are maintained in an ITS system.
• Chapter 14, “Configuring Productivity Tools,” describes the following features to help employees in their jobs:
– Flash soft key for hookflash functionality
– Intercom
– Paging
– Account code entry
– Applications integration
• Chapter 15, “Monitoring and Managing an ITS System,” lists commands that can help administrators to observe the functioning of an ITS system.
• Chapter 16, “Troubleshooting an ITS System,” contains suggestions and commands for diagnosing problems with ITS configuration and operation.
• The Command Reference contains entries for Cisco IOS commands that are new or changed in this Cisco IOS release.
Document ConventionsWithin Cisco IOS software documentation, the term router is generally used to refer to a variety of Cisco products (for example, routers, access servers, and switches). Routers, access servers, and other networking devices that support Cisco IOS software are shown interchangeably within examples. These products are used only for illustrative purposes; that is, an example that shows one product does not necessarily indicate that other products are not supported.
The Cisco IOS documentation set uses the following conventions:
Command syntax descriptions use the following conventions:
Convention Description
^ or Ctrl The ^ and Ctrl symbols represent the Control key. For example, the key combination ^D or Ctrl-D means hold down the Control key while you press the D key. Keys are indicated in capital letters but are not case sensitive.
string A string is a nonquoted set of characters shown in italics. For example, when setting an SNMP community string to public, do not use quotation marks around the string or the string will include the quotation marks.
Convention Description
boldface Boldface text indicates commands and keywords that you enter literally as shown.
italics Italic text indicates arguments for which you supply values.
[x] Square brackets enclose an optional element (keyword or argument).
xiiiCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceDocument Conventions
Nested sets of square brackets or braces indicate optional or required choices within optional or required elements. For example:
Examples use the following conventions:
The following conventions are used to attract the attention of the reader:
Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.
Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in this manual.
Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.
| A vertical line indicates a choice within an optional or required set of keywords or arguments.
[x | y] Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional choice.
{x | y} Braces enclosing keywords or arguments separated by a vertical line indicate a required choice.
Convention Description
Convention Description
[x {y | z}] Braces and a vertical line within square brackets indicate a required choice within an optional element.
Convention Description
screen Examples of information displayed on the screen are set in Courier font.
boldface screen Examples of text that you must enter are set in Courier bold font.
< > Angle brackets enclose text that is not printed to the screen, such as passwords.
! An exclamation point at the beginning of a line indicates a comment line. (Exclamation points are also displayed by the Cisco IOS software for certain processes.)
[ ] Square brackets enclose default responses to system prompts.
xivCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceObtaining Documentation
Obtaining DocumentationCisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.
Cisco.comYou can access the most current Cisco documentation on the World Wide Web at this URL:
http://www.cisco.com/univercd/home/home.htm
You can access the Cisco website at this URL:
http://www.cisco.com
International Cisco websites can be accessed from this URL:
http://www.cisco.com/public/countries_languages.shtml
Documentation CD-ROMCisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated regularly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual or quarterly subscription.
Registered Cisco.com users can order a single Documentation CD-ROM (product number DOC-CONDOCCD=) through the Cisco Ordering tool:
http://www.cisco.com/en/US/partner/ordering/ordering_place_order_ordering_tool_launch.html
All users can order annual or quarterly subscriptions through the online Subscription Store:
http://www.cisco.com/go/subscription
Ordering DocumentationYou can find instructions for ordering documentation at this URL:
http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm
You can order Cisco documentation in these ways:
• Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Networking Products MarketPlace:
http://www.cisco.com/en/US/partner/ordering/index.shtml
• Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, USA.) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).
xvCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceObtaining Technical Assistance
Documentation FeedbackYou can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.
You can send your comments in e-mail to [email protected].
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 SystemsAttn: Customer Document Ordering170 West Tasman DriveSan Jose, CA 95134-9883
We appreciate your comments.
Obtaining Technical AssistanceFor all customers, partners, resellers, and distributors who hold valid Cisco service contracts, the Cisco Technical Assistance Center (TAC) provides 24-hour, award-winning technical support services, online and over the phone. Cisco.com features the Cisco TAC website as an online starting point for technical assistance.
Cisco TAC WebsiteThe Cisco TAC website (http://www.cisco.com/tac) provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The Cisco TAC website is available 24 hours a day, 365 days a year.
Accessing all the tools on the Cisco TAC website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a login ID or password, register at this URL:
http://tools.cisco.com/RPF/register/register.do
Opening a TAC CaseThe online TAC Case Open Tool (http://www.cisco.com/tac/caseopen) is the fastest way to open P3 and P4 cases. (Your network is minimally impaired or you require product information). After you describe your situation, the TAC Case Open Tool automatically recommends resources for an immediate solution. If your issue is not resolved using these recommendations, your case will be assigned to a Cisco TAC engineer.
For P1 or P2 cases (your production network is down or severely degraded) or if you do not have Internet access, contact Cisco TAC by telephone. Cisco TAC engineers are assigned immediately to P1 and P2 cases to help keep your business operations running smoothly.
xviCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceObtaining Additional Publications and Information
To open a case by telephone, use one of the following numbers:
Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227) EMEA: +32 2 704 55 55 USA: 1 800 553-2447
For a complete listing of Cisco TAC contacts, go to this URL:
http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml
TAC Case Priority DefinitionsTo ensure that all cases are reported in a standard format, Cisco has established case priority definitions.
Priority 1 (P1)—Your network is “down” or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.
Priority 2 (P2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.
Priority 3 (P3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.
Priority 4 (P4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.
Obtaining Additional Publications and InformationInformation about Cisco products, technologies, and network solutions is available from various online and printed sources.
• The Cisco Product Catalog describes the networking products offered by Cisco Systems, as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:
http://www.cisco.com/en/US/products/products_catalog_links_launch.html
• Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:
http://www.ciscopress.com
• Packet magazine is the Cisco quarterly publication that provides the latest networking trends, technology breakthroughs, and Cisco products and solutions to help industry professionals get the most from their networking investment. Included are networking deployment and troubleshooting tips, configuration examples, customer case studies, tutorials and training, certification information, and links to numerous in-depth online resources. You can access Packet magazine at this URL:
http://www.cisco.com/go/packet
• iQ Magazine is the Cisco bimonthly publication that delivers the latest information about Internet business strategies for executives. You can access iQ Magazine at this URL:
http://www.cisco.com/go/iqmagazine
xviiCisco IOS Telephony Services Version 3.0 System Administrator Guide
PrefaceObtaining Additional Publications and Information
• 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/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html
• Training—Cisco offers world-class networking training. Current offerings in network training are listed at this URL:
http://www.cisco.com/en/US/learning/index.html
xviiiCisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 1
Cisco IOS Telephony Services OverviewCisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) is an optional feature in Cisco IOS software that enables Cisco routers to deliver key system or hybrid PBX functionality for enterprise branch offices or small businesses. Cisco IOS Telephony Services is ideal for customers who have data connectivity requirements and also have a need for a telephony solution in the same office. Whether offered through a service provider’s managed services offering or purchased directly by a corporation, Cisco IOS Telephony Services offers most of the core telephony features required in the small office, as well as many advanced features not available with traditional telephony solutions. Being able to deliver IP telephony and data routing using a single converged solution allows customers to optimize their operations and maintenance costs, resulting in a very cost-effective solution that meets office needs.
1-1Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services Overview
Feature Specifications
Feature HistoryRelease ITS Version Modification
12.1(5)YD Version 1.0 Cisco IOS Telephony Services was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
• Support for Cisco IP Phone 7910, Cisco IP Phone 7940, and Cisco IP Phone 7960
• Multiple lines per Cisco IP phone
• Multiple shared-line appearances across phones
• Call forwarding for all calls or for busy and no-answer conditions
• Call transfer
• Distinctive ringing for external and internal calls
• Dial-plan class of restriction (COR)
• Call hold and retrieve
• Call pickup of on-hold calls
• Caller identification display and blocking
• Function keys
• Speed dialing
• Cisco IP phones derive the date and time from the router through Network Time Protocol (NTP)
• Interworking with Cisco gatekeeper
• Analog Foreign Exchange Station (FXS) and Foreign Exchange Office (FXO) ports
• On-net calls using Voice over IP (VoIP) H.323, Voice over Frame Relay (VoFR), and Voice over ATM (VoATM)
1-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services Overview
12.2(2)XT Version 2.0 This service was implemented on the Cisco 1750 and Cisco 1751.
• Cisco IP Conference Station 7935 support
• Two-call support for Cisco IP Phone 7910
• Three-party conference (G.711 calls)
• Intercom for Cisco IP phones
• Paging for Cisco IP phones and for external system
• Call transfers across an H.323 network
• Music on hold (MOH)
• Graphical user interface (GUI) using a standard web browser
• Recent call history and activity display
• Call forwarding enhancements (huntstop)
• Digit manipulation using translation rules
• Enhancements to distinctive ringing for internal and external calls
• Cisco Unity voice-mail integration including message-waiting indication
• On-hold call timeout alert
• Session Initiation Protocol (SIP) unsolicited message-waiting notification support
• Local phone directory display and search on Cisco IP phone
• XML services support on Cisco IP phones
• Basic Telephony Application Programming Interface (TAPI)-aware PC application support
• Interactive voice response (IVR) and auto-attendant support using Tool Command Language (TCL)
12.2(8)T Version 2.0 This service was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 Version 2.0 This service was implemented on the Cisco 2600XM and Cisco 2691.
12.2(11)T Version 2.01 • This service was implemented on the Cisco 1760, and support for Cisco 1750 was removed.
• Support was added for an increased number of directory numbers or virtual voice ports on Cisco IP phones.
• Support was added for ATA-186.
• Support was added for top-line display description on the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
12.2(11)YT Version 2.1 • Consultative transfer using the ITU-T H.450.2 standard
• Call forwarding using the ITU-T H.450.3 standard
• Support for French, German, Italian, and Spanish languages for phone displays and call progress tones
• eXtensible Markup Language (XML) scripting for administrative customization
• Cisco IP Phone Expansion Module 7914
1-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services Overview
12.2(11)YT1 Version 2.1 The reset command was modified and the restart command was introduced to provide more options when IP phones are rebooted after configuration updates.
12.2(13)T Version 2.02 • This service was implemented on the Cisco Catalyst 4000 family, Cisco Catalyst 4224, and Cisco 3640A. Support was removed for the Cisco 2610, Cisco 2611, Cisco 2620, Cisco 2621, and Cisco 3620.
• Support was added for an increased number of directory numbers or virtual voice ports on Cisco IP phones. See Table 1-1 on page 1-8.
12.2(15)T Version 2.1 ITS Version 2.1 was integrated into Cisco IOS Release 12.2(15)T.
12.2(15)ZJ Version 3.0 This service was implemented on the Cisco 3640A and the Cisco IAD2430 series.
Support was added for the following features:
• ITS setup tool for quick installation
• Automatic assignment of free extension numbers to new IP phones
• Night service
• Call blocking (toll bar) based on time of day, day of week, or date
• Call blocking (toll bar) override
• Call pickup and call-pickup groups
• Hunt groups
• Secondary dial tone
• Three types of speed dial: speed-dial buttons, local speed-dial numbers common to all users, and personal speed-dial numbers that can be updated by an administrator or from the phone.
• Cisco IP Phone 7902G, Cisco IP Phone 7905G, Cisco IP Phone 7912G
• Account code entry
• Callback busy subscriber
• Do not disturb
• International date format, language, and call-progress tone support
• Call-forward-all soft key on Cisco IP phones
• Flash soft key for hookflash functionality for the PSTN
• Dual-line mode to support call waiting and other features
• Extension overlays for better call handling and distribution
• Fast-dial support
• ITS GUI enhancements
• Label support
• Busy lamp monitor and direct station select
• Phone directory entry
• Silent and feature ring options
12.2(15)ZJ1 Version 3.0.1 The name keyword was added to the clid strip command.
1-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewContents
Finding Support Information for Platforms and Cisco IOS Software Images
Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image support. Access Cisco Feature Navigator at http://www.cisco.com/go/fn. You must have an account on Cisco.com. If you do not have an account or have forgotten your username or password, click Cancel at the login dialog box and follow the instructions that appear.
Contents• Cisco IOS Telephony Services, page 1-5
• Prerequisites, page 1-8
• Restrictions, page 1-12
• Information About Setting Up an ITS System, page 1-13
• Before You Start: Basic ITS Concepts, page 1-15
• What to Do Next, page 1-24
• Additional References, page 1-24
Cisco IOS Telephony ServicesCisco IOS Telephony Services is a feature-rich entry-level IP telephony solution that is integrated directly into Cisco IOS software. Cisco IOS Telephony Services allows small business customers and autonomous small enterprise branch offices to deploy voice, data, and IP telephony on a single platform for small offices, thereby streamlining operations and lowering network costs.
Supported Platforms
Cisco 1751-V, Cisco 1760, Cisco 1760-V, Cisco 2610XM, Cisco 2611XM, Cisco 2620XM, Cisco 2621XM, Cisco 2650XM, Cisco 2651XM-V, Cisco 2691, Cisco 3640, Cisco 3640A, Cisco 3660, Cisco 3725, Cisco 3745, and Cisco IAD2430 series.
Note The Cisco IAD2420 series is not supported in Cisco IOS Release 12.2(15)ZJ.
Note For Cisco IOS Software Release 12.2(15)ZJ, the Cisco 1751 and Cisco 1760 images do not support the VIC-4FXS/DID, VIC2-2FXS, VIC2-2FXO, VIC2-4FXO, VIC2-2BRI-NT/TE, and WIC-1ADSL-I-DG cards.
Supported Cisco IP Phones and Phone Devices
Cisco IP Phone 7902G, Cisco IP Phone 7905G, Cisco IP Phone 7910, Cisco IP Phone 7912G, Cisco IP Phone Expansion Module 7914, Cisco IP Phone Conference Station 7935, Cisco IP Phone 7940G, Cisco IP Phone 7960G, Cisco ATA-186, Cisco ATA-188.
1-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewCisco IOS Telephony Services
Cisco IOS Telephony Services Network ScenariosFigure 1-1 shows a typical deployment of a Cisco IOS Telephony Services router with several Cisco IP phones connected to it. The Cisco IOS Telephony Services router is connected to the PSTN. The router can also connect to a gatekeeper and a RADIUS billing server in the same network.
Figure 1-1 Cisco IOS Telephony Services for the Small- and Medium-Size Office
IP IP IP
PSTN
Fax
Telephone Telephone
Cisco IP phones
RADIUSbillingserver
GatekeeperPCs
6214
2
Cisco ITS router
1-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewCisco IOS Telephony Services
Figure 1-2 shows a branch office with several Cisco IP phones connected to a Cisco IAD2430 series using Cisco IOS Telephony Services. The Cisco IAD2430 series is connected to a multiservice router at a service provider office. The multiservice router at the service provider office provides connection to the WAN and PSTN.
Figure 1-2 Cisco IOS Telephony Services for Service Providers
Additional Features
Provisioning
The router provides a mechanism to provision Cisco IOS Telephony Services, which allows you to perform the following functions:
• Assign directory (extension) numbers to the line appearances on each Cisco IP phone.
• Assign numbers to the speed-dial buttons on each Cisco IP phone.
• Assign caller identification information to each directory number.
• Assign directory numbers to phones other than Cisco IP phones attached to the system by using the standard voice-port and dial-peer configuration command-line interface (CLI).
• Provide dial-plan information to route calls to either PSTN lines or voice network connections.
For more information, see Chapter 3, “Setting Up Phones in an ITS System.”
Connecting Cisco IP Phones
Cisco IP phones can be connected to and disconnected from the Cisco IOS Telephony Services router without requiring a router reboot or manual status reset, a process sometimes called “hot-plugging.”
VIAD
IP IP IP
PSTNIP
network
Cisco IAD2430Serviceprovideroffice
Fax
Voiceswitch
Telephone Telephone
Cisco IP phones
Gatekeeper
T1/DSL/Cable
Voice mailserver
PCs
6214
5
1-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewPrerequisites
PrerequisitesPrerequisites for installing Cisco IOS Telephony Services Version 3.0 are grouped into the following categories:
• License Prerequisites, page 1-8
• Memory Prerequisites, page 1-8
• Network Prerequisites, page 1-9
• Software Prerequisites, page 1-9
License PrerequisitesYou must purchase a base feature license and phone seat licenses that entitle you to use Cisco IOS Telephony Services Version 3.0.
Memory PrerequisitesTable 1-1 lists the Cisco platforms, maximum number of Cisco IP phones, maximum number of directory numbers (ephone-dns) or virtual voice ports, and memory requirements for Cisco IOS Telephony Services Version 3.0.
Table 1-1 Specifications for ITS V3.0
Cisco Platform
Maximum Cisco IP Phones
Maximum Ephone-dns or Virtual Ports
Minimum DRAM
Recommended DRAM
Minimum Flash Memory
Recommended Flash Memory
Cisco 1751-V 24 120 64 MB 96 MB 32 MB 32 MB
Cisco 1760, Cisco 1760-V
24 120 64 MB 96 MB 32 MB 32 MB
Cisco 2600XM 24 120 96 MB 128 MB 32 MB 32 MB
Cisco 2650XM, Cisco 2651XM-V
48 192 96 MB 128 MB 32 MB 32 MB
Cisco 2691 48 288 128 MB 128 MB 32 MB 32 MB
Cisco 3640 48 288 96 MB 128 MB 32 MB 32 MB
Cisco 3640A 48 288 96 MB 128 MB 32 MB 32 MB
Cisco 3660 48 288 96 MB 128 MB 32 MB 32 MB
Cisco 3725 48 288 128 MB 128 MB 32 MB 32 MB
Cisco 3745 48 288 128 MB 128 MB 32 MB 32 MB
Cisco IAD2430 24 120 64 MB 96 MB 32 MB 32 MB
1-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewPrerequisites
Network Prerequisites• IP routing must be enabled.
• VoIP networking must be operational. For quality and security purposes, it is recommended to have separate virtual LANs (VLANs) for data and voice. The IP network assigned to each VLAN should be large enough to support addresses for all nodes on that VLAN. Cisco IOS Telephony Services phones receive their IP addresses from the voice network, whereas all other nodes such as PCs, servers, and printers receive their IP addresses from the data network.
• The network must be configured for Dynamic Host Configuration Protocol (DHCP). A DHCP server for Cisco IOS Telephony Services phones is designated during ITS setup. For more information, see the “Setting Up DHCP Service for ITS” section in Chapter 2, “Setting Up an ITS System.”
Software PrerequisitesTo use Cisco IOS Telephony Services Version 3.0, you need to download Cisco IOS software and Cisco IOS Telephony Services Version 3.0 files, which are available through the Cisco Software Center. The files that you need and the URLs where they can be obtained are described in the following sections:
• Cisco IOS Software
• Cisco IOS Telephony Services Version 3.0 Files
Cisco IOS Software
• Download and install the Cisco IOS Release 12.2(15)ZJ IP Plus image from the Cisco Software Center.
• Cisco IOS Telephony Services Version 3.0 requires a minimum IP Plus image on the Cisco 2600, Cisco 3600, and Cisco 3700 series, and a VOX PLUS image on the Cisco 1751 and Cisco 1760 series.
Cisco IOS Telephony Services Version 3.0 Files
For Cisco IOS Telephony Services Version 3.0, certain files must be downloaded and installed in the ITS router Flash memory. The process and files are discussed in the following sections:
• How to Download and Install Cisco ITS V3.0 Files, page 1-9
• List of Individual Cisco IOS Telephony Services Version 3.0 Files, page 1-10
How to Download and Install Cisco ITS V3.0 Files
Install Cisco IOS Telephony Services Version 3.0 files from the Cisco Software Center using one of the following methods:
• Zipped, Compressed Archive
• Tar Archives
1-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewPrerequisites
Zipped, Compressed Archive
The zipped, compressed archive contains all the Cisco IOS Telephony Services Version 3.0 files in a single archive file. To install files from this archive, follow these steps:
1. Download the file called its-3.0.0.zip from http://www.cisco.com/cgi-bin/tablebuild.pl/ip-key.
2. Uncompress its-3.0.0.zip using the WinZip program. Note that one of the resulting files is its-gui.3.0.0.zip, which also needs to be uncompressed.
3. Copy each of the resulting files except phone firmware files and CiscoIOSTSP.zip to router Flash memory. For phone firmware files, copy only the firmware files for phone types that you have at your site. For CiscoIOSTSP.zip, refer to the installation instructions in the “Cisco IOS TSP Download and Setup” section in Chapter 14, “Configuring Productivity Tools.”
Tar Archives
At the Cisco Software Center, two tar files contain the basic ITS system files and the basic ITS GUI files. A Cisco IOS command allows you to uncompress the tar files and copy them to router Flash at the same time. The tar files do not contain the bundled TSP file (CiscoIOSTSP.zip), but you can download that separately. To install files from the ITS V3.0 tar archives, use the following steps:
1. Download the following tar archives from http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp to a TFTP server that is accessible to the ITS router:
• its-basic-3.0.1.tar—Contains basic ITS system files including GUI, MOH, and phone firmware for Cisco IOS Release 12.2(15)ZJ1.
• its-gui-3.0.1.tar—Contains the ITS GUI files and the XML template file for Cisco IOS Release 12.2(15)ZJ1.
2. Uncompress and copy each archive to router Flash memory using the following command:
• archive tar /xtract source-url flash:/file-url
For example, to extract contents of its-basic-3.0.1.tar from TFTP server 192.168.1.1 to router Flash memory, use this command:
archive tar /xtract tftp://192.168.1.1/its-basic-3.0.1.tar flash:
Note The file called CiscoIOSTSP.zip is not included in either of the tar archives. To install TSP files, download the CiscoIOSTSP.zip file separately and follow the installation instructions in the “Cisco IOS TSP Download and Setup” section in Chapter 14, “Configuring Productivity Tools.”
List of Individual Cisco IOS Telephony Services Version 3.0 Files
This section contains a comprehensive list of all the files that are used with ITS V3.0. All the files listed in this section are included in the zipped, compressed archive called its-3.0.0.zip that can be downloaded from the Cisco Software Center. The files are grouped into the following categories:
• Phone Firmware Files
• GUI Files
• XML Template
• Music-on-hold (MOH) File
• Bundled TSP Archive
1-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewPrerequisites
Phone Firmware Files
Table 1-2 lists the firmware file for each phone type. Install only the firmware files for the types of phones that you have at your site.
Firmware files can be downloaded individually or in a compressed archive (its-3.0.0.zip or its-basic-3.0.1.tar). To install files individually, download the files that you need from http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp to a TFTP server. Then, copy the files to Flash memory on the ITS router.
To install firmware files from an archive, see the “How to Download and Install Cisco ITS V3.0 Files” section on page 1-9.
GUI Files
Table 1-3 lists the files that support web-browser GUIs for users and administrators. These files are included in the zipped, compressed archive called its-gui-3.0.0.zip and also in the tar archive called its-gui-3.0.1.tar. To install the files, see the “How to Download and Install Cisco ITS V3.0 Files” section on page 1-9.
XML Template
The file called xml.template can be copied and modified to allow or restrict specific GUI functions to customer administrators, who are a new class of administrative users with limited capabilities in an ITS system. This file is included in the zipped, compressed archive called its-3.0.0.zip and also in both tar archives (its-basic-3.0.0.tar and its-gui-3.0.0.tar). To install the file, see the “How to Download and Install Cisco ITS V3.0 Files” section on page 1-9.
Table 1-2 Phone Firmware Files
Phone Type Firmware Filename
Cisco IP Phone 7902G CP79020101SCCP030326A.zup
Cisco IP Phone 7905G CP79050101SCCP030404A.zup
Cisco IP Phone 7910 P00403020214.bin
Cisco IP Phone 7912G CP79120101SCCP030404A.zup
Cisco IP Expansion Module 7914 S00103020002.bin
Cisco IP Conference Station 7935 P00503010100.bin
Cisco IP Phone 7940G and Cisco IP Phone 7960G P00303020214.bin
Cisco ATA-186 and Cisco ATA-188 ATA:ata18x-v2-16-ms-030327b.zup
Table 1-3 GUI Files
admin_user.html dom.js normal_user.html Tab.gif
admin_user.js downarrow.gif normal_user.js telephony_service.html
CiscoLogo.gif ephone_admin.html Plus.gif uparrow.gif
Delete.gif logohome.gif sxiconad.gif xml-test.html
1-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewRestrictions
Music-on-hold (MOH) File
An audio file named music-on-hold.au provides music for external callers on hold when a live feed is not used.This file is included in the zipped, compressed archive called its-3.0.0.zip and also in the tar archive called its-basic-3.0.0.tar. To install the file, see the “How to Download and Install Cisco ITS V3.0 Files” section on page 1-9.
Bundled TSP Archive
An archive called CiscoIOSTSP.zip contains several Telephony Application Programming Interface (TAPI) Telephony Service Provider (TSP) files that are needed to set up individual PCs for Cisco IP phone users who wish to make use of ITS-TAPI integration with TAPI-capable PC software. This archive is included in the zipped, compressed archive called its-3.0.0.zip and is also available as an individual archive at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp. To install the files, see the “Cisco IOS TSP Download and Setup” section in Chapter 14, “Configuring Productivity Tools.”
Restrictions• For Cisco IOS Software Release 12.2(15)ZJ, the Cisco 1751 and Cisco 1760 images do not support
the VIC-4FXS/DID and WIC-1ADSL-I-DG cards.
• The only codecs supported are G.711 and G.729. For conferencing, only G.711 is supported.
• IP phones connected to Cisco ITS systems require the use of out-of-band dual-tone multifrequency (DTMF) relay to transport DTMF (keypad) digits across VoIP connections. For more information, see the “DTMF Relay” section in Chapter 3, “Setting Up Phones in an ITS System.”
• The Cisco 1750 and Cisco 1751 do not support quality of service (QoS) features on the asymmetric digital subscriber line (ADSL) link.
• Session Initiation Protocol (SIP) and Media Gateway Control Protocol (MGCP) on-net calls are not supported.
• First-generation Cisco IP phones, such as the Cisco IP Phone 30 VIP and the Cisco IP Phone 12 SP+, are not supported.
• No more Cisco IP phones or directory numbers than the maximum specified in the “Memory Prerequisites” section on page 1-8 are supported.
• Only the platforms and phone devices listed in the table in the “Feature Specifications” section on page 1-2 are supported.
• Element Management System (EMS) integration is not supported.
• Cisco Voice Manager (CVM) support of IP phone configuration is not supported.
• Restrictions for call transfer are listed in Chapter 4, “Configuring Call Transfer.”
• Telephony Application Programming Interface (TAPI) Version 2.1 is not supported. Cisco IOS Telephony Services implements only a small subset of TAPI functionality. It does support operation of multiple independent clients (for example, one client per phone line) but not full support for multiple-user or multiple-call handling, which is required for complex features such as automatic call distribution (ACD) and IP contact center (IPCC). Also, this TAPI version does not have direct media- and voice-handling capabilities.
1-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewInformation About Setting Up an ITS System
Information About Setting Up an ITS SystemThe complete set of tasks necessary to install and configure a Cisco IOS Telephony Services system varies according to the design of a particular system, but the tasks fall into the major categories listed in Table 1-4 on page 1-13.
You can choose to perform the basic initial setup of the ITS system and ITS phones (Tasks 2 and 3 in Table 1-4) in any of the following three ways:
• Automatically, using the ITS setup tool—With this method, you engage an interactive script from the router CLI. The script queries you for the ITS system parameters you need and then builds the required configuration files. This method automatically identifies the DHCP server and the IP address of the ITS router to the ITS system. It also automatically assigns one extension number to each newly registering IP phone. With this method, you do not need to manually perform most of the steps in Chapter 2 and 3. For more information, see Table 1-4 on page 1-13 and the “Automated Phone Setup Using the ITS Setup Tool” section in Chapter 3, “Setting Up Phones in an ITS System.”
• Semiautomatically, using the auto assign command—With this method, you perform the steps in Task 2 using router CLI and then use the auto assign command to automatically assign one extension number to each newly registering IP phone. For more information, see the “Partially Automated Phone Setup Using Router CLI” section in Chapter 3, “Setting Up Phones in an ITS System.”
• Manually—With this method, you perform Tasks 2 and 3 using Cisco IOS software CLI on the ITS router. This method allows you to make nondefault settings and to assign multiple numbers and lines to phones. For more information on using router CLI for basic ITS setup, see Chapter 2, “Setting Up an ITS System,” and Chapter 3, “Setting Up Phones in an ITS System.”
Table 1-4 ITS Installation Sequence
Task Purpose How the Task Is Performed Where the Task Is Described
1. Planning the system and assembling prerequisites
• Understand design criteria for your ITS system
• Download required software to ITS router Flash memory
Manually, by reviewing your requirements and by using Cisco IOS software CLI to download and install the appropriate files
Chapter 1, “Cisco IOS Telephony Services Overview”
2. Setting up an ITS system to communicate with your network
• Set up a DHCP server for ITS
• Set up Network Time Protocol (NTP) on the ITS router
• Specify the IP source address for the ITS router and create a configuration file
• (Optional) Specify a nondefault keepalive interval
• Install phone firmware on the ITS router
Automatically with ITS setup tool or manually with Cisco IOS software CLI:
• DHCP server
• IP source address
• Phone firmware
Manually with Cisco IOS software CLI:
• NTP
• (Optional) Keepalive
Chapter 2, “Setting Up an ITS System”
1-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewInformation About Setting Up an ITS System
3. Setting up the basic required ITS phone configurations
• Set maximum number of ephone-dns and ephones
• Set range to autoassign numbers to newly registering phones
• Define ephone-dns
• Define ephones and assign ephone-dns to ephone buttons
• Set voice-mail number and no-answer timeout
• Set Direct Inward Dialing (DID) capability and dial-plan pattern
• Specify type of DTMF relay
• Set the date format and language for displays and set the locale for tones
• Define translation rules
• Restart or reset phones
Automatically with ITS setup tool or manually with Cisco IOS software CLI:
• Maximum number of ephone-dns and ephones
• (Optional) Range of numbers to autoassign to phones
• Ephones and ephone-dns with default settings
• (Optional) Date format, language for display, and locale for tones
• (Optional) DID and dial-plan pattern
• (Optional) Voice-mail number and no-answer timeout
• Phone restart or reset
Manually with Cisco IOS software CLI:
• Ephones and ephone-dns with nondefault settings
• DTMF relay
• (Optional) Translation rules
Chapter 3, “Setting Up Phones in an ITS System”
4. Configuring call transfer and forwarding
• Set up call transfer parameters
• Define call forwarding conditions and numbers
Manually with Cisco IOS software CLI
Chapter 4, “Configuring Call Transfer”Chapter 5, “Configuring Call Forwarding”
Table 1-4 ITS Installation Sequence (continued)
Task Purpose How the Task Is Performed Where the Task Is Described
1-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
Before You Start: Basic ITS ConceptsCisco IOS Telephony Services systems are infinitely flexible because they are modular. An ITS system consists of a router that serves as a gateway and one or more VLANS that connect IP phones and phone devices to the router. In addition, an ITS system uses the following basic building blocks:
• Ephone—A software construct that usually represents a physical telephone instrument, although it is also used to represent a port that connects to a voice-mail system. The ephone construct provides the ability to configure the physical instrument using Cisco IOS software. Each ephone can have multiple extensions associated with it in a many-to-many relationship, and a single extension can be associated with multiple ephones so that it appears as a shared extension. The maximum number of ephones in an ITS system is the maximum number of physical instruments that can be connected to the system.
• Ephone-dn—A software construct that represents the line that connects a voice channel to a phone instrument where a user can receive and make calls. An ephone-dn represents a virtual voice port in the ITS system, so the maximum number of ephone-dns in an ITS system is the maximum number of simultaneous call connections that can occur. Note that this concept is different than the maximum number of physical lines in a traditional telephony system and also is different than the maximum number of telephone or extension numbers that can be assigned.
Traditional telephony systems are based on physical connections and are therefore limited as to the types of phone service that they can offer. Because the ephone and ephone-dn are software constructs and because the audio stream is packet-based, an almost limitless number of combinations of phone numbers, lines, and phones can be planned and implemented.
5. Setting up the ITS GUI • Enable an HTTP server and set the HTTP path
• Create a system administrator GUI account
• (Optional) Create a customer administrator GUI account
• (Optional) Create phone user GUI accounts
Manually with Cisco IOS software CLI
• HTTP server and path
• System administrator GUI account
Graphically with ITS GUI or manually with CLI:
• (Optional) Customer administrator GUI account
• (Optional) Phone user GUI accounts
Chapter 6, “Setting Up the ITS GUI”
6. Configuring optional system and phone features
Set up and enable such optional features as secondary dial tone, music on hold, call blocking, caller-ID blocking, speed dial, feature or silent ringing, night service, paging, intercom, call pickup, and more.
Graphically with ITS GUI or
Manually with Cisco IOS software CLI
Chapters 7 through 14
Table 1-4 ITS Installation Sequence (continued)
Task Purpose How the Task Is Performed Where the Task Is Described
1-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
Cisco ITS systems can be designed in many ways. The key is to determine how many simultaneous calls you want to handle at your site and at each phone at your site, how many different numbers you want to have, and how many phones you want to have. Even an ITS system has its limits, however. The following factors should be considered in your system design:
• Maximum number of ephone-dns—As noted in Table 1-1 on page 1-8, there is a maximum number of ephone-dns per system. This number corresponds to the maximum number of simultaneous call connections that can occur.
• Maximum number of telephone numbers—Your numbering plan may restrict the range of telephone numbers or extension numbers that you can use. For example, if you have DID, the PSTN may assign you a certain series of numbers.
• Maximum number of buttons per phone—You may be limited by the number of buttons and phones that your site can use. For example, you may have two people with six-button phones to answer twenty different telephone numbers.
The flexibility of an ITS system is largely due to the different types of ephone-dns that you can assign to phones in your system. By understanding the types of ephone-dns and considering how they can be combined, you can create the complete call coverage situation that your business requires. For more information about types of ephone-dns, see the “Ephone-dns” section on page 1-16.
After setting up the ephone-dns and ephones that you need, you add optional ITS features to create a telephony environment that enhances your business objectives. Cisco ITS systems are able to integrate with the PSTN and with your business requirements to allow you to continue using your existing number plans, dialing schemes, and call coverage patterns. The following sections explain concepts that will help you to design and configure Cisco ITS systems.
• Ephones, page 1-16
• Ephone-dns, page 1-16
• Phone Number Plan, page 1-22
• Direct Inward Dialing, page 1-23
• PBX or Keyswitch Model, page 1-24
EphonesAn ephone, or “Ethernet phone,” is a single instance of the software configuration of the physical instrument with which a phone user makes and receives calls in an ITS system. The physical ephone is either a Cisco IP phone or an analog phone equipped with an analog telephone adaptor (ATA) device.
Each ephone has a unique phone-tag, or sequence number, to identify it during configuration.
An ephone is populated with ephone-dns and features by the ephone command, which associates the MAC address of a physical phone with the telephone numbers associated with ephone-dns and with other ITS features.
Ephone-dnsAn ephone-dn, or “Ethernet phone directory number,” is a software construct that represents the line that connects a voice channel to a phone instrument where a user can receive and make calls. An ephone-dn has one or more extension or telephone numbers associated with it to allow call connections to be made.
1-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
An ephone-dn is equivalent to a phone line in most cases, but not always. There are several types of ephone-dns, which have different characteristics. As indicated in Table 1-1 on page 1-8, there is a maximum number of ephone-dns available in an ITS system.
Each ephone-dn has a unique dn-tag, or sequence number, to identify it during configuration. Ephone-dns are assigned to line buttons on ephones during configuration.
An ephone-dn is created by the ephone-dn command, which builds one virtual voice port and one or more dial peers for the ephone-dn, depending on your dial-plan pattern and the ephone-dn secondary number field. The ephone-dn command automates the process of associating dial peers to an ephone-dn’s virtual voice port and manages the numbering and configuring of virtual voice ports. Dial peers that are created by the ephone-dn command can be reviewed using the show telephony-service dial-peer command.
The number of ephone-dns that you create corresponds to the number of simultaneous calls that you can have, because each ephone-dn is a virtual voice port in the router. This means that if you want more than one call to the same number to be answered simultaneously, you need multiple virtual voice ports (ephone-dns) with the same destination pattern (extension or telephone number).
The ephone-dn is the basic building block of an ITS system. Six different types of ephone-dn can be combined in different ways for different call coverage situations. Each type will help with a particular type of limitation or call coverage need. For example, if you want to keep the number of ephone-dns low and provide service to a large number of people, you might use shared ephone-dns. Or if you have a limited number of extension numbers that you can use but need to have a large number of simultaneous calls, you might create two or more ephone-dns with the same number. The key is knowing how each type of ephone-dn works and what its advantages are.
The following sections will help you understand the types of ephone-dn in an ITS system:
• Single-Line Ephone-dn
• Dual-Line Ephone-dn
• Two Ephone-dns with One Number
• Dual-Number Ephone-dn
• Shared Ephone-dn
• Overlay Ephone-dn
Single-Line Ephone-dn
A single-line ephone-dn has the following characteristics:
• Makes one call connection at a time using one phone line button. A single-line ephone-dn has one telephone number associated with it.
• Should be used when phone buttons have a one-to-one correspondence to the PSTN lines that come into an ITS system.
• Should be used for lines that are dedicated to intercom, paging, message-waiting indicator (MWI), loopback, and music-on-hold (MOH) feed sources.
• When used with multiple-line features like call waiting, call transfer, and conferencing, there must be more than one single-line ephone-dn on a phone.
• Can be combined with dual-line ephone-dns on the same phone.
Note that you must make the choice to configure each ephone-dn in your system as either dual-line or single-line when you initially create ephone-dn configuration entries. If you need to change from single-line to dual-line later, you must delete the ephone-dn and then recreate it.
1-17Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
Figure 1-3 shows a single-line ephone-dn.
Figure 1-3 Single-Line Ephone-dn
Dual-Line Ephone-dn
A dual-line ephone-dn has the following characteristics:
• Can make two call connections at the same time using one phone line button. A dual-line ephone-dn has two channels for separate call connections.
• Can have one number or two numbers (primary and secondary) associated with it.
• Should be used for lines that handle call waiting, call transfer, or conferencing using a single button.
• Cannot be used for lines that are dedicated to intercom, paging, message-waiting indicator (MWI), loopback, and music-on-hold (MOH) feed sources.
• Can be combined with single-line ephone-dns on the same phone.
Note that you must make the choice to configure each ephone-dn in your system as either dual-line or single-line when you initially create ephone-dn configuration entries. If you need to change from single-line to dual-line later, you must delete the ephone-dn and then recreate it.
Figure 1-4 shows a dual-line ephone-dn.
Figure 1-4 Dual-Line Ephone-dn
Two Ephone-dns with One Number
Two ephone-dns with one number have the following characteristics:
• Have the same telephone number but two separate virtual voice ports, and therefore can have two separate call connections.
• Can be single-line or dual-line ephone-dns.
• Can appear on the same phone on different buttons or on different phones.
• Should be used when you want the ability to make more call connections while using fewer numbers.
Figure 1-5 shows a phone with two buttons that have the same number, extension 1003. Each button has a different ephone-dn (button 1 is ephone-dn 13 and button 2 is ephone-dn 14), so each button can make one independent call connection if the ephone-dns are single-line and two call connections (for a total of four) if the ephone-dns are dual-line.
VIP
8888
8
Phone 1Button 1 is extension 1001
ephone-dn 11 number 1001
ephone 1 button 1:11
VIP
8888
9
Phone 2Button 1 is extension 1002
ephone-dn 12 dual-line number 1002
ephone 2 button 1:12
1-18Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
Figure 1-6 shows two phones that each have a button with the same number. Because the buttons have different ephone-dns, the calls that are connected on these buttons are independent of one another. The phone user at phone 4 can make a call on extension 1004, and the phone user on phone 5 can receive a different call on extension 1004 at the same time.
The two ephone-dns-with-one-number situation is different than a shared line, which also has two buttons with one number but has only one ephone-dn for both of them. A shared ephone-dn will have the same call connection at all the buttons on which the shared ephone-dn appears. If a call on a shared ephone-dn is answered on one phone and then placed on hold, the call can be retrieved from the second phone on which the shared ephone-dn appears. But when there are two ephone-dns with one number, a call connection appears only on the phone and button at which the call is made or received. In the example in Figure 1-6, if the user at phone 4 makes a call on button 1 and puts it on hold, the call can be retrieved only from phone 4. For more information about shared lines, see the “Shared Ephone-dn” section on page 1-20.
The examples in Figure 1-5 and Figure 1-6 show how two ephone-dns with one number are used to provide a small hunt group capability. If the ephone-dn on button 1 is busy or does not answer, an incoming call to extension 1003 rolls over to the ephone-dn associated with button 2 because the preference and no huntstop commands have been used. Values assigned in the preference command are passed to the dial peers created by the two ephone-dns. Both dial peers for the ephone-dns are matched when this extension number is dialed. The call is connected to the ephone-dn with the highest preference. The default preference value is 0 (the highest value), so ephone-dn 13 on button 1 gets the first call. The no huntstop command tells the dial peers not to stop hunting for another match, so the second call to extension 1003 is sent to ephone-dn 14.
Figure 1-5 Two Ephone-dns with One Number on One Phone
Figure 1-6 Two Ephone-dns with One Number on Two Phones
VIP
8889
1
Phone 3Button 1 is extension 1003
Button 2 is also extension 1003
ephone-dn 13 number 1003 no huntstop
ephone-dn 14 number 1003 preference 1
ephone 3 button 1:13 2:14
VIP
IP
8889
2
Phone 5Button 1 is extension 1003
Phone 4Button 1 is extension 1003
ephone-dn 13 number 1003 no huntstop
ephone-dn 14 number 1003 preference 1
ephone 4 button 1:13
ephone 5 button 1:14
1-19Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
Dual-Number Ephone-dn
A dual-number ephone-dn has the following characteristics:
• Has two telephone numbers, a primary number and a secondary number.
• Can make one call connection if it is a single-line ephone-dn.
• Can make two call connections at a time if it is a dual-line ephone-dn.
• Should be used when you want to have two different numbers for the same button without using more than one ephone-dn.
Figure 1-7 shows an ephone-dn that has two numbers, extension 1006 and extension 1007.
Figure 1-7 Dual-Number Ephone-dn
Shared Ephone-dn
A shared ephone-dn has the following characteristics:
• Appears on two different phones but uses the same ephone-dn and number.
• Can make one call at a time between the two phones, and that call appears on both phones.
• Should be used when you want the capability to answer or pick up a call at more than one phone.
Because these phones share the same ephone-dn, if the ephone-dn is connected to a call on one phone, that ephone-dn is unavailable for other calls on the second phone. If a call is placed on hold on one phone, it can be retrieved on the second phone. This is like having a single-line phone in your house with multiple extensions. You can answer the call from any phone on which the number appears, and you can pick it up from hold on any phone on which the number appears.
Figure 1-8 shows a shared ephone-dn. Extension 1008 appears on both phone 7 and phone 8.
Figure 1-8 Shared Ephone-dn
VIP
8889
0
Phone 6Button 1 is extension 1006
Button 1 is also extension 1007
ephone-dn 15 number 1006 secondary 1007
ephone 6 button 1:15
VIP
IP
8889
3Phone 8Button 1 is extension 1008
Phone 7Button 1 is extension 1008
ephone-dn 16 number 1008
ephone 7 button 1:16
ephone 8 button 1:16
1-20Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
Overlay Ephone-dn
An overlay ephone-dn has the following characteristics:
• Is a member of an overlay set, which includes all the ephone-dns that have been assigned together to a particular phone button.
• Can have the same telephone or extension number as other members of the overlay set or different numbers.
• Can be single-line or dual-line, but cannot be mixed single-line and dual-line in the same overlay set.
• Can be shared on more than one phone.
Overlay ephone-dns provide call coverage similar to shared ephone-dns because the same number can appear on more than one phone. The advantage of using two ephone-dns in an overlay arrangement rather than as simple shared ephone-dns is that a call to the number on one phone does not block the use of the same number on the other phone as would happen if this was a shared ephone-dn.
You can overlay up to ten lines on a single button and create a “10x10” shared line with ten lines in an overlay set shared by ten phones, resulting in the possibility of ten simultaneous calls to the same number.
Figure 1-9 shows an overlay set with two ephone-dns and one number that is shared on two phones. Ephone-dn 17 has the default preference value of 0, so it will receive the first call to extension 1001. The phone user at phone 9 answers the call, and a second incoming call to extension 1001 can be answered on phone 10 using ephone-dn 18.
Figure 1-9 Overlay Ephone-dn (Simple Case)
A more complex ephone-dn configuration mixes overlay ephone-dns with shared ephone-dns and plain dual-line ephone-dns on the same phones. Figure 1-10 illustrates the following example of a manager with two assistants. On the manager’s phone the same number, 2001, appears on button 1 and button 2. The two line appearances of extension 2001 use two single-line ephone-dns, so the manager can have two active calls on this number simultaneously, one on each button. The ephone-dns are set up so that button 1 will ring first, and if a second call comes in, button 2 will ring. Each assistant has a personal ephone-dn and also shares the manager’s ephone-dns. Assistant 1 has all three ephone-dns in an overlay set on one button, whereas assistant 2 has one button for the private line and a second button with both of the manager’s lines in an overlay set. A sequence of calls might be as follows.
1. An incoming call is answered by the manager on extension 2001 on button 1 (ephone-dn 20).
2. A second call rings on 2001 and rolls over to the second button on the manager’s phone (ephone-dn 21). It also rings on both assistants’ phones (also ephone-dn 21, a shared ephone-dn).
VIP
IP
8889
4Phone 10Button 1 is two appearances
of extension 1001
Phone 9Button 1 is two appearances
of extension 1001
ephone-dn 17 number 1001
ephone-dn 18 number 1001 preference 1
ephone 9 button 1o17,18
ephone 10 button 1o17,18
1-21Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
3. Assistant 2 answers the call. This is a shared overlay line (one ephone-dn, 21, is shared among three phones, and on two of them this ephone-dn is part of an overlay set). Because it is shared with button 2 on the manager’s phone, the manager can see when assistant 2 answers the call.
4. Assistant 1 makes an outgoing call on ephone-dn 22. The button is available because of the additional ephone-dns in the overlay set on the assistant 1 phone.
At this point, the manager is in conversation on ephone-dn 20, assistant 1 is in conversation on ephone-dn 22, and assistant 2 is in conversation on ephone-dn 21.
Figure 1-10 Overlay Ephone-dn (Complex Case)
Phone Number PlanIf you are installing an ITS system to replace an older telephony system that had an established telephone number plan, you can retain the old number plan. ITS supports flexible extension number lengths and can provide automatic conversion between extension dialing and E.164 public telephone number dialing.
A successful ITS system requires a telephone numbering plan that supports future expansion. The numbering plan also must not overlap or conflict with other numbers that are on the same VoIP network or are part of a centralized voice mail system.
ITS supports shared lines as well as multiple lines configured with the same extension number. This means that you can set up several phones to share an extension number to provide coverage for that number. You can also assign several line buttons on a single phone to the same extension number to create a small hunt group. For more information about types of line configurations, see the “Ephone-dns” section on page 1-16.
VIP
IP
8889
5
Assistant 1 phoneButton 1 is extension 2001
and extension 2002
IP
Assistant 2 phoneButton 1 is extension 2003Button 2 is extension 2001
Manager phoneButton 1 is extension 2001Button 2 is extension 2001
ephone-dn 20 number 2001 no huntstop! Manager number
ephone-dn 21 number 2001 preference 1! Manager number
ephone-dn 22 number 2002! Assistant 1 personal number
ephone-dn 23 number 2003! Assistant 2 personal number
ephone 8 button 1:20 2:21! Manager phone
ephone 9 button 1o22,20,21! Assistant 1 phone
ephone 10 button 1:23 2o20,21! Assistant 2 phone
1-22Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewBefore You Start: Basic ITS Concepts
If you are configuring more than one ITS site, you need to decide how calls between the sites will be handled. Inter-ITS calls can be routed either through the PSTN or over VoIP. If you are routing calls over VoIP, you must decide among the following three choices:
• You can route calls using a global pool of fixed-length extension numbers. For example, all sites have unique extension numbers in the range 5000 to 5999, and routing is managed by a gatekeeper. If you select this method, you should assign a subrange of extension numbers to each site so that duplicate number assignment does not result. You will have to keep careful records of which ITS system is assigned which number range.
• You can route calls using a local extension number plus a per-ITS site prefix. This choice allows you to use the same extension numbers at more than one site.
• You can use an E.164 PSTN phone number to route calls over VoIP between ITS sites. In this case, intersite callers use the PSTN area code and local prefix to route calls between ITS systems.
If you choose to have a gatekeeper route calls among multiple ITS systems, you may face additional restrictions on the extension number formats that you use. For example, you might be able to register only PSTN-formatted numbers with the gatekeeper. The gatekeeper might not allow the registration of duplicate telephone numbers in different ITS systems, but you might be able to overcome this limitation. ITS allows the selective registration of either 2- to 5-digit extension numbers or 7- to 10-digit PSTN numbers, so registering only PSTN numbers might prevent the gatekeeper from sensing duplicate extensions.
To properly configure your ITS system to handle intersite ITS direct calls, call forwarding, and call transfers, make sure that you understand and configure the dialplan-pattern command, which is described in Chapter 3, “Setting Up Phones in an ITS System.”
In addition, your selection of a numbering scheme for phones that can be directly dialed from the PSTN is limited by your need to use the range of extensions that are assigned to you by the telephone company that provides your connection to the PSTN. For example, if your telephone company assigns you a range from 408-555-0100 to 408-555-0199, you may assign extension numbers only in the range 100 to 199 if those extensions are going to have Direct Inward Dialing (DID) access. For more information about DID, see the “Direct Inward Dialing” section on page 1-23.
Also note that the mapping of public telephone numbers to internal extension numbers is not restricted to simple truncation of the digit string. Digit substitutions can be made using the extension-pattern keyword in the dialplan-pattern command. For more information, see the “Dial-Plan Pattern” section in Chapter 3, “Setting Up Phones in an ITS System.”
Direct Inward DialingWhen you define an ephone-dn (extension number instance) using the ephone-dn command, the ITS system automatically creates a POTS dial peer with the ephone-dn endpoint as a destination. The default behavior is for the ITS system to create a single POTS dial peer for each ephone-dn. If the dialplan-pattern command is set and matches against the ephone-dn number, two POTS dial peers are created, one for the local extension and one for the complete E.164 direct-dial telephone number. For example, an ephone-dn extension number is 1234, and the dial-plan pattern is “dialplan-pattern 1 4085551... extension-length 4.” One POTS dial peer is created for “1234” and a second POTS dial peer is created for “4085551234.” A third POTS dial peer is created if an ephone-dn secondary number is defined, and a fourth dial peer is created for this number if the secondary number also matches a dial-plan pattern. When the PSTN connects a DID call for “4085551234” to the ITS system, it also forwards the extension digits “1234” to allow the ITS system to route the call. Dial peers that are created by the ephone-dn command can be reviewed using the show telephony-service dial-peer command. For more information, refer to the “Configuring Dial Plans, Dial Peers, and Digit Manipulation” chapter in the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2.
1-23Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewWhat to Do Next
PBX or Keyswitch ModelWhen setting up an ITS system, you need to decide if call handling should be similar to that of a PBX, similar to that of a keyswitch, or a hybrid of both. ITS provides a significant amount of flexibility in this area, but requires that you have a clear understanding of the usage model that you choose.
The simplest case is the PBX model, in which most of the IP phones in your system have a single unique extension number. For this model, it is recommended that you configure ephone-dn entries to use the dual-line configuration option. With this setting, each button that appears on an IP phone can handle two concurrent calls. The phone user toggles between calls using the blue navigation button on the phone. Dual-line ephone-dn entries enable your configuration to support call waiting, call transfer with consultation, and three-party conferencing (G.711 only). If you assign strictly sequential extension numbers to newly registering IP phones, the ITS setup tool can assist you in creating a PBX-style configuration automatically.
In a keyswitch type of system, you can set up most of your phones to have a nearly identical configuration, in which each phone is able to answer any incoming PSTN call on any line. For example, you have four incoming PSTN lines that each appear as shared lines on four different phones. Each phone has the same shared lines. You configure this model by creating a set of ephone-dn entries that correspond one-to-one with your PSTN lines. Then you configure your PSTN ports to route incoming calls to the ephone-dns. The maximum number of PSTN lines that you can assign in this model might be limited by the number of available buttons on your IP phones. If so, the ephone-dn overlay option may be useful for extending the number of lines that can be accessed by a phone.
In the keyswitch model, the same ephone-dn entries are assigned to all IP phones. This means that when an incoming call arrives, it rings all available IP phones. When multiple calls are present within the system at the same time, each individual call (ringing or waiting on hold) is visible and can be directly selected by pressing the corresponding line button on an IP phone. In this model, calls can be moved between phones simply by putting the call on hold at one phone and selecting the call using the line button on another phone. In a keyswitch usage model, it is often not appropriate to use the ephone-dn dual-line option because the PSTN lines with which the ephone-dn entries correspond do not themselves support dual-line configuration. Use of the dual-line option also makes configuration of call-coverage (hunting) behaviors more complex.
You can mix PBX and keyswitch configurations on the same IP phone and include both unique per-phone extensions for PBX-style calling and shared lines for keyswitch-style call operations. You can also combine single-line and dual-line ephone-dns on the same phone.
What to Do NextAfter downloading Cisco IOS software and Cisco ITS software, you are ready to set up an ITS system. For instructions, see Chapter 2, “Setting Up an ITS System.”
Additional References• Related Documents, page 1-25
• Standards, page 1-25
• MIBs, page 1-26
• RFCs, page 1-26
• Technical Assistance, page 1-26
1-24Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewAdditional References
Related Documents
Standards
Related Topic Document Title
Cisco IP phones end-user instructions • Cisco ITS Quick Reference Cards Version 3.0
Dynamic Host Configuration Protocol (DHCP) • Cisco IOS DHCP Server
• “Using Autoinstall and Setup” in Part 1: “Cisco IOS User Interfaces” in the Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.2
Dial peers, DID, and other dialing issues • “Configuring Dial Plans, Dial Peers, and Digit Manipulation” chapter in the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2
• Voice - Understanding One Stage and Two Stage Dialing (Technical Note)
• Voice - Understanding How Inbound and Outbound Dial Peers Are Matched on Cisco IOS Platforms (Technical Note)
• SIP Gateway Enhancements, Cisco IOS Release 12.2(15)ZJ
Default session application • Default Session Application Enhancements
XML guidelines for Cisco IP phone services • Cisco IP Phone Services Application Development Notes
Voice and fax troubleshooting • Cisco IOS Voice Troubleshooting and Monitoring
Command reference and configuration guides • Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2
• Cisco IOS Voice, Video, and Fax Command Reference, Release 12.2 T
• Cisco IOS Debug Command Reference, Release 12.2 T
• TCL IVR API Version 2.0 Programmer's Guide
• Cisco IOS TCL and VoiceXML Application Guide
Standards Title
No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.
—
1-25Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 1 Cisco IOS Telephony Services OverviewAdditional References
MIBs
RFCs
Technical Assistance
MIBs MIBs Link
No new or modified MIBs are supported by this feature, and support for existing MIBs has not been modified by this feature.
To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:
http://www.cisco.com/go/mibs
RFCs Title
No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.
—
Description Link
Technical Assistance Center (TAC) home page, containing 30,000 pages of searchable technical content, including links to products, technologies, solutions, technical tips and tools. Registered Cisco.com users can log in from this page to access even more content.
http://www.cisco.com/public/support/tac/home.shtml
1-26Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 2
Setting Up an ITS SystemThis chapter explains how to set up an Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system on a router.
Contents• Information About Setting Up an ITS System, page 2-1
• Prerequisites, page 2-1
• Setting Network Parameters for ITS, page 2-2
• Upgrading from ITS V2.1 to ITS V3.0, page 2-6
• Downgrading the Cisco IOS Software Image to an Earlier Version, page 2-8
• Verifying the Configuration, page 2-8
• What to Do Next, page 2-9
Information About Setting Up an ITS SystemThe purpose of the tasks in this chapter is to enable the ITS system to communicate with your VoIP network and to prepare the ITS system to register IP phones.
PrerequisitesYou must have the following capabilities in place before starting to set up an ITS system:
• Network—Your VoIP network must be up and operational.
• Cisco IOS software—You must have downloaded and installed a version of Cisco IOS software that supports this version of Cisco ITS.
• Cisco ITS software—You must have downloaded the ITS files and copied them to Flash memory on the ITS router. For more information, see the “Software Prerequisites” section in Chapter 1,“Cisco IOS Telephony Services Overview.”
• Hardware—You must have a router with sufficient memory for the ITS system that you are installing and the appropriate IP phones for end users.
For details, see the “Prerequisites” section in Chapter 1, “Cisco IOS Telephony Services Overview.”
2-1Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemSetting Network Parameters for ITS
Setting Network Parameters for ITSThe following tasks allow the ITS system to communicate with your network:
• Setting Up DHCP Service for ITS (not required if using the ITS setup tool)
• Configuring Network Time Protocol (required)
Setting Up DHCP Service for ITS
Note If you plan to use the ITS setup tool and you need just one DHCP IP address pool, the ITS setup tool will create the address pool for you. You do not have to perform the steps in this section. Proceed to the “Configuring Network Time Protocol” section on page 2-5.
When a Cisco IP phone is connected to the ITS system, it automatically queries for a Dynamic Host Configuration Protocol (DHCP) server. The DHCP server responds by assigning an IP address to the Cisco IP phone and providing the IP address of the TFTP server through DHCP option 150. Then the phone registers with the ITS server and attempts to get configuration and phone firmware files from the TFTP server.
Choose one of the following tasks to set up DHCP service for your IP phones:
• Defining a Single DHCP IP Address Pool, page 2-2—Use this method if the ITS router is a DHCP server and if you can use a single shared address pool for all your DHCP clients.
• Defining a Separate DHCP IP Address Pool for Each Cisco IP Phone, page 2-3—Use this method if the ITS router is a DHCP server and you need separate pools for non-IP-phone DHCP clients.
• Defining a DHCP Relay Server, page 2-4—Use this method if the ITS router is not a DHCP server and you want to relay DHCP requests from IP phones to a DHCP server on a different router.
For more information about DHCP, see Cisco IOS DHCP Server.
Defining a Single DHCP IP Address Pool
This task creates a large shared pool of IP addresses, in which all DHCP clients receive the same information, including the option 150 TFTP server IP address. The benefit of selecting this method to set up DHCP is that you set up only one DHCP pool. However, this method can be a problem if some (non-IP-phone) clients need to use a different TFTP server address.
SUMMARY STEPS
1. ip dhcp pool pool-name
2. network ip-address [mask | /prefix-length]
3. option 150 ip ip-address
4. default-router ip-address
5. exit
2-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemSetting Network Parameters for ITS
DETAILED STEPS
Defining a Separate DHCP IP Address Pool for Each Cisco IP Phone
This task creates a name for the DHCP server address pool and specifies IP and MAC addresses. This method requires that you make an entry for every IP phone.
SUMMARY STEPS
1. ip dhcp pool pool-name
2. host ip-address subnet-mask
3. client-identifier mac-address
4. option 150 ip ip-address
5. default-router ip-address
6. exit
Command or Action Purpose
Step 1 ip dhcp pool pool-name
Example:Router(config)# ip dhcp pool mypool
Creates a name for the DHCP server address pool and enters DHCP pool configuration mode.
Step 2 network ip-address [mask | /prefix-length]
Example:Router(config-dhcp)# network 10.0.0.0 255.255.0.0
Specifies the IP address of the DHCP address pool and the optional mask or number of bits in the address prefix, preceded by a forward slash.
Step 3 option 150 ip ip-address
Example:Router(config-dhcp)# option 150 ip 10.0.0.1
Specifies the TFTP server address from which the Cisco IP phone downloads the image configuration file. This is your ITS router address.
Step 4 default-router ip-address
Example:Router(config-dhcp)# default-router 10.0.0.1
Specifies the router to which the IP phones are connected. This router is either a Cisco ITS router or any Cisco router attached to the Cisco ITS router.
Note As long as the Cisco IP phones have connection to the Cisco ITS router, the Cisco IP phones can get the required network details.
Step 5 exit
Example:Router(config-dhcp)# exit
Exits DHCP pool configuration mode.
2-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemSetting Network Parameters for ITS
DETAILED STEPS
Defining a DHCP Relay Server
The Cisco IOS DHCP relay server feature is enabled on routers by default. If the DHCP server is not enabled on your ITS router, use the steps in this task to enable it.
This task sets up DHCP relay on the LAN interface where the Cisco IP phones are connected and enables the Cisco IOS DHCP server feature to relay requests from DHCP clients (phones) to a DHCP server. For further details about DHCP configuration, refer to the Cisco IOS DHCP Server document.
SUMMARY STEPS
1. service dhcp
2. interface type number
3. ip helper-address ip-address
4. exit
Command or Action Purpose
Step 1 ip dhcp pool pool-name
Example:Router(config)# ip dhcp pool pool2
Creates a name for the DHCP server address pool and enters DHCP pool configuration mode.
Step 2 host ip-address subnet-mask
Example:Router(config-dhcp)# host 10.0.0.0 255.255.0.0
Specifies the IP address that you want the phone to get.
Step 3 client-identifier mac-address
Example:Router(config-dhcp)# client-identifier 01238.380.3056
Specifies the MAC address of the phone, which is printed on a sticker on each Cisco IP phone.
Note You must use a 01 prefix number before the MAC address.
Step 4 option 150 ip ip-address
Example:Router(config-dhcp)# option 150 ip 10.0.0.1
Specifies the TFTP server IP address from which the Cisco IP phone downloads the image configuration file, XmlDefault.cnf.xml. This is your Cisco ITS router IP address.
Step 5 default-router ip-address
Example:Router(config-dhcp)# default-router 10.0.0.1
Specifies the router to which the IP phones are connected. This router is either a Cisco ITS router or any Cisco router attached to the Cisco ITS router.
Note As long as Cisco IP phones are connected to the Cisco ITS router, they can get the network information that they require.
Step 6 exit
Example:Router(config-dhcp)# exit
Exits DHCP pool configuration mode.
2-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemSetting Network Parameters for ITS
DETAILED STEPS
Configuring Network Time ProtocolNetwork Time Protocol (NTP) allows you to synchronize your ITS router to a single clock on the network, which is known as the clock master. NTP is disabled on all interfaces by default, but it is essential for ITS.
For more information about configuring NTP, refer to the “Performing Basic System Management” chapter of Part 3: System Management in the Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.2.
SUMMARY STEPS
1. clock timezone zone hours-offset [minutes-offset]
2. clock summer-time zone recurring [week day month hh:mm week day month hh:mm [offset]]
3. ntp server ip-address
Command or Action Purpose
Step 1 service dhcp
Example:Router(config)# service dhcp
Enables the Cisco IOS DHCP server feature on the router.
Step 2 interface type number
Example:Router(config)# interface vlan 10
Enters interface configuration mode for the specified interface.
Step 3 ip helper-address ip-address
Example:Router(config-if)# ip helper-address 10.0.0.1
Specifies the helper address for any unrecognized broadcast for TFTP server and DNS server requests. For each server, a separate ip helper-address command is required if the servers are on different hosts. You can also configure multiple TFTP server targets by using the ip helper-address commands for multiple servers.
Step 4 exit
Example:Router(config-if)# exit
Exits interface configuration mode.
2-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemUpgrading from ITS V2.1 to ITS V3.0
DETAILED STEPS
Upgrading from ITS V2.1 to ITS V3.0When ITS V2.1 is upgraded to ITS V3.0, the following steps may be required.
SUMMARY STEPS
1. (Optional) If the H.450 call transfer and forwarding Tool Command Language (TCL) script was installed for ITS V2.1, you must removed it from the ITS router.
2. (Optional) If IP phones do not update automatically to the ITS V3.0 configuration, you must manually trigger an update.
Command or Action Purpose
Step 1 clock timezone zone hours-offset [minutes-offset]
Example:Router(config)# clock timezone pst -8
Sets the local time zone.
• zone—Name of the time zone (typically a standard acronym).
• hours-offset—Number of hours that the specified time zone differs from Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT).
• minutes-offset—(Optional) Number of minutes that the time zone differs from UTC.
Step 2 clock summer-time zone recurring [week day month hh:mm week day month hh:mm [offset]]
Example:Router(config)# clock summer-time pdt recurring
(Optional) Specifies daylight savings time.
• zone—Name of the time zone (typically a standard acronym).
Default is that summer time is disabled. If the clock summer-time zone recurring command is specified without parameters, the summer time rules default to United States rules. Default of the offset argument is 60.
For more information, see the “Basic System Management Commands” section in the Cisco IOS Configuration Fundamentals Command Reference, Release 12.2 T.
Step 3 ntp server ip-address
Example:Router(config)# ntp server 10.1.2.3
Allows the clock on this router to be synchronized with the specified NTP server.
• ip-address—IP address of the time server that provides the clock synchronization.
2-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemUpgrading from ITS V2.1 to ITS V3.0
DETAILED STEPS
Step 1 (Optional) If the H.450 call transfer and forwarding TCL script was installed for ITS V2.1, you must remove it from the ITS router. To see if you have this application installed, use the show running-config command. The following example shows an application named app_h450_transfer under telephony-service.
Router# show running-config
.
.
.telephony-service load 7910 P00403020209 load 7960-7940 P00303020209 max-ephones 12 max-dn 48 ip source-address 10.0.0.1 port 2000 strict-match application app_h450_transfer ...
If the application was installed globally for all ephone-dns under telephony-service configuration mode (as shown in the previous example), you can remove it with a single command. The following example shows an application called xfer-app being removed:
Router(config)# telephony-service Router(config-telephony-service)# no application xfer-app
If the H.450 application was loaded under individual ephone-dns, you will see output similar to the following from the show running-config command:
Router# show running-config
.
.
.ephone-dn 1 number 1101 name user1 no huntstopapplication xfer-appcall-forward noan 4000 timeout 30
.
.
.
You can still use a single global command to remove the application by first enabling the application globally and then removing it globally. The following example shows an application called xfer-app being enabled and immediately removed:
Router(config)# telephony-serviceRouter(config-telephony-service)# application xfer-app Router(config-telephony-service)# no application xfer-app
Step 2 (Optional) If IP phones do not update automatically to the ITS V3.0 configuration, you must manually trigger an update. On some occasions, phones may not fully accept ITS V3.0 configuration information when you update from ITS V2.1. If so, entries may be missing from the Services or Directories menu.
2-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemDowngrading the Cisco IOS Software Image to an Earlier Version
You can check the Settings > Status option on an IP phone for error status messages, or you can use the show ephone phoneload command to display the phone firmware that is currently loaded for each phone type.
If you find that the phone firmware is not the same as the version that you loaded for ITS V3.0, you can force the phones to update their configuration information. First, change the network locale to something other than the locale that you desire, and reset the phones. Then change the network locale to the locale that you desire, and reset the phones again. The following steps illustrate this procedure:
a. Set the network locale to a new code to trigger a new generation of configuration files. In this example, the network locale is being set to Germany.
Router(config)# telephony-service Router(config-telephony-service)# network-locale DE
b. Using the reset all command, reboot the phones so that they access the new configuration files.
Router(config-telephony-service)# reset all
c. Change the network locale to the code that you actually want. In this case, the desired network locale is United States (US).
Router(config-telephony-service)# network-locale US
d. Reboot the phones again.
Router(config-telephony-service)# reset all
Downgrading the Cisco IOS Software Image to an Earlier Version
If it becomes necessary to downgrade the Cisco IOS image to an earlier version, you must use the following sequence of tasks so that the phones boot correctly:
1. Downgrade the ITS phone firmware files first.
2. Then, downgrade the ITS image.
Verifying the ConfigurationUse the show running-config command to verify that DHCP is configured:
Router# show running-config
.
.
.ip dhcp pool mypool network 10.0.0.0 255.255.0.0 option 150 ip 10.0.0.1 default-router 10.0.0.1
.
.
.
2-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemWhat to Do Next
What to Do NextAfter establishing a DHCP server and configuring NTP, set up the phones as described in Chapter 3, “Setting Up Phones in an ITS System.”
2-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 2 Setting Up an ITS SystemWhat to Do Next
2-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 3
Setting Up Phones in an ITS SystemThis chapter explains the basic tasks necessary to set up IP phones in an Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Information About Setting Up Phones in an ITS System, page 3-1
• Specifying ITS Parameters, page 3-2
• Setting Up Initial Extensions and Phones, page 3-5
• Specifying Phone-Related Parameters, page 3-19
• Resetting and Restarting ITS Phones, page 3-29
• Verifying ITS Phone Configuration, page 3-32
• Configuration Example, page 3-34
• What to Do Next, page 3-37
Information About Setting Up Phones in an ITS SystemThis chapter describes the three basic tasks necessary to get the phones in an ITS system up and running:
1. Specifying ITS Parameters, page 3-2
This task prepares the ITS system for IP phones the setup of extensions and phones. If you are using the ITS setup tool to automatically set up initial extensions and phones in the next task, you do not need to perform this task.
2. Setting Up Initial Extensions and Phones, page 3-5
This task sets up the initial extensions and phones that you want to start with. You can use the ITS graphical user interface (GUI) or router command-line interface (CLI) to add or change extensions and phones later.
There are three ways to perform this task: automated using ITS setup tool, partially automated using the auto assign command, and manual using the ITS router CLI.
3. Specifying Phone-Related Parameters, page 3-19
This task allows you to define various required and optional parameters that should be in place when you first set up your ITS phones.
3-1Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying ITS Parameters
In addition, this chapter also explains how to reboot phones after configuration changes in the “Resetting and Restarting ITS Phones” section on page 3-29, and how to verify your configuration in the “Verifying ITS Phone Configuration” section on page 3-32. A configuration example is located in the “Configuration Example” section on page 3-34.
Specifying ITS Parameters
Note If you are using the ITS setup tool, you do not have to perform the tasks in this section. Proceed to the “Automated Phone Setup Using the ITS Setup Tool” section on page 3-6.
The commands in this task identify and modify XML phone configuration files so that IP phones can automatically find the defaults to configure themselves when they come online or are rebooted. The last step in this task is to reset all phones, which causes them to request the new firmware files.
Cisco ITS V2.1 introduced the use of XML configuration files for IP phones. There is one shared default XML configuration file for each type of IP phone. When an IP phone comes online or is rebooted, it automatically gets information about itself from the appropriate default configuration file. The phone coming online uses a filename alias based on the phone type, which is either automatically detected by the ITS router or is specified in the type command in ephone configuration mode. The type command is mandatory only for ATA phones or for IP phones that are adding one or two Cisco IP Phone Expansion Module 7914s.
In ITS V2.1 and later versions, the ITS configuration files have been moved to system:/its/. The file named Flash:SEPDEFAULT.cnf that was used with previous ITS versions is now obsolete, but is retained as system:/its/SEPDEFAULT.cnf to support upgrades from older phone firmware.
In an ITS system, the IP phones receive their initial configuration information and phone firmware from the TFTP server associated with the ITS router. In most cases, the phones obtain the IP address of their TFTP server using the Dynamic Host Configuration Protocol (DHCP) option 150 command. For ITS operation, the TFTP server address obtained by the Cisco IP phones should point to the Cisco ITS router IP address. The Cisco IP phones attempt to transfer a configuration file called XmlDefault.cnf.xml. This file is automatically generated by the Cisco ITS router through the ip source-address command and placed in router memory. The XmlDefault.cnf.xml file contains the IP address that the phones use to register for service, using the Skinny Client Control Protocol (SCCP). This IP address should correspond to a valid Cisco ITS router IP address (and may be the same as the router TFTP server address). Access to the XmlDefault.cnf.xml file must be granted through the tftp-server command on the router.
Similarly, when an analog telephone adapter (ATA) such as the ATA-186 is attached to the ITS router, the ATA receives very basic configuration information and firmware from the TFTP server XMLDefault.cnf.xml file. Access to the XMLDefault.cnf.xml file must be granted by using the tftp-server command on the router. The XMLDefault.cnf.xml file is automatically generated by the ITS router with the ip source-address command and is placed in the router’s Flash memory.
SUMMARY STEPS
1. tftp-server flash:filename
2. telephony-service
3. max-ephones max-phones
4. max-dn max-directory-numbers
5. load phone-type firmware-file
3-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying ITS Parameters
6. ip source-address ip-address [port port] [any-match | strict-match]
7. create cnf-files
8. keepalive seconds
9. reset all [time-interval]
10. exit
11. Verify that all phones have been upgraded.
DETAILED STEPS
Command or Action Purpose
Step 1 tftp-server flash:filename
Example:Router(config)# tftp-server flash:P00303020214.bin
Permits the ITS router to provide TFTP access to the specified file by the IP phones served by the router.
Note The phone version is derived from the phone firmware filename. For example, [03 02 02 09] is phone version 3.2(2.9).
Step 2 telephony-service
Example:Router(config)# telephony-service
Enables Cisco ITS and enters telephony-service configuration mode.
Step 3 max-ephones max-phones
Example:Router(config-telephony-service)# max-ephones 24
Sets the maximum number of Cisco IP phones that are supported by this router. The maximum number for each type of router is listed in Table 1-1 in Chapter 1, “Cisco IOS Telephony Services Overview.”
Step 4 max-dn max-directory-numbers
Example:Router(config-telephony-service)# max-dn 48
Sets the maximum number of directory numbers that are supported by this router. The maximum number for each type of router is listed in Table 1-1 in Chapter 1, “Cisco IOS Telephony Services Overview.”
3-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying ITS Parameters
Step 5 load phone-type firmware-file
Example:Router(config-telephony-service)# load 7960-7940 P00303020214
Identifies the Cisco IP phone firmware file to be used by phones of the specified Cisco IP phone type when they register.
• phone-type—Type of IP phone. The following choices are valid:
– 7902—Cisco IP Phone 7902G.
– 7905—Cisco IP Phone 7905G.
– 7910—Cisco IP Phone 7910.
– 7912—Cisco IP Phone 7912G.
– 7914—Cisco IP Expansion Module 7914.
– 7935—Cisco IP Conference Station 7935.
– 7960-7940—Cisco IP Phone 7940G or Cisco IP Phone 7960G.
– ATA—Cisco ATA-186 or Cisco ATA-188.
• firmware-file—Filename of the phone firmware, without the filename suffix.
Note If a firmware file that you are loading for a particular phone type is larger than 384KB, you must first load a file on that phone type that is smaller than 384KB, then load the larger file.
Step 6 ip source-address ip-address [port port] [any-match | strict-match]
Example:Router(config-telephony-service)# ip source-address 10.16.32.144
Identifies the IP address and port number that the Cisco ITS router uses for IP phone registration. The default port is 2000.
• any-match—(Optional) Disables strict IP address checking for registration. This is the default.
• strict-match—(Optional) Instructs the router to reject IP phone registration attempts if the IP server address used by the phone does not exactly match the source address.
Step 7 create cnf-files
Example:Router(config-telephony-service)# create cnf-files
Builds the XML configuration files that are required for ITS features.
Step 8 keepalive seconds
Example:Router(config-telephony-service)# keepalive 45
(Optional) Sets the time interval, in seconds, between keepalive messages that are sent to the router by Cisco IP phones. The default is usually adequate. If the interval is set too large, it is possible that notification will be delayed when a system goes down.
• seconds—Range is from 10 to 65535. Default is 30.
Command or Action Purpose
3-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Troubleshooting Tips
• Check the download web page to determine the currently recommended phone firmware version (http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp).
• Use the debug ephone register command to show status (alarm) messages at registration time. The messages include the current IP phone firmware version.
Setting Up Initial Extensions and PhonesThere are three ways to create an initial phone setup in an ITS system:
• Automated Phone Setup Using the ITS Setup Tool
• Partially Automated Setup Using Router CLI
• Manual Setup Using Router CLI
Automated phone setup with the ITS setup tool is the easiest way to configure a group of phones. The ITS setup tool provides a question-and-answer interface from the ITS router CLI and quickly builds a configuration file after you complete the dialog. This method also sets up DHCP service and the router IP address, so you do not have to perform most of the tasks in Chapter 2, “Setting Up an ITS System.” This method assigns one phone number to each phone as it registers with the ITS router.
Step 9 reset all [time-interval]
Example:Router(config-telephony-service)# reset all
Resets all IP phones associated with the ITS router, which causes them to ask for the phone firmware file associated with their phone type.
• time-interval—(Optional) Interval between each phone reset, in seconds. This argument allows you to provide an interval between resets so that all phones do not attempt to access the TFTP resource at the same time. A 15-second interval is recommended for an 8- to 10-phone office, but you can adjust this value accordingly for your network. Range is from 0 to 60. Default is 15.
Step 10 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Step 11 Verify that all phones have been upgraded. Check the version number displayed on an individual IP phone when you press the Settings button.
From the router, check the firmware version loaded on a specific phone by enabling the debug ephone register command, resetting the phone, and looking at the Load parameter that is displayed as part of the informational StationAlarm message generated when the phone registers.
If a phone fails to upgrade, reset the individual phone again by using the reset mac-address command.
Command or Action Purpose
3-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
A partially automated setup method is available when you use the auto assign command to automatically distribute ephone-dn tags (phone extension instance numbers) from a specified range to IP phones as they register with your ITS router. This method also assigns one phone number to each phone as it registers but you still make manual entries using router command-line interface (CLI) for other parameters. You must complete the tasks described in Chapter 2, “Setting Up an ITS System,” prior to using the partially automated setup method.
A third way to set up IP phones is by using individual commands at the router CLI. Each phone and ephone-dn is set up one at a time. This method is useful when you are not using the default values for parameters or when you have a keyswitch-style operation in which each phone shares some lines. This method provides the most control. You must perform the manual tasks described in Chapter 2, “Setting Up an ITS System,” prior to using the manual setup method.
Typically you are going to use automated means for some part of your phone setup and finish the configuration using router CLI. For example, you can manually preconfigure a series of ephone-dn entries with certain parameter values and then use the auto assign command to instruct the ITS system to automatically assign the next available ephone-dn from the series to each new phone as it registers with the ITS router. Or you can use the ITS setup tool to automatically build a series of ephone-dn entries starting from a specified extension number and then use the auto assign command in the same manner to assign lines to phones as they register. With either of these methods you can later use router CLI to add special features or custom parameters to specific ephone-dns or phones after they are set up.
This chapter describes all three methods for setting up ephone-dns and phones.
Automated Phone Setup Using the ITS Setup ToolThe ITS setup tool provides a question-and-answer interface that allows you to set up an entire Cisco ITS system at one time.
The ITS setup tool is started using the telephony-service setup command. If you do not use the setup keyword, you can set up phones one at a time using router CLI, as described in the “Manual Setup Using Router CLI” section on page 3-14. The setup keyword is not stored in the router NVRAM.
When using the ITS setup tool, you provide information in response to a series of questions. The actual configuration is created only when the entire dialog has been completed. You can interrupt the process using Control-c at any point prior to the final question without having any configuration occur.
Note If you attempt to use the setup option for a system that has a nonempty telephony-service configuration, an error message advises you to remove the existing configuration first by using the no telephony-service command.
Prerequisites
• Phone firmware files must be installed in the ITS router Flash memory.
• You must have already configured NTP on the ITS router, as described in Chapter 2, “Setting Up an ITS System.”
3-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Restrictions
• The ITS setup tool uses the auto assign command to associate ephone-dn tags (sequence numbers) with phones, so the same restrictions that are described in the “Partially Automated Setup Using Router CLI” section on page 3-12 apply here.
• When lines are automatically assigned using the keyswitch mode in the ITS setup tool with two ephone-dn entries for each extension number, the two ephone-dn entries are automatically assigned to a single phone.
SUMMARY STEPS
1. telephony-service setup
2. exit
3. exit
4. show running-config
DETAILED STEPS
ITS Setup Tool Dialog
After you enter the telephony-service setup command, the ITS setup tool prompts you for the information necessary to automatically configure an ITS system. Table 3-1 shows the prompts and describes the information that is requested from you.
Command or Action Purpose
Step 1 telephony-service setup
Example:Router(config)# telephony-service setup
Enters telephony-service configuration mode with the setup option, which automatically starts the ITS setup tool.
Note Table 3-1 on page 3-8 provides information about the questions in the setup dialog.
Step 2 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode after you have completed ITS setup.
Step 3 exit
Example:Router(config)# exit
Exits global configuration mode.
Step 4 show running-config
Example:Router# show running-config
Displays the running configuration so that you can verify settings for DHCP server, telephony service, and ephone-dns that were created with the ITS setup tool.
3-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Table 3-1 ITS Setup Tool DIalog Prompts
ITS Setup Tool Prompt Description
Do you want to setup DHCP service for your IP phones? [yes/no]:
If you respond yes, you see the following prompts:
IP network for telephony-service DHCP Pool:
Subnet mask for DHCP network : TFTP Server IP address (Option 150) :Default Router for DHCP Pool :
• Yes configures the ITS router to act as a DHCP server, automatically providing IP addresses to your IP phones and provisioning the default gateway and TFTP IP addresses to be used by the phones. This method creates a single pool of IP addresses. If you need a pool for non-IP phones or if the ITS router cannot act as the DHCP router, answer no and manually define the DHCP server as described in Chapter 2, “Setting Up an ITS System.”
• No indicates that you have already configured DHCP or static IP addresses for the IP phones.
Do you want to start telephony-service setup? [yes/no]:
• Yes starts the ITS setup for phones.
• No terminates ITS setup tool.
Enter the IP source address for Cisco IOS Telephony Services:
Enter the Skinny Port for Cisco IOS telephony services : [2000]:
IP address on which the router provides ITS services, usually the default gateway for the IP subnet that you are using for the IP phones, and the port for Skinny Client Control Protocol (SCCP) messages.
How many IP phones do you want to configure : [0]:
Enter the maximum number of IP phones that this ITS system will support. This number can be increased later, to the maximum listed in Table 1-1 in Chapter 1, “Cisco IOS Telephony Services Overview.”
Note The ITS setup tool associates one number with each newly registering phone. If you want additional numbers on a phone, add them manually later.
Do you want dual-line extensions assigned to phones? [yes for dual-line / no for single-line]:
• Yes—Each newly registering IP phones is assigned a single number that is associated with a single phone button. The system generates a dual-line ephone-dn entry for each ephone-dn.
• No—IP phones are linked directly to one or more PSTN trunk lines. Using keyswitch mode requires manual configuration in addition to using the ITS setup tool. The system generates two ephone-dn entries for each ephone-dn, and they are both assigned to a single phone.
3-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
What language do you want on IP phones? 0 English 1 French 2 German 3 Russian 4 Spanish 5 Italian 6 Dutch 7 Norwegian 8 Portuguese 9 Danish 10 Swedish [0]:
Language for IP phone displays, selected from the list. The default is 0, English.
Note Russian is not supported in Cisco IOS Release 12.2(15)ZJ.
Which Call Progress tone set do you want on IP phones : 0 United States 1 France 2 Germany 3 Russia 4 Spain 5 Italy 6 Netherlands 7 Norway 8 Portugal 9 UK 10 Denmark 11 Switzerland 12 Sweden 13 Austria 14 Canada[0]:
Locale for the tone set used to indicate call status or progress, selected from the list. The default is 0, United States.
What is the first extension number you want to configure :[0]:
Lowest number to use for extension numbers. Each additional extension that is created receives a number that is incremented by one. Extension numbers must be compatible with your telephone number plan and with PSTN numbering requirements if you use DID service.
Do you have Direct-Inward-Dial service for all your phones? [yes/no]:
• Yes if you have trunk access to public telephone service by ISDN or VoIP for all extension numbers. The system creates an appropriate dial plan.
• No if you have simple analog phone lines only (for example, FXO interfaces) or if you have trunk access for some lines but not all lines.
If you answer yes to the previous question, you see the following prompt:
Enter the full E.164 number for the first phone:
Complete ten-digit telephone number, including area code, that corresponds to the first extension number.
Table 3-1 ITS Setup Tool DIalog Prompts (continued)
ITS Setup Tool Prompt Description
3-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Configurations Resulting from the ITS Setup Tool Dialog
The following configurations result from certain answers to the questions from the ITS setup tool:
• If DHCP configuration is requested, the following configuration CLI is generated according to the parameters entered:
ip dhcp pool ITSnetwork x.x.x.x y.y.y.ydefault-router s.s.s.s option 150 ip s.s.s.s
If the address pool named ITS already exists, the DHCP configuration is not modified and a warning message is displayed.
• The following telephony-service configuration is generated:
telephony-servicemax-ephones phonesmax-dn phonesip source-address s.s.s.svoicemail vm-number
• The system also performs a directory check of the Flash system on the Cisco ITS router, searching for phone firmware files and music-on-hold files. If a music-on-hold file called music-on-hold.au is present in Flash memory, the system adds the following line to the telephony-service configuration:
moh music-on-hold.au
Do you want to forward calls to a voice message service? [yes/no]:
• Yes to forward calls to a single voice message service number when an IP phone is busy or does not answer. All phone extensions forward their calls to the same voice message service pilot number.
• No to not forward calls to a single voice message service number. Answer no if you do not have a voice message system or if you want to customize call forwarding behavior for each extension.
If you answer yes to the previous question, you see the following prompt:
Enter the extension or pilot number of the voice message service:
Voice message service pilot number. This step can be ignored during the setup dialog and manually configured later.
Call forward No Answer Timeout: [18]: Timeout, in seconds, after which to forward calls to voice mail if they are not answered. Default is 18.
Do you wish to change any of the above information? [yes/no]:
• Yes starts the dialog over again without implementing any of the answers that you previously gave.
• No starts the automatic configuration process.
Table 3-1 ITS Setup Tool DIalog Prompts (continued)
ITS Setup Tool Prompt Description
3-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
• If phone firmware files with names of the form “P003........” and “P004........” are present in the Flash file system, the following configuration lines are added:
tftp-server flash:P003........tftp-server flash:P004........
• If multiple phone-firmware files are present, a tftp-server command configuration will be created for each file found. If multiple phone-firmware files are found for a particular phone type, the file that was most recently stored in Flash memory is chosen for use in the load command. The following configuration lines are added:
telephony-serviceload 7960 P003........load 7910 P004........create cnf-files
• If dual-line extensions are selected, the following commands are automatically entered into the ITS configuration for each ephone-dn instance. In the example below, the user specified an initial extension number of 401, a voice-mail number of 501, and a timeout of 30 seconds.
ephone-dn 1 dual-linenumber 401call-forward busy 501call-forward noans 501 timeout 30
ephone-dn 2 dual-linenumber 402call-forward busy 501call-forward noans 501 timeout 30
• If dual-line extensions are not selected, the following commands are automatically entered into the ITS configuration for each ephone-dn instance. In the example below, the user specified an initial extension number of 401 and a voice-mail number of 501.
ephone-dn 1number 401call-forward busy 501call-forward noans 501 timeout 30
ephone-dn 2number 402call-forward busy 501call-forward noans 501 timeout 30
• If DID service is requested, the system automatically generates a dialplan-pattern command as appropriate. At least the last (rightmost) digit of the first extension number and the last (rightmost) digit of the full public telephone number must match. If these do not match, an error message is generated and the user is asked answer the question about DID service again.
• Once all the ephone-dn entries have been generated, the system uses the auto assign command to allow the specified ephone-dn tags to be assigned to IP phones as the phones register:
auto assign dn-tag to dn-tag
3-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Partially Automated Setup Using Router CLIThe partially automated method of setting up IP phones allows you to use the auto assign command to specify a range of ephone-dn tags to which newly discovered IP phones are automatically assigned. This method is useful when you have a phone setup in which each phone is assigned a separate, unique extension number.
You can restrict a particular type of phone to a certain range of extension numbers by specifying in the auto assign command a range of ephone-dn tags that have already been assigned those extension numbers. For example, you may want extensions 6001 to 6025 assigned to Cisco IP Phone 7960Gs and extensions 5001 to 5025 assigned to Cisco IP Phone 7905Gs. If no phone type is specified in the auto assign command, numbers within the defined range are assigned to any phone, regardless of type.
If all the ephone-dn tags in a range are to forward calls to the same voice-mail pilot number, call forwarding can be set up automatically using the auto assign command. The remainder of the ephone-dn setup can be handled automatically using the ITS setup tool or manually using the router CLI.
The configuration resulting from automatic assignment is written to the Cisco ITS router NVRAM at preset intervals.
Prerequisites
The tasks described in Chapter 2, “Setting Up an ITS System,” must be completed before you start the task described in this section.
Restrictions
• Automatic assignment cannot be used to define ephone-dn tags for the Cisco IP Phone Expansion Module 7914.
• Automatically assigned ephone-dn tags must belong to normal ephone-dns and cannot belong to paging ephone-dns, intercom ephone-dns, music-on-hold (MOH) ephone-dns, or message-waiting-indication (MWI) ephone-dns. Ephone-dn tags that are automatically assigned must have at least a primary number defined for them.
• All of the ephone-dns in a single automatic assignment set must be of the same kind (either single-line or dual-line).
• If an insufficient number of ephone-dns are available in the automatic assignment set, some phones will not receive ephone-dns.
• Automatic assignment cannot create shared lines.
• Reversal or undoing of automatic assignment must be performed by manual CLI entry.
SUMMARY STEPS
1. telephony-service
2. auto assign dn-tag to dn-tag [type phone-type] [cfw extn-number timeout seconds]
3. reset all or reset {all [time-interval] | sequence-all}
4. exit
3-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 auto assign dn-tag to dn-tag [type phone-type] [cfw extn-number timeout seconds]
Example:Router(config-telephony-service)# auto assign 1 to 10 type 7910 cfw 5001 timeout 30
Automatically assigns ephone-dn tags from the specified range to newly discovered IP phones.
• dn-tag to dn-tag—Range of ephone-dn tags (unique sequence numbers) to be automatically assigned to IP phones. The value of the dn-tag argument ranges from 1 to 288.
• type phone-type—(Optional) IP phone type to which this range of ephone-dn tags is to be restricted. Valid phone types are 7902, 7905, 7910, 7912, 7935, 7940, 7960, and ATA.
• cfw extn-number—(Optional) Extension number to which calls should be forwarded on busy and no-answer conditions.
• timeout seconds—(Optional; required if the cfw keyword is used) Amount of time to wait when a call is not answered before forwarding a call to the specified number, in seconds. The value of seconds ranges from 3 to 60000.
Step 3 restart all
or
reset {all [time-interval] | sequence-all}
Example:Router(config-telephony-service)# restart all
or
Router(config-telephony-service)# reset all
The restart command performs a complete phone reboot without contacting the DHCP and TFTP servers. Use the restart command unless you use the type keyword in the auto assign command.
The reset command performs a complete phone reboot that includes contacting the DHCP and TFTP servers for the latest configuration information. Use the reset command if you use the type keyword in the auto assign command.
• all—This keyword causes the router to pause 15 seconds between the reset start for each successive phone.
• time-interval—(Optional) Time interval, in seconds, between the start of each phone reset. Range is from 0 to 60. Default is 15.
• sequence-all—This keyword causes the router to wait until one reset is complete before starting to reset the next phone.
Step 4 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
3-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Example
The following example sets up automatic assignment for ephone-dns 1 through 10 for Cisco IP Phone 7910s that are newly discovered by the ITS router. Call forwarding is also configured for these ephone-dns, with calls forwarded to extension 5001 after they are not answered for 30 seconds.
telephony-service auto assign 1 to 10 type 7910 cfw 5001 timeout 30
Manual Setup Using Router CLIThe manual process for setting up an extension involves defining an ephone-dn and the manual process for setting up an ITS phone involves defining an ephone. These terms are defined as follows:
• Ephone-dn—A software construct that represents a line that connects a voice channel to a phone instrument where a user can receive and make calls. An ephone-dn represents a virtual voice port in the ITS system, so the maximum number of ephone-dns in an ITS system is the maximum number of simultaneous call connections that can occur. Note that this concept is different than the maximum number of physical lines in a traditional telephony system and also is different than the maximum number of telephone or extension numbers that can be assigned.
• Ephone—A software construct that represents a physical telephone instrument. This construct provides the ability to configure the instrument itself using Cisco IOS software. The maximum number of ephones in an ITS system is the maximum number of physical instruments that can be connected to the system.
To set up an extension (ephone-dn), you associate one or two numbers and a name with a unique ephone-dn tag (identifier or sequence number) that identifies this particular ephone-dn for configuration purposes. This creates the virtual line, or extension, with which call connections can be made.
Each ephone-dn tag is then associated with a line button on one or more ephones (the software constructs that allow you to program extensions and features onto physical IP phones). Each IP phone must be configured as an ephone on the ITS router to receive support in the LAN environment.
Using the ephone-dn command and the dual-line keyword, you can create an ephone-dn in dual-line mode. Each dual-line ephone-dn has one voice port and two channels to handle two independent calls. This mode enables call waiting, call transfer, and conference functions on a single ephone-dn. Dual-line mode works with all phone types, but is not appropriate for ephone-dns that are used for voice-mail numbers, intercoms, message-waiting indicators, paging, or hunt groups. Overlays and hunt groups that use dual-line ephone-dns are supported. Only one dual-line ephone-dn can be set on a Cisco IP Phone 7910.
The button command in ephone configuration mode allows you to customize ring characteristics for each button or to designate buttons that should not produce an audible ring when they receive incoming calls. The feature-ring and silent-ring features are supported on all phones but are most appropriate for multiline IP phones, including the Cisco IP Phone 7940, Cisco IP Phone 7960, and Cisco IP Phone Expansion Module 7914.
For more information about types of ephone-dns and about ephones, see the “Before You Start: Basic ITS Concepts” section in Chapter 1, “Cisco IOS Telephony Services Overview.”
Prerequisites
The tasks described in Chapter 2, “Setting Up an ITS System,” must be completed before you start the tasks described in this section. In particular, be sure that you have copied ITS files to the ITS router Flash memory.
3-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
SUMMARY STEPS
1. ephone-dn dn-tag [dual-line]
2. number number [secondary number] [no-reg [both | primary]]
3. name name
4. exit
5. ephone phone-tag
6. mac-address mac-address
7. type phone-type [addon 1 module-type [2 module-type]]
8. button button-number{separator}dn-tag [[button-number{separator}dn-tag] ...]
9. exit
3-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn dn-tag [dual-line]
Example:Router(config)# ephone-dn 55 dual-line
Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status.
• dn-tag—Unique sequence number that identifies this ephone-dn during configuration tasks. Range is from 1 to 288. The maximum number of ephone-dns for a particular ITS system is version- and platform-specific. Refer to ITS Specifications in the “Prerequisites” section in Chapter 1, “Cisco IOS Telephony Services Overview.”
• dual-line—(Optional) Enables an ephone-dn with one voice port and two voice channels, which supports features such as call waiting, call transfer, and conferencing with a single ephone-dn.
Note To change an ephone-dn from dual-line to single-line mode or the reverse, you must first delete the ephone-dn and then recreate it.
Step 2 number number [secondary number] [no-reg [both | primary]]
Example:Router(config-ephone-dn)# number 2345
Configures a valid extension number for this ephone-dn instance.
• number—String of up to 16 digits that represents a telephone or extension number to be associated with this ephone-dn.
• secondary—(Optional) Allows you to associate a second telephone number with an ephone-dn.
• no-reg—(Optional) Specifies that this number should not register with the H.323 gatekeeper. Unless you specify one of the optional keywords (both or primary) after the no-reg keyword, the secondary number is not registered.
Step 3 name name
Example:Router(config-ephone-dn)# name Smith, John
Associates a name with this ephone-dn instance. This name is used for caller-ID displays and in the local directory listings.
You must follow the name order that is specified in the directory command in telephony-service configuration mode (either first-name-first or last-name-first).
3-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Step 4 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Step 5 ephone phone-tag
Example:Router(config)# ephone 6
Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies this ephone during configuration tasks. Range is from 1 to 240. The maximum number of ephones for a particular ITS system is version- and platform-specific. Refer to ITS Specifications in the “Prerequisites” section in Chapter 1, “Cisco IOS Telephony Services Overview.”
Step 6 mac-address mac-address
Example:Router(config-ephone)# mac-address 2946.3f2.311
Specifies the MAC address of the IP phone that is being configured.
Step 7 type phone-type [addon 1 module-type [2 module-type]]
Example:Router(config-ephone)# type 7960 addon 1 7914
Specifies the type of phone. This command is required for phones with ATA devices and when you have an add-on module. For other phone types, this command is optional.
• phone-type—Valid entries are the following:
– 7902—Cisco IP Phone 7902G
– 7905—Cisco IP Phone 7905G
– 7910—Cisco IP Phone 7910
– 7912—Cisco IP Phone 7912G
– 7935—Cisco IP Conference Station 7935
– 7940—Cisco IP Phone 7940
– 7960—Cisco IP Phone 7960
– ata—Cisco ATA-186 or Cisco ATA-188
• module-type—Valid entry is the following:
– 7914—Cisco IP Phone Expansion Module 7914
Command or Action Purpose
3-17Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSetting Up Initial Extensions and Phones
Step 8 button button-number{separator}dn-tag [[button-number{separator}dn-tag] ...]
Example:Router(config-ephone)# button 1:10 2:11 3b12 4o13,14,15
Assigns a button number and line characteristics to an extension (ephone-dn). Maximum number of buttons is determined by phone type, as follows:
• Cisco IP Phone 7940, Cisco IP Phone 7910, and Cisco IP Conference Station 7935—Up to 2 buttons.
• Cisco IP Phone 7960—Up to 6 buttons.
Note The Cisco IP Phone 7910 has only one line button, but can be given 2 ephone-dn tags.
• button-number—Number of a line button on an IP phone, starting with 1 as the top button.
• separator—Single character that denotes the type of characteristics to be associated with the extension. Valid entries are the following:
– : (colon)—Normal ring. For incoming calls, single pulse for internal calls and double pulse for external calls. Visible cues are a flashing ((< icon in the phone display and a flashing red light on the handset.
– b—Beep is allowed. Audible ring is suppressed for incoming calls, but call-waiting beeps are allowed. Visible cues are the same as for a normal ring.
– f—Feature ring. Triple-pulse cadence differentiates incoming calls on one line from incoming calls on other lines on the phone.
– m—Monitor mode for a shared line. Visible line status indicates in-use or not. Line cannot be used on this phone to make or receive calls.
– o—Overlay line. Multiple ephone-dns share a single button, up to a maximum of ten on a button. The dn-tag argument can contain up to ten dn-tags, separated by commas.
– s—Silent ring. Audible ring and call-waiting beep are suppressed for incoming calls. Visible cues are the same as for a normal ring.
• dn-tag—Unique sequence number of the ephone-dn that you want to appear on this button. For overlay lines, this argument can contain up to ten sequence numbers, separated by commas.
Command or Action Purpose
3-18Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
Specifying Phone-Related ParametersWhether you use an automated or manual method to set up ITS phones, you must also consider the following phone-related parameters:
• DTMF Relay, page 3-19 (required)
• Dial-Plan Pattern, page 3-22 (required if you have DID)
• SIP Register Support, page 3-23 (optional)
• Translation Rules, page 3-25 (optional)
• International Language, Date Formats, and Tone Support, page 3-26 (optional)
DTMF RelayIP phones connected to ITS systems require the use of out-of-band DTMF relay to transport DTMF (keypad) digits across VoIP connections. The reason for this is that the codecs used for in-band transport may distort the tones and make them unrecognizable. DTMF relay solves the problem of DTMF tone distortion by transporting DTMF tones out-of-band, or separate, from the encoded voice stream.
Use the appropriate procedure from the following list to configure DTMF relay:
• Configuring DTMF Relay for H.323 Networks
• Configuring DTMF Relay for SIP Networks
Configuring DTMF Relay for H.323 Networks
For IP phones in H.323 networks, DTMF must be relayed using the H.245 alphanumeric method, which is defined by the ITU H.245 standard. This method separates DTMF digits from the voice stream and sends them as ASCII characters in H.245 user input indication messages through the H.245 signaling channel instead of the RTP channel. For more information, see the “H.323 Applications” chapter of the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2.
SUMMARY STEPS
1. dial-peer voice tag voip
2. dtmf-relay h245-alphanumeric
3. exit
Step 9 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Command or Action Purpose
3-19Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
DETAILED STEPS
Example
The following excerpt from the show running-config command output shows a dial peer configured to use H.245 alphanumeric DTMF relay:
dial-peer voice 4000 voipdestination-pattern 4000session target ipv4:10.0.0.25codec g711ulawdtmf-relay h245-alphanumeric
Configuring DTMF Relay for SIP Networks
Cisco-proprietary NOTIFY-based out-of-band DTMF relay adds support for devices that do not support in-band DTMF in SIP networks, such as Cisco IP phones. With this configuration, DTMF tones are forwarded using SIP NOTIFY messages. These commands must be used on both originating and terminating gateways.
For more detailed information, see SIP Gateway Enhancements, Cisco IOS Release 12.2(15)ZJ.
SUMMARY STEPS
1. dial-peer voice tag voip
2. dtmf-relay sip-notify
3. exit
4. sip-ua
5. notify telephone-event max-duration time
6. exit
Command Purpose
Step 1 dial-peer voice tag voip
Example:Router(config)# dial-peer voice 2 voip
Enters dial-peer configuration mode.
Step 2 dtmf-relay h245-alphanumeric
Example:Router(config-dial-peer)# dtmf-relay h245-alphanumeric
Specifies the H.245 alphanumeric method for relaying dual tone multifrequency (DTMF) tones between telephony interfaces and an H.323 network.
Step 3 exit
Example:Router(config-dial-peer)# exit
Exits dial-peer configuration mode.
3-20Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
DETAILED STEPS
Troubleshooting Tips
The dial peer section of the show running-config command output displays DTMF relay status when it is configured, as shown in this excerpt:
dial-peer voice 123 voip destination-pattern [12]... monitor probe icmp-ping session protocol sipv2 session target ipv4:10.8.17.42 dtmf-relay sip-notify
The show sip-ua status command output shows the time interval between consecutive NOTIFY messages for a telephone event.
Command or Action Purpose
Step 1 dial-peer voice tag voip
Example:Router(config)# dial-peer voice 2 voip
Enters dial-peer configuration mode.
Step 2 dtmf-relay sip-notify
Example:Router(config-dial-peer)# dtmf-relay sip-notify
Forwards DTMF tones using SIP NOTIFY messages.
Step 3 exit
Example:Router(config-dial-peer)# exit
Exits dial-peer configuration mode.
Step 4 sip-ua
Example:Router(config)# sip-ua
Enables SIP user-agent configuration mode.
Step 5 notify telephone-event max-duration time
Example:Router(config-sip-ua)# notify telephone-event max-duration 2000
Configures the maximum time interval allowed between two consecutive NOTIFY messages for a single DTMF event.
• max-duration time—Time interval between consecutive NOTIFY messages for a single DTMF event, in milliseconds. Range is from 500 to 3000. Default is 2000.
Step 6 exit
Example:Router(config-sip-ua)# exit
Exits SIP user-agent configuration mode.
3-21Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
Dial-Plan PatternThe dialplan-pattern command creates a dial-plan pattern that specifies a global prefix for the expansion of abbreviated extension numbers into fully qualified E.164 numbers.
The extension-pattern keyword allows additional manipulation of abbreviated extension-number prefix digits. When this keyword and its argument are used, the leading digits of an extension pattern are stripped and replaced by the corresponding leading digits of the dial-plan pattern. This command can be used to avoid Direct Inward Dialing (DID) numbers like 408-555-0101 resulting in four-digit extensions such as 0101.
SUMMARY STEPS
1. telephony-service
2. dialplan-pattern tag pattern extension-length length [extension-pattern epattern] [no-reg]
3. exit
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 dialplan-pattern tag pattern extension-length length [extension-pattern epattern] [no-reg]
Example:Router(config-telephony-service)# dialplan-pattern 1 4085550100 extension-length 3 extension-pattern 4..
Note This example maps all extension numbers 4xx to the PSTN number 40855501xx, so that extension 412 corresponds to 4085550112.
Maps a digit pattern for an abbreviated extension-number prefix to the full E.164 telephone number pattern.
• tag—Dial-plan string tag used before a ten-digit telephone number. Range is from 1 to 5.
• pattern—Dial-plan pattern for full E.164 number.
• extension-length length—Number of digits in the epattern argument that is associated with the extension-pattern keyword.
• extension-pattern epattern—(Optional) Internal extension pattern to use.
• no-reg—(Optional) Prevents the E.164 number in the dial peer from registering with a gatekeeper. By not registering some numbers, you leave them available to be used for other telephony services.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
3-22Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
Example
The following example maps the extension pattern 4.. to the last three digits of the dial-plan pattern 4085550155:
telephony-servicedialplan-pattern 1 4085550155 extension-length 3 extension-pattern 4..
SIP Register SupportThis section describes how to enable a SIP gateway to register E.164 numbers with a SIP proxy or SIP registrar, similar to the way that H.323 gateways can register E.164 numbers with a gatekeeper. SIP gateways allow registration of E.164 numbers to a SIP proxy or registrar on behalf of analog telephone voice ports (FXS), IP phone virtual voice ports (EFXS), and local SCCP phones.
When registering E.164 numbers in dial peers with an external registrar, you can also register them with a secondary SIP proxy or registrar to provide redundancy. The secondary registration can be used if the primary registrar fails.
For more detailed information, see SIP Gateway Enhancements, Cisco IOS Release 12.2(15)ZJ.
Note There are no commands that allow registration between the H.323 and SIP protocols.
By default, SIP gateways do not generate SIP register messages, so the following tasks are needed to set up the gateway to register the gateway's E.164 telephone numbers with an external SIP registrar.
SUMMARY STEPS
1. sip-ua
2. registrar {{dns:host-name | ipv4:ip-address} expires seconds [tcp] [secondary]}
3. retry register number
4. timers register time
5. exit
3-23Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
DETAILED STEPS
Troubleshooting Tips
• Use the show sip-ua timers command to show the waiting time before register requests are sent; that is, the value that has been set with the timers register command.
• Use the show sip-ua register status command to show the status of local E.164 registrations.
• Use the show sip-ua statistics command to show the register messages that have been sent.
Command or Action Purpose
Step 1 sip-ua
Example:Router(config)# sip-ua
Enables SIP user-agent configuration mode.
Step 2 registrar {{dns:host-name | ipv4:ip-address} expires seconds [tcp] [secondary]}
Example:Router(config-sip-ua)# registrar ipv4:10.8.17.40 expires 3600 secondary
Registers E.164 numbers on behalf of analog telephone voice ports (FXS) and IP phone virtual voice ports (EFXS) with an external SIP proxy or SIP registrar server.
• dns:host-name—Domain name server that resolves the name of the dial peer to receive calls.
• ipv4:ip-address—IP address of the dial peer to receive calls.
• expires seconds—Default registration time, in seconds.
• tcp—Sets transport layer protocol to TCP. UDP is the default.
• secondary—Specifies registration with a secondary SIP proxy or registrar for redundancy purposes.
Step 3 retry register number
Example:Router(config-sip-ua)# retry register 10
Sets the total amount of SIP Register messages that the gateway should send.
• number—Number of Register message retries. Range is from 1 to 10. Default is 10.
Step 4 timers register time
Example:Router(config-sip-ua)# timers register 500
Sets how long the SIP UA waits before sending register requests.
• time—Waiting time, in milliseconds. Range is from 100 to 1000. Default is 500.
Step 5 exit
Example:Router(config-sip-ua)# exit
Exits SIP user-agent configuration mode.
3-24Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
Translation RulesTranslation rules are a powerful, general-purpose number-manipulation mechanism supported by Cisco IOS software that can be used to perform operations such as automatically adding telephone area and prefix codes to dialed numbers. Translation rules are applied to virtual voice ports created by ephone-dns.
SUMMARY STEPS
1. ephone-dn dn-tag
2. translate {called | calling} translation-rule-tag
3. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 11
Enters ephone-dn configuration mode.
• dn-tag—The ephone-dn tag (sequence number) of the extension to which you want to apply the translation rules.
Step 2 translate {called | calling} translation-rule-tag
Example:Router(config-ephone-dn)# translate called 123
Applies a translation rule to numbers dialed by Cisco IP phone users. The called keyword translates the called number, and the calling keyword translates the calling number.
Note Appropriate translation rules should be created on the VoIP configuration level in order for the translate command to take effect.
The translation-rule-tag argument is the reference number of the translation rule. Valid entries are 1 to 2147483647. For further details, see the “Configuring Dial Plans, Dial Peers, and Digit Manipulation” chapter of the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
3-25Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
International Language, Date Formats, and Tone Support On the Cisco IP Phone 7940 and Cisco IP Phone 7960, the language displayed on the phone and the locale for call progress tones and cadences can be set to the following ISO-3166 codes for languages and locales:
• Danish (DK)
• Dutch (NL)
• French (FR)
• German (DE)
• Italian (IT)
• Norwegian (NO)
• Portuguese (PT)
• Russian (RU)
• Spanish (ES)
• Swedish (SE)
• United States (US)
The format of the date and time that is displayed on Cisco IP phones can be configured in several formats.
Restrictions
• Cisco IP Phone 7905G and Cisco IP Phone7912G support only United States (US).
• Cisco IP Phone 7910, Cisco IP Phone Expansion Module 7914, and Cisco IP Phone Conference Station 7935 do not support international languages.
SUMMARY STEPS
1. telephony-service
2. user-locale language-code
3. network-locale locale-code
4. date-format {mm-dd-yy | dd-mm-yy | yy-dd-mm | yy-mm-dd}
5. time-format {12 | 24}
6. reset all [time-interval]
7. exit
3-26Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 user-locale language-code
Example:Router(config-telephony-service)# user-locale FR
Specifies a language for display on the Cisco IP Phone 7940 and Cisco IP Phone 7960.
• language-code—ISO-3166 codes that are supported are as follows:
– DK—Danish
– NL—Dutch
– FR—French
– DE—German
– IT—Italian
– NO—Norwegian
– PT—Portuguese
– RU—Russian Federation
– ES—Spanish
– SE—Swedish
– US—United States (default)
Step 3 network-locale locale-code
Example:Router(config-telephony-service)# network-locale FR
Specifies a set of call progress tones and cadences on the Cisco IP Phone7940 and Cisco IP Phone 7960.
• locale-code—ISO-3166 codes that are supported are as follows:
– DK—Denmark
– NL—Netherlands
– FR—France
– DE—Germany
– IT—Italy
– NO—Norway
– PT—Portugal
– RU—Russian Federation
– ES—Spain
– SE—Sweden
– US—United States (default)
3-27Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemSpecifying Phone-Related Parameters
Example
The following example sets the locale for display language and call progress tones to France:
telephony-serviceuser-locale FRnetwork-locale FR
Troubleshooting Tips
To display the current locale codes that are associated with dictionary, language, and call progress tone files, use the show telephony-service tftp-bindings command.
Step 4 date-format {mm-dd-yy | dd-mm-yy | yy-dd-mm | yy-mm-dd}
Example: Router(config-telephony-service)# date-format yy-dd-mm
Sets the date format for IP phone display. The choices are mm-dd-yy, dd-mm-yy, yy-dd-mm, and yy-mm-dd, where
• dd—day
• mm—month
• yy—year
Default is mm-dd-yy.
Step 5 time-format {12 | 24}
Example:Router(config-telephony-service)# time-format 24
Selects a 12-hour clock or 24-hour clock for the time display format on all Cisco IP phones attached to the router.
Default is 12.
Step 6 reset all [time-interval]
Example:Router(config-telephony-service)# reset all
Performs a complete reboot of all phones, including contacting the DHCP and TFTP servers for the latest configuration information.
• all—Resets all phones associated with an ITS router.
• time-interval—(Optional) Time interval, in seconds, between the start of each phone reset. Range is from 0 to 60. Default is 15.
Note The network-locale and user-locale commands require a phone reset. If you are using only the date-format or time-format commands, you can use the restart command instead.
Step 7 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service mode.
Command or Action Purpose
3-28Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemResetting and Restarting ITS Phones
Resetting and Restarting ITS PhonesCisco IP phones must be rebooted after configuration changes in order for the changes to take effect. There are two ways to reboot a phone: using the reset command and using the restart command. The differences between these commands are summarized in Table 3-2.
When you use the reset command to reboot multiple IP phones, it is possible for a conflict to occur if too many phones attempt to access changed ITS configuration information via TFTP simultaneously. The sequence-all keyword has been provided to specify a sequential reset of multiple IP phones to minimize the risk of that conflict.
The reset command takes significantly longer to process than the restart command when you are updating multiple phones, but it must be used when you update phone firmware, user locale, network locale, or URL parameters. For simple button, line, or speed-dial changes, use the restart command.
This section describes the following tasks:
• Rebooting Phones Using the reset Command, page 3-29
• Rebooting One Phone Using the restart Command, page 3-31
• Rebooting All Phones Using the restart Command, page 3-31
Rebooting Phones Using the reset CommandThe reset command is used to reboot IP phones after you update phone firmware, user locale, network locale, or URL parameters.
SUMMARY STEPS
1. telephony-service
2. reset {all [time-interval] | cancel | mac-address mac-address | sequence-all}
3. exit
Table 3-2 reset and restart Commands
reset Command restart Command
Similar to power-off, power-on reboot. Quick restart.
Contacts the DHCP server and TFTP server for their ITS system updates.
Does not contact the DHCP or TFTP server.
Takes longer to process when updating multiple phones.
Faster processing for multiple phones.
Must be used when updating the following:
• Phone firmware
• User locale
• Network locale
• URL parameters
Can be used when updating the following:
• Phone buttons
• Phone lines
• Speed-dial numbers
3-29Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemResetting and Restarting ITS Phones
DETAILED STEPS
Example
The following example performs a complete sequential reboot of all phones associated with the ITS router:
telephony-servicereset sequence-all
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 reset {all [time-interval] | cancel | mac-address mac-address | sequence-all}
Example:Router(config-telephony-service)# reset all
Performs a complete reboot of all phones or the phone with the specified MAC address, including contacting the DHCP and TFTP servers for the latest configuration information.
• all—Resets all phones associated with an ITS router. This keyword causes the router to pause 15 seconds between the reset start for each successive phone.
• time-interval—(Optional) Time interval, in seconds, between the start of each phone reset. Range is from 0 to 60. Default is 15.
• cancel—Interrupts a sequential reset cycle.
• mac-address mac-address—Resets the phone that has the specified MAC address.
• sequence-all—Resets all phones associated with this ITS router. This keyword causes the router to wait until one reset is complete before starting to reset the next phone. After the reset timeout of 4 minutes, the router stops waiting for the currently registering phone to complete registration and starts to reset the next phone.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
3-30Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemResetting and Restarting ITS Phones
Rebooting One Phone Using the restart CommandThe restart command is used to reboot IP phones after you make simple button, line, or speed-dial changes.
SUMMARY STEPS
1. ephone phone-tag
2. restart
3. exit
DETAILED STEPS
Example
The following example performs a fast reboot of ephone 1:
ephone 1restart
Rebooting All Phones Using the restart CommandThe restart command is used to reboot IP phones after you make simple button, line, or speed-dial changes.
SUMMARY STEPS
1. telephony-service
2. restart all
3. exit
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 1
Enters ephone configuration mode.
• phone-tag—Unique sequence number of the ephone that you want to restart.
Step 2 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 3 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
3-31Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemVerifying ITS Phone Configuration
DETAILED STEPS
Example
The following example performs a fast reboot of all phones associated with the ITS router:
telephony-servicerestart all
Verifying ITS Phone ConfigurationTo verify the ITS phone configuration, perform the following steps:
Step 1 Use the show running-config command to verify ephone-dn configurations.
.
.
.ephone-dn 1 number 1101 name user1 no huntstopcall-forward noan 4000 timeout 30
! ephone-dn 2 number 1101 name user1preference 1 call-forward busy 4000 call-forward noan 4000 timeout 30
! ephone-dn 3 number 1102 name user2 no huntstopcall-forward noan 4000 timeout 30
.
.
.
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 restart all
Example:Router(config-telephony-service)# restart all
Performs a fast reboot of all phones associated with this ITS router. Does not contact the DHCP or TFTP server for updated information.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service mode.
3-32Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemVerifying ITS Phone Configuration
Step 2 Verify the correct phone firmware installation by setting registration debugging with the debug ephone register command. Then reset the phones and look at the StationAlarmMessage displayed during phone re-registration. The “Load=” parameter should appear in the display, followed by an abbreviated version name corresponding to the correct phone firmware file name.
Step 3 Enter the show telephony-service all command to verify that the ITS router is enabled.
Step 4 Use the show telephony-service tftp-bindings command to ensure that the locale-specific files are correct.
Router# show telephony-service tftp-bindings
tftp-server system:/its/SEPDEFAULT.cnf tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml tftp-server system:/its/ATADefault.cnf.xml tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml tftp-server system:/its/germany/7960-dictionary.xml alias German_Germany/7960-dictionary.xml tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml tftp-server system:/its/germany/SCCP-dictionary.xml alias German_Germany/SCCP-dictionary.xml tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml
Step 5 Enter the show ephone [mac-address] command to verify Cisco IP phone setup after phones have registered with the ITS router.
Router# show ephone
ephone-1 Mac:0003.E3E7.F627 TCP socket:[2] activeLine:0 REGISTERED mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 IP:20.0.0.2 51671 Telecaster 7940 keepalive 28 max_line 2 button 1: dn 1 number 4444 CM Fallback IDLE ephone-2 Mac:0030.94C3.F43A TCP socket:[1] activeLine:0 REGISTERED mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 IP:20.0.0.3 50094 Telecaster 7960 keepalive 28 max_line 6 button 1: dn 3 number 5555 CM Fallback IDLE ephone-3 Mac:0003.6B40.99DA TCP socket:[3] activeLine:0 REGISTERED mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 IP:1.2.168.200 51879 Telecaster 7960 keepalive 28 max_line 6 button 1: dn 2 number 3333 CM Fallback IDLE
Step 6 Use the show ephone-dn command to see settings related to an ephone-dn.
Router# show ephone-dn 7
50/0/7 INVALID EFXS 50/0/7 Slot is 50, Sub-unit is 0, Port is 7 Type of VoicePort is EFXS Operation State is UP Administrative State is UP No Interface Down Failure Description is not set Noise Regeneration is enabled Non Linear Processing is enabled Non Linear Mute is disabled Non Linear Threshold is -21 dB Music On Hold Threshold is Set to -38 dBm In Gain is Set to 0 dB Out Attenuation is Set to 0 dB Echo Cancellation is enabled Echo Cancellation NLP mute is disabled
3-33Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemConfiguration Example
Echo Cancellation NLP threshold is -21 dB Echo Cancel Coverage is set to 8 ms Playout-delay Mode is set to default Playout-delay Nominal is set to 60 ms Playout-delay Maximum is set to 200 ms Playout-delay Minimum mode is set to default, value 4 ms Playout-delay Fax is set to 300 ms Connection Mode is normal Connection Number is not set Initial Time Out is set to 10 s Interdigit Time Out is set to 10 s Call Disconnect Time Out is set to 60 s Ringing Time Out is set to 8 s Wait Release Time Out is set to 30 s Companding Type is u-law Region Tone is set for US Station name None, Station number None Caller ID Info Follows: Standard BELLCORE Voice card specific Info Follows: Digit Duration Timing is set to 100 ms
Configuration ExampleThis section provides an example of the required Cisco ITS configuration, with some of the additional options that are discussed in other chapters.
Router# show running-config
version 12.2 no parser cache no service single-slot-reload-enable service timestamps debug uptime service timestamps log uptime no service password-encryption ! hostname 3640 !clock timezone pst -8! logging rate-limit console 10 except errors ! ! ip dhcp pool mypool network 10.0.0.0 255.255.0.0 option 150 ip 10.0.0.1 default-router 10.0.0.1
! ip subnet-zero ! ! no ip domain-lookup ! no ip dhcp-client network-discovery lcp max-session-starts 0 ! ! ! !
3-34Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemConfiguration Example
interface FastEthernet0/0 ip address 10.0.0.1 255.255.0.0 duplex auto speed auto
! interface Serial0/0 no ip address shutdown no fair-queue clockrate 2000000
! interface Serial0/1 no ip address shutdown clockrate 2000000
! ip classless ip route 0.0.0.0 0.0.0.0 10.0.0.10 ! ! tftp-server flash:P00303020214.bintftp-server flash:P00403020214.bin!snmp-server packetsize 4096 snmp-server manager call rsvp-sync ! voice-port 1/0/0connection plar opx 1100
! voice-port 1/0/1connection plar opx 1100
! ! mgcp profile default ! dial-peer voice 100 potsdestination-pattern 9.Tport 1/0/0
!dial-peer voice 101 potsdestination-pattern 9.Tport 1/0/1
!dial-peer voice 4000 voipdestination-pattern 4000session target ipv4:10.0.0.25codec g711ulawdtmf-relay h245-alphanumeric
! ! telephony-service load 7910 P00403020214load 7960-7940 P00303020214max-ephones 12 max-dn 48 ip source-address 10.0.0.1 port 2000 strict-matchmax-conferences 4 keepalive 30 dialplan-pattern 1 40855511.. extension-length 4 create cnf-files voicemail 4000moh music-on-hold.autransfer-system full-consult
3-35Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemConfiguration Example
! !! ephone-dn 1 number 1101 name user1 no huntstopcall-forward noan 4000 timeout 30
! ephone-dn 2 number 1101 name user1preference 1 call-forward busy 4000 call-forward noan 4000 timeout 30
! ephone-dn 3 number 1102 name user2 no huntstopcall-forward noan 4000 timeout 30
! ephone-dn 4 number 1102 name user2preference 1 call-forward busy 4000 call-forward noan 4000 timeout 30
! ephone-dn 5 number 1103 name user3 no huntstopcall-forward noan 4000 timeout 30
! ephone-dn 6 number 1103 name user3preference 1 call-forward busy 4000 call-forward noan 4000 timeout 30
! ephone-dn 7 number 1104 name user4 no huntstopcall-forward noan 4000 timeout 30
! ephone-dn 8 number 1104 name user4preference 1 call-forward busy 4000 call-forward noan 4000 timeout 30
! ephone-dn 9 number 1199 name intercom1199 intercom 1198 label Intercom
! ephone-dn 10 number 1198 name intercom1198 intercom 1199 label Intercom
3-36Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemWhat to Do Next
!ephone-dn 11number 1100name Line1no huntstopcall-forward noan 4000 timeout 60
!ephone-dn 12number 1100name Line2preference 1call-forward noan 4000 timeout 60call-forward busy 4000
! ephone-dn 20 number 1111 name paging1111 paging ip 239.1.1.112 port 2000
! ephone 1 mac-address 0003.6B54.BB15 button 1:1 2:2 3:11 4:12paging-dn 20
! ephone 2 mac-address 0003.6B09.63CF button 1:3 2:4 3:11 4:12paging-dn 20
! ephone 3 mac-address 0003.6B54.C20F button 1:5 2:6 3:11 4:12 5:9paging-dn 20
! ephone 4 mac-address 0003.6B40.892A button 1:7 2:8 3:11 4:12 5:10paging-dn 20
! line con 0 line aux 0 line vty 0 4 login !ntp server 10.0.0.26!end
What to Do NextAfter setting up basic ITS phone configurations, you are ready to set up call transfer and forwarding. If you are not using call transfer or call forwarding in your ITS system, you can now set up the ITS GUI so that you can use the GUI rather than the router CLI to configure additional phone and system options. For instructions on these tasks, see the following chapters:
• Chapter 4, “Configuring Call Transfer”
• Chapter 5, “Configuring Call Forwarding”
• Chapter 6, “Setting Up the ITS GUI”
3-37Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 3 Setting Up Phones in an ITS SystemWhat to Do Next
3-38Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 4
Configuring Call TransferThis chapter describes configurations for call transfer in Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) systems.
Contents• Information About Configuring Call Transfer, page 4-1
• Configuring H450.2-Standard Call Transfer for IP Phones, page 4-2
• Configuring Cisco-Proprietary Call Transfer, page 4-6
• What to Do Next, page 4-7
Information About Configuring Call TransferPrior to ITS V2.1, call transfer was performed using a Cisco-proprietary method. ITS V2.1 introduced support for IP phone call transfers using the ITU-T H.450.2 standards, and ITS V3.0 introduced a simplified way to configure H.450.2 call transfer. For configuration instructions, see the “Configuring H450.2-Standard Call Transfer for IP Phones” section on page 4-2.
For Voice over Frame Relay (VoFR) networks or backwards compatibility with ITS V2.02 and earlier versions of ITS, the Cisco-proprietary method is still required. For configuration instructions, see the “Configuring Cisco-Proprietary Call Transfer” section on page 4-6.
For H.450.2 call transfers in ITS systems that have analog phones connected to FXS ports, the call transfer configuration method described in the application guide for ITS V2.1 is required. For instructions, see Chapter 7, “Configuring Call Transfer,” in Cisco IOS Telephony Services V2.1.
Analog phones may also be supported by connecting them to the ITS system using Cisco ATA-186 or Cisco ATA-188 analog telephone adaptors. Call transfer for phones connected in this way is the same as for IP phones.
4-1Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferConfiguring H450.2-Standard Call Transfer for IP Phones
Configuring H450.2-Standard Call Transfer for IP PhonesCisco ITS V3.0 adds support for IP phones to initiate call transfer using the ITU-T H.450.2 protocol by using the default session application. The built-in H.450.2 support that is provided by the default session application applies to call transfers initiated by IP phones, regardless of PSTN interface type. This support does not extend to analog FXS phones, which require a Tool Command Language (TCL) script to implement call transfer.
For more information about the default session application, refer to Default Session Application Enhancements.
Call transfers using H.450.2 can be blind or consultative. A blind transfer is one in which the transferring phone connects the caller to a destination line before ringback begins. A consultative transfer is one in which the transferring party either connects the caller to a ringing phone (ringback heard) or speaks with the third party before connecting the caller to the third party.
You can specify blind or consultative transfer on a systemwide basis. The systemwide setting can then be overridden for individual phone lines. For example, in an ITS network that is set up for consultative transfer, a specific ephone-dn line that connects to an autoattendant device that automatically transfers incoming calls to specific extension numbers can be set to always use blind transfers. This type of configuration may be required to support autoattendant devices that are unable to use consultative transfer.
Note that this feature and call forwarding using the H.450.3 standard are enabled independently.
PrerequisitesAll voice gateway routers in the VoIP network must support the H.450 standard and be running the following software:
• Cisco IOS Release 12.2(15)ZJ or a later release
• Cisco ITS V3.0 or a later release, or Cisco ITS V2.1 configured to use the app-h450-transfer.tcl script
• TCL IVR 2.0 if using ITS V2.1 (not required for ITS V3.0)
Restrictions• The built-in H.450.2 support provided by the new default session application is limited to call
transfers and forwards initiated by IP phones, regardless of PSTN interface type. This support does not extend to analog FXS phones, which still require a TCL script to implement call transfer and call forward. For more information about call transfer and call forward on analog FXS phones, refer to Chapter 7, “Configuring Call Transfer,” in Cisco IOS Telephony Services V2.1.
• Call transfer with consultation on the Cisco ATA-186, Cisco ATA-188, and Cisco IP Conference Station 7935 is supported only when these devices are provisioned using ephone-dn entries that are configured for dual-line operation. Call transfers from these devices when provisioned with single-line operation are executed as blind transfers.
• H.450.12 Supplementary Services Capabilities exchange between routers is not implemented in this release.
• This feature does not run on Cisco 2610, Cisco 2620, or Cisco 3620 routers that use an earlier version of Cisco ITS. This feature requires, at a minimum, a Cisco 2600-XM and Cisco IOS Release 12.2(15)ZJ.
4-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferConfiguring H450.2-Standard Call Transfer for IP Phones
• Voice over Frame Relay (VoFR) does not support transfer with consultation. Use the local-consult keyword with the transfer-system command. VoFR transfer requires Cisco IOS Release 12.2(8)T or a later release on all VoFR routers; otherwise, transferred calls may get dropped. Note that many older VoFR platforms, such as legacy Cisco MC3810 routers that are running Cisco IOS Release 12.0(5)XK1, cannot be upgraded because of memory limitations.
SUMMARY STEPS
1. telephony-service
2. transfer-system {blind | full-blind | full-consult | local-consult}
3. transfer-pattern transfer-pattern
4. exit
5. ephone-dn dn-tag
6. transfer-mode {blind | consult}
7. exit
8. voice service voip
9. h323
10. h450 h450-2 timeout {T1 | T2 | T3 | T4} milliseconds
11. exit
12. exit
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 transfer-system {blind | full-blind | full-consult | local-consult}
Example:Router(config-telephony-service)# transfer-system full-consult
Defines the call transfer method for all lines served by the Cisco ITS router.
• blind—Calls are transferred without consultation with a single phone line using the Cisco proprietary method.
• full-blind—Calls are transferred without consultation using H.450.2 standard methods.
• full-consult—Calls are transferred with consultation using a second phone line if available. The calls fall back to full-blind if the second line is unavailable.
• local-consult—Calls are transferred with local consultation using a second phone line if available. The calls fall back to blind for nonlocal consultation or nonlocal transfer target.
4-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferConfiguring H450.2-Standard Call Transfer for IP Phones
Step 3 transfer-pattern transfer-pattern
Example:Router(config-telephony-service)# transfer-pattern 52540..
Allows transfer of telephone calls by Cisco IP phones to specified phone number patterns.
• transfer-pattern—String of digits for permitted call transfers. Wildcards are allowed.
Step 4 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Step 5 ephone-dn dn-tag
Example:Router(config)# ephone-dn 2134
(Optional) Enters ephone-dn configuration mode for the specified ephone-dn.
• dn-tag—The unique sequence number that identifies the ephone-dn for which you are defining the transfer mode.
Step 6 transfer-mode {blind | consult}
Example:Router(config-ephone-dn)# transfer-mode consult
(Optional) Defines the type of call transfer for a specific Cisco IP phone line. Allows you to override the system default transfer-system setting (full-consult or full-blind) for an individual ephone-dn.
• blind—Calls are transferred without consultation using a single phone line.
• consult—Calls are transferred with consultation using a second phone line, if available.
Step 7 exit
Example:Router(config-ephone-dn)# exit
(Optional) Exits ephone-dn configuration mode.
Step 8 voice service voip
Example:Router(config)# voice service voip
(Optional) Enters voice service configuration mode.
Step 9 h323
Example:Router(conf-voi-serv)# h323
(Optional) Enters H.323 voice service configuration mode.
Command or Action Purpose
4-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferConfiguring H450.2-Standard Call Transfer for IP Phones
Example
The following example specifies transfer with consultation using the H.450.2 standard for all IP phones serviced by the ITS router:
!dial-peer voice 100 potsdestination-pattern 9.Tport 1/0/0
!dial-peer voice 4000 voipdestination-pattern 4…session-target ipv4:1.1.1.1
!telephony-servicetransfer-pattern 4…transfer-system full-consult
Step 10 h450 h450-2 timeout {T1 | T2 | T3 | T4} milliseconds
Example:Router(conf-serv-h323)# h450 h450-2 timeout T1 750
(Optional) Sets timeouts, in milliseconds, for supplementary service timers and is used primarily when the default settings for these timers do not match your network delay parameters. Refer to the ITU-T H.450.2 specification for more information on these timers.
• T1—Timeout value to wait to identify a response. Default is 2000.
• T2—Timeout value to wait for call setup. Default is 5000.
• T3—Timeout value to wait to initiate a response. Default is 5000.
• T4—Timeout value to wait for setup of a response. Default is 5000.
• milliseconds—Timeout duration, in milliseconds. Range is from 500 to 60000.
Step 11 exit
Example:Router(conf-serv-h323)# exit
(Optional) Exits H.323 voice service configuration mode.
Step 12 exit
Example:Router(conf-voi-serv)# exit
(Optional) Exits voice service configuration mode.
Command or Action Purpose
4-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferConfiguring Cisco-Proprietary Call Transfer
Configuring Cisco-Proprietary Call TransferThis task enables call transfer between Cisco IP phones and non-IP phones for VoFR networks and for compatibility with ITS V2.02 and earlier versions.
Restrictions• Uses a Cisco-proprietary protocol and can interwork with Cisco 1700, Cisco 2600, Cisco 3600, and
Cisco 3700 series routers that are running Cisco IOS Release 12.2(8)T or a later release.
• Call transfer is supported only on the following:
– Voice over Frame Relay (VoFR), Voice over ATM (VoATM), and H.323 for Cisco gateway-to-Cisco gateway using H.323 nonstandard information element (both gateways running Cisco IOS Release 12.2(15)ZJ or a later release)
– Foreign Exchange Office (FXO) and Foreign Exchange Station (FXS) loop-start (analog)
– FXO and FXS ground-start (analog)
– Ear and Mouth (E&M) (analog) and Direct Inward Dialing (DID) (analog)
– T1 channel-associated signaling (CAS) with FXO and FXS ground-start signaling
– T1 CAS with E&M signaling
– All PRI and BRI switch types
SUMMARY STEPS
1. telephony-service
2. transfer-pattern transfer-pattern
3. exit
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 transfer-pattern transfer-pattern
Example:Router(config-telephony-service)# transfer-pattern 5...
Allows transfer of telephone calls by Cisco IP phones to specified phone number patterns. The default, if no transfer pattern is set, is that transfers are permitted only to other local IP phones.
• transfer-pattern—String of digits for permitted call transfers. Wildcards are allowed.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
4-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferWhat to Do Next
What to Do NextAfter configuring call transfer, you can set up call forwarding if desired. For instructions, see Chapter 5, “Configuring Call Forwarding.”
If you do not want to configure call forwarding, you can now set up the ITS GUI. For instructions, see Chapter 6, “Setting Up the ITS GUI.”
4-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 4 Configuring Call TransferWhat to Do Next
4-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 5
Configuring Call ForwardingThis chapter describes configurations for call forwarding in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Information About Configuring Call Forwarding, page 5-1
• Configuring H.450.3-Standard Call Forwarding for IP Phones, page 5-2
• Configuring Cisco-Proprietary Call Forwarding, page 5-4
• What to Do Next, page 5-5
Information About Configuring Call ForwardingPrior to ITS V2.1, call forwarding was performed using a Cisco-proprietary method. ITS V2.1 introduced support for IP phone call forwarding using the ITU-T H.450.3 standards, and ITS V3.0 introduced a simplified way to configure H.450.3 call forwarding. For configuration instructions, see the “Configuring H.450.3-Standard Call Forwarding for IP Phones” section on page 5-2.
For Voice over Frame Relay (VoFR) networks or for backwards compatibility with ITS V2.02 and earlier versions of ITS, the Cisco-proprietary method is required. For configuration instructions, see the “Configuring Cisco-Proprietary Call Forwarding” section on page 5-4.
For H.450.3 call forwarding in ITS systems that have analog phones connected to FXS ports, the call forwarding configuration method described in the application guide for ITS V2.1 is required. For instructions, see Chapter 8, “Configuring Call Forwarding,” in Cisco IOS Telephony Services V2.1.
5-1Version 3.0 System Administrator Guide
Chapter 5 Configuring Call ForwardingConfiguring H.450.3-Standard Call Forwarding for IP Phones
Configuring H.450.3-Standard Call Forwarding for IP PhonesCisco ITS V3.0 added support for IP phones to initiate call forwarding with the ITU-T H.450.3 protocol by using the default session application, which provides native H450.3 support and does not require the manual download and installation of a Tool Command Language (TCL) script as was required in ITS V2.1. For more information about the default session application, refer to Default Session Application Enhancements.
Call forwarding using the H.450.3 standard is available for busy, no-answer, and all conditions. To use this feature, calls that come in to a Cisco ITS ephone-dn that has been forwarded must also support the H.450.3 standard. A new Cisco IOS command, call-forward pattern, allows you to specify the patterns of calling-party numbers that support the H.450.3 standard.
When a Cisco ITS ephone-dn has forwarded its calls and an incoming call is received for that ephone-dn, the Cisco ITS router sends an H.450.3 response back to the original calling party to request that the call be placed again using the forward-to destination. Calling numbers that do not match the patterns defined with this command are forwarded using Cisco-proprietary call forwarding for backward compatibility with earlier versions of Cisco ITS.
PrerequisitesAll voice gateway routers in the VoIP network must support H.450 and run the following software:
• Cisco IOS Release 12.2(15)ZJ or a later release
• Cisco ITS V3.0 or a later release, or Cisco ITS V2.1 configured to use the app-h450-transfer.tcl script
• TCL IVR 2.0 if you are using ITS V2.1 (not required for ITS V3.0)
Restrictions• You can perform a staged network upgrade to H.450.3 call forwarding, but routers must be
configured to identify which calling party numbers support H.450.3 and which do not by using the call-forward pattern command.
• H.450.12 Supplementary Services Capabilities exchange between routers is not implemented in this release.
SUMMARY STEPS
1. telephony-service
2. call forward pattern pattern
3. exit
4. voice service voip
5. h323
6. h450 h450-3 timeout T1 milliseconds
7. exit
8. exit
5-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 5 Configuring Call ForwardingConfiguring H.450.3-Standard Call Forwarding for IP Phones
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 call-forward pattern pattern
Example:Router(config-telephony-service)# call-forward pattern 4...
Specifies the H.450.3 standard for call forwarding. Calling-party numbers that do not match the patterns defined with this command are forwarded using Cisco-proprietary call forwarding for backward compatibility (as described in Cisco ITS V2.0).
• pattern—Digits to match for call forwarding using the H.450.3 standard. If an incoming calling-party number matches the pattern, it can be forwarded using the H.450.3 standard. A pattern of .T forwards all calling parties using the H.450.3 standard.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Step 4 voice service voip
Example:Router(config)# voice service voip
(Optional) Enters voice service configuration mode.
Step 5 h323
Example:Router(conf-voi-serv)# h323
(Optional) Enters H.323 voice service configuration mode.
Step 6 h450 h450-3 timeout T1 milliseconds
Example:Router(conf-serv-h323)# h450 h450-3 timeout T1 750
(Optional) Sets the timeout, in milliseconds, for the supplementary service timer and is used primarily when the default setting for this timer does not match your network delay parameters. Refer to the ITU-T H.450.3 specification for more information on this timer.
• T1—Timeout value to wait for a rerouting response. Default is 5000.
• milliseconds—Number of milliseconds. Range is from 500 to 60000.
Step 7 exit
Example:Router(conf-serv-h323)# exit
(Optional) Exits H.323 voice service configuration mode.
Step 8 exit
Example:Router(conf-voi-serv)# exit
(Optional) Exits voice service configuration mode.
5-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 5 Configuring Call ForwardingConfiguring Cisco-Proprietary Call Forwarding
Example
The following example enables call forwarding using the H.450.3 standard:
!dial-peer voice 100 potsdestination-pattern 9.Tport 1/0/0
!dial-peer voice 4000 voipdestination-pattern 4…session-target ipv4:1.1.1.1
!telephony-servicecall-forward pattern 4…
Configuring Cisco-Proprietary Call ForwardingThis task configures the forwarding of calls to other Cisco IP phones.
SUMMARY STEPS
1. ephone-dn dn-tag
2. number number
3. call-forward all directory-number
4. call-forward busy directory-number
5. call-forward noan directory-number timeout seconds
6. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 4
Enters ephone-dn configuration mode.
• dn-tag—The unique sequence number that identifies the ephone-dn for which you want to define call-forwarding.
Step 2 number number
Example:Router(config-ephone-dn)# number 5555
Specifies a valid directory number for the ephone-dn that is being configured.
Step 3 call-forward all directory-number
Example:Router(config-ephone-dn)# call-forward all 5555
Configures call forwarding to another telephone number for all incoming calls.
5-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 5 Configuring Call ForwardingWhat to Do Next
What to Do NextYou can now set up the ITS GUI and specify the rest of the ITS features using the GUI or the router CLI. For instructions on setting up the ITS GUI, see Chapter 6, “Setting Up the ITS GUI.”
Step 4 call-forward busy directory-number
Example:Router(config-ephone-dn)# call-forward busy 5555
Configures call forwarding to another telephone number when this ephone-dn is busy.
Step 5 call-forward noan directory-number timeout seconds
Example:Router(config-ephone-dn)# call-forward noan 5555 timeout 30
Configures call forwarding to another telephone number for calls that are not answered before the timeout interval expires.
• timeout seconds—Sets the waiting time, in seconds, before an unanswered call is forwarded to another phone. Range is from 3 to 60000.
Step 6 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Command or Action Purpose
5-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 5 Configuring Call ForwardingWhat to Do Next
5-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 6
Setting Up the ITS GUIThis chapter describes the Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) graphical user interface (GUI) and explains how to set it up for three different classes of user.
Contents• Information About Setting Up the ITS GUI, page 6-1
• Setting Up GUI Access for the System Administrator, page 6-2
• Accessing the Cisco ITS GUI, page 6-5
• Creating Additional GUI Login Accounts, page 6-7
• What to Do Next, page 6-15
Information About Setting Up the ITS GUIThe Cisco ITS GUI provides a web-based interface to manage most ITS systemwide and phone-based features. In particular, the GUI facilitates the routine adds and changes associated with employee turnover, allowing these changes to be performed by nontechnical staff.
The ITS GUI provides three levels of access to support the following user classes:
• System administrator—Able to configure all systemwide and phone-based features. This person is familiar with Cisco IOS software and VoIP network configuration.
• Customer administrator—Able to perform routine phone adds and changes without having access to systemwide features. This person does not have to be trained in Cisco IOS software.
• Phone user—Able to program a small set of features on his or her own phone and search the ITS directory.
The Cisco ITS GUI uses HTTP to transfer information from the ITS router to the PC of an administrator or phone user. The ITS router must be configured as an HTTP server, and an initial system administrator username and password must be defined from the router CLI. Additional customer administrators and phone users can be added from the ITS router using command-line interface (CLI) or from a PC using ITS GUI screens.
Cisco ITS provides support for XML cascading style sheets (files with a .css suffix) that can be used to customize the browser GUI display.
6-1Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUISetting Up GUI Access for the System Administrator
The ITS GUI supports authentication, authorization, and accounting (AAA) authentication for system administrators through a remote server when this capability is enabled with the ip http authentication aaa command. If authentication through the server fails, the local router is searched.
A user with Cisco IOS privilege level 15 can access the ITS GUI at the system-administrator level, but can only make changes to the ITS configuration through the GUI, not through the CLI. This user must be authenticated as specified by the ip http authentication command.
The sequence of tasks to set up the ITS GUI is as follows:
1. Setting Up GUI Access for the System Administrator—Define the http path for the ITS router and create an account for the system administrator to log onto the GUI.
2. Accessing the Cisco ITS GUI—Log onto the GUI as the system administrator to verify its installation.
3. Creating Additional GUI Login Accounts—Optionally create accounts for customer administrators and phone users to log onto the GUI. You can create additional accounts from the GUI itself or from router CLI.
PrerequisitesFiles required for the operation of the GUI must be copied into Flash memory on the ITS router if you have not already done so. For a complete list of the GUI files, see the “Software Prerequisites” section in Chapter 1, “Cisco IOS Telephony Services Overview.”
Restrictions• The web browser that you use to access the GUI must be Microsoft Internet Explorer Version 5.5 or
a later release.
• If you use an XML configuration file to create a customer administrator login, the size of the XML file to be loaded must be 4000 bytes or smaller.
• The password of the system administrator cannot be changed through the GUI. Only the password of a customer administrator or a phone user can be changed through the GUI.
Setting Up GUI Access for the System AdministratorTo set up GUI access for the ITS system administrator, complete the following tasks:
• Enabling an HTTP Server and Setting the HTTP Path, page 6-3 (required)
• Setting Up GUI Access for the System Administrator, page 6-3 (required)
6-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUISetting Up GUI Access for the System Administrator
Enabling an HTTP Server and Setting the HTTP PathBy default the HTTP server on a router is disabled. This task enables the HTTP server and specifies the path to the files that create the GUI.
SUMMARY STEPS
1. ip http server
2. ip http path flash:
DETAILED STEPS
Setting Up GUI Access for the System AdministratorThis task defines an initial username and password for a system administrator to access the GUI and enables the GUI to be used to set the time and to add directory listings.
Once you have created this account you can log in to the GUI and create additional login accounts using the GUI itself. Alternatively, you can continue to use router CLI to create additional accounts. Both methods are explained in the sections following this section.
SUMMARY STEPS
1. telephony-service
2. web admin system name username {password string | secret {0 | 5} string}
3. dn-webedit
4. time-webedit
5. exit
Command or Action Purpose
Step 1 ip http server
Example:Router(config)# ip http server
Enables the Cisco web browser user interface on the local Cisco ITS router.
Step 2 ip http path flash:
Example:Router(config)# ip http path flash:
Sets the base HTTP path for HTML files to Flash memory on the router.
6-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUISetting Up GUI Access for the System Administrator
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 web admin system name username {password string | secret {0 | 5} string}
Example:Router(config-telephony-service)# web admin system name pwa3 secret 0 wp78pw
Defines a username and password for a system administrator. The default username is Admin. There is no default password.
• name username—System administrator username.
• password string—String to verify system administrator identity. Default is empty string.
• secret {0 | 5} string—Password should be encrypted. The digit specifies state of encryption of the string that follows, as explained here:
– 0—Password that follows is not yet encrypted.
– 5—Password that follows is encrypted using MD5.
Note The secret 5 keyword pair is used in the output of show commands when encrypted passwords are displayed and it indicates that the password that follows is encrypted.
Step 3 dn-webedit
Example:Router(config-telephony-service)# dn-webedit
(Optional) Enables the ability to add directory numbers through the web interface.
The no form of this command disables the ability to create IP phone extension telephone numbers. That ability could disrupt the network-wide management of telephone numbers.
If this command is not used, the ability to create directory numbers is disabled by default.
6-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUIAccessing the Cisco ITS GUI
Troubleshooting Tips
If you are having trouble starting the ITS V3.0 GUI, try the following actions:
• Make sure you are using Microsoft Internet Explorer (IE) Version 5.5 or a later release.
• Clear your browser cache or history.
• Make sure that you have the GUI files for ITS V3.0 in Flash memory. Compare the filenames in Flash memory with the list in the “Prerequisites” section in Chapter 1, “Cisco IOS Telephony Services Overview.” Compare the sizes of files in Flash memory with the sizes of the files in the zipped, compressed archive called its-gui-3.0.0.zip or the tar archive called its-gui-3.0.0.tar to be sure that you have the most recent files installed in Flash memory. Note that the ITS V3.0 GUI does not work with GUI files from earlier ITS versions.
Accessing the Cisco ITS GUI
Note The Cisco ITS GUI requires use of Microsoft Internet Explorer (IE) Version 5.5 or a later release.
To access the Cisco ITS router through the web, point your IE browser to the following URL:
http://ITSrouter_ipaddr/telephony_service.html
where ITSrouter_ipaddr is the IP address of your ITS router.
For example, if the IP address of your ITS router is 10.10.10.176, enter the following:
http://10.10.10.176/telephony_service.html
You are presented with a login screen. Enter your username and password.
The ITS system evaluates your privilege level and presents the appropriate screen. Note that users with Cisco IOS software privilege level 15 also have system-administrator-level privileges in the ITS GUI once they have been authenticated locally or remotely through AAA. The ip http authentication command that has been configured on the ITS router determines where authentication occurs.
Step 4 time-webedit
Example:Router(config-telephony-service)# time-webedit
(Optional) Enables the ability to set the phone time for the ITS system through the web interface.
Note Cisco discourages this method for setting network time. The router should be set up to automatically synchronize its router clock from a network-based clock source using Network Time Protocol (NTP). In the rare case that a network NTP clock source is not available, the time-webedit command can be used to allow manual setting and resetting of the router clock through the ITS GUI.
Step 5 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Command or Action Purpose
6-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUIAccessing the Cisco ITS GUI
After you log in and are authenticated, you see one of the following home screens, based on your user class:
• The system administrator home screen is shown in Figure 6-1 on page 6-6.
• The customer administrator sees a reduced version of the options available from the system administrator screen, according to the XML configuration file that the system administrator created.
• The phone user home screen is shown in Figure 6-2 on page 6-7.
After you log in successfully, online help is available from the Help menu.
Figure 6-1 Cisco ITS GUI System Administrator Home Screen
6-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Figure 6-2 Cisco ITS GUI Phone User Home Screen
Creating Additional GUI Login AccountsAfter creating a system administrator account for GUI access, you can create accounts for customer administrators or for individual phone users so that they can log in to the GUI from their PCs. You can create these accounts using router CLI or by using the GUI itself. These procedures are explained in the following sections:
• Setting Up GUI Access for Customer Administrators
• Setting Up GUI Access for Phone Users
Setting Up GUI Access for Customer AdministratorsThe following tasks are required to set up customer administrator GUI access for an ITS system:
• Creating and Loading an XML Configuration File (required)
• Defining a Customer Administrator (required)
6-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Creating and Loading an XML Configuration File
The XML configuration file specifies the characteristics and features that you want to be available to customer administrators and the characteristics and features that should be restricted from them. The file follows a template that conforms to the Cisco XML DTD, which is documented in Cisco IP Phone Services Application Development Notes. The template is named xml.template and is one of the Cisco ITS files that you download from the Cisco Software Center when you first set up an ITS system. The XML template is shown in Figure 6-3 on page 6-9 and a sample XML file is shown in Figure 6-4 on page 6-10.
Edit and load the XML configuration file by using the following steps:
SUMMARY STEPS
1. Make a copy of the XML template and open it in any text editor.
2. Edit the XML template.
3. Copy the file to a TFTP (or FTP) server on your network that can be accessed by the ITS router.
4. Copy your file to Flash memory on the ITS router.
5. Load the XML file from router Flash memory.
DETAILED STEPS
Step 1 Make a copy of the XML template (shown in Figure 6-3 on page 6-9) and open it in any text editor. Give the file a name that is meaningful to you and that uses “xml” as its suffix. For example, you could name the file “custadm.xml.”
Step 2 Edit the XML template. Within the template, each line that starts with a title enclosed in angle brackets describes an XML object. For example, “<AddExtension>” refers to the Add Extension capability, and “<Type>” refers to the Type field on the Add Extension screen. For each object in the template, you have a choice of actions. Your choices appear within brackets; for example, “[Hide | Show]” indicates that you have a choice between whether this object is hidden or visible when a customer administrator logs into the GUI. Delete the action that you do not want and the vertical bar and brackets around the actions.
For example, to hide the Sequence Number field, change the following text in the template file:
<SequenceNumber> [Hide | Show] </SequenceNumber>
to the following text in your configuration file:
<SequenceNumber> Hide </SequenceNumber>
Edit every line in the template until you have changed each choice in brackets to a single action and you have removed the vertical bars and brackets. A sample XML file is shown in Figure 6-4 on page 6-10.
Step 3 Copy the file to a TFTP (or FTP) server on your network that can be accessed by the ITS router.
Step 4 Copy your file to Flash memory on the ITS router.
Router# copy tftp flash
Step 5 Load the XML file from router Flash memory.
Router(config)# telephony-serviceRouter(config-telephony-service)# web customize load filename Router(config-telephony-service)# exit
6-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Figure 6-3 XML Configuration File Template
<Presentation> <MainMenu> <!-- Take Higher Precedence over CLI "dn-web-edit" --> <AddExtension> [Hide | Show] </AddExtension> <DeleteExtension> [Hide | Show] </DeleteExtension> <AddPhone> [Hide | Show] </AddPhone> <DeletePhone> [Hide | Show] </DeletePhone> </MainMenu>
<Extension> <!-- Control both view and change, and possible add or delete --> <SequenceNumber> [Hide | Show] </SequenceNumber> <Type> [Hide | Show] </Type> <Huntstop> [Hide | Show] </Huntstop> <Preference> [Hide | Show] </Preference> <HoldAlert> [Hide | Show] </HoldAlert> <TranslationRules> [Hide | Show] </TranslationRules> <Paging> [Hide | Show] </Paging> <Intercom> [Hide | Show] </Intercom> <MWI> [Hide | Show] </MWI> <MoH> [Hide | Show] </MoH> <LBDN> [Hide | Show] </LBDN> <DualLine> [Hide | Show] </DualLine> <Reg> [Hide | Show] </Reg> <PGroup> [Hide | Show] </PGroup> </Extension>
<Phone> <!-- control both view and change, and possible add and delete ---> <SequenceNumber> [Hide | Show] </SequenceNumber> </Phone>
<System> <!-- Control View Only --> <PhoneURL> [Hide | Show] </PhoneURL> <PhoneLoad> [Hide | Show]</PhoneLoad> <CallHistory> [Hide | Show] </CallHistory> <MWIServer> [Hide | Show] </MWIServer> <!-- Control Either View and Change or Change Only --> <TransferPattern attr=[Both | Change]> [Hide | Show] </TransferPattern> <VoiceMailNumber attr=[Both | Change]> [Hide | Show] </VoiceMailNumber> <MaxNumberPhone attr=[Both | Change]> [Hide | Show] </MaxNumberPhone> <DialplanPattern attr=[Both | Change]> [Hide | Show] </DialplanPattern> <SecDialTone attr=[Both | Change]> [Hide | Show] </SecDialTone> <Timeouts attr=[Both | Change]> [Hide | Show] </Timeouts> <CIDBlock attr=[Both | Change]> [Hide | Show] </CIDBlock> <HuntGroup attr=[Both | Change]> [Hide | Show] </HuntGroup> <NightSerBell attr=[Both | Change]> [Hide | Show] </NightSerBell> <!-- Control Change Only --> <!-- Take Higher Precedence over CLI "time-web-edit" --> <Time> [Hide | Show] </Time> </System>
<Function> <AddLineToPhone> [No | Yes] </AddLineToPhone> <DeleteLineFromPhone> [No | Yes] </DeleteLineFromPhone> <NewDnDpCheck> [No | Yes] </DpDnCrossCheck> <MaxLinePerPhone> [1-6] </MaxLinePerPhone> </Function></Presentation>
6-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Figure 6-4 Sample XML Configuration File
sample.xml <Presentation> <MainMenu>
<AddExtension> Hide </AddExtension> <DeleteExtension> Hide </DeleteExtension> <AddPhone> Hide </AddPhone> <DeletePhone> Hide </DeletePhone>
</MainMenu>
<Extension> <SequenceNumber> Hide </SequenceNumber> <Type> Hide </Type> <Huntstop> Hide </Huntstop> <Preference> Hide </Preference> <HoldAlert> Hide </HoldAlert> <TranslationRule> Hide </TranslationRule> <Paging> Show </Paging><Intercom> Hide </Intercom><MWI> Hide </MWI><MoH> Hide </MoH><LBDN> Hide </LBDN> <DualLine> Hide </DualLine><Reg> Hide </Reg><PGroup> Show </PGroup>
</Extension>
<Phone> <SequenceNumber> Hide </SequenceNumber>
</Phone>
<System> <PhoneURL> Hide </PhoneURL> <PhoneLoad> Hide </PhoneLoad> <CallHistory> Hide </CallHistory> <MWIServer> Hide </MWIServer> <TransferPattern attr=Both> Hide </TransferPattern> <VoiceMailNumber attr=Both> Hide </VoiceMailNumber> <MaxNumberPhone attr=Both> Hide </MaxNumberPhone> <DialplanPattern attr=Change> Hide </DialplanPattern> <SecDialTone attr=Both> Hide </SecDialTone><Timeouts attr=Both> Hide </Timeouts><CIDBlock attr=Both> Hide </CIDBlock><HuntGroup attr=Change> Hide </HuntGroup><NightSerBell attr=Change> Hide </NightSerBell><Time> Hide </Time>
</System>
<Function> <AddLineToPhone> No </AddLineToPhone> <DeleteLineFromPhone> No </DeleteLineFromPhone> <MaxLinePerPhone> 4 </MaxLinePerPhone>
</Function> </Presentation>
6-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Defining a Customer Administrator
You can define a login account for a customer administrator in either of the following two ways:
• Method 1: Using the ITS GUI to Define a Customer Administrator
• Method 2: Using the Cisco IOS CLI to Define a Customer Administrator
Method 1: Using the ITS GUI to Define a Customer Administrator
The following steps use the ITS GUI itself to create a customer administrator login account for the ITS GUI.
SUMMARY STEPS
1. From the Configure System Parameters menu, choose Administrator’s Login Account.
2. Complete the Admin User Name (username), Admin User Type (Customer), and New Password fields.
3. Click Change.
DETAILED STEPS
Step 1 From the Configure System Parameters menu, choose Administrator’s Login Account. You see the screen shown in Figure 6-5 on page 6-12.
Step 2 Complete the Admin User Name (username), Admin User Type (Customer), and New Password fields for the user that you are defining as a customer administrator. Type the password again to confirm it.
Step 3 Click Change for your changes to become effective.
6-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Figure 6-5 Using the ITS GUI to Define a Customer Administrator
Method 2: Using the Cisco IOS CLI to Define a Customer Administrator
This task creates a customer administrator account for the ITS GUI by using the Cisco IOS CLI.
SUMMARY STEPS
1. telephony-service
2. web admin customer name username password string
3. exit
6-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
DETAILED STEPS
Setting Up GUI Access for Phone UsersYou can enable GUI access for a phone user in either of the following two ways:
• Method 1: Using the ITS GUI to Define the GUI Login for a Phone User
• Method 2: Using the Cisco IOS CLI to Define the GUI Login for a Phone User
Method 1: Using the ITS GUI to Define the GUI Login for a Phone User
This method uses the ITS GUI itself to create a GUI login account for a phone user.
SUMMARY STEPS
1. From the Configure Phones menu, choose Add Phone or Change Phone.
2. Enter a username and password in the Login Account area of the screen.
3. Click Change.
DETAILED STEPS
Step 1 From the Configure Phones menu, choose Add Phone to add GUI access for a user with a new phone or Change Phone to add GUI access for a user with an existing phone. You see the Add Phone screen or the Change Phone screen as shown in Figure 6-6 on page 6-14.
Step 2 Enter a username and password in the Login Account area of the screen. If you are adding a new phone, complete the other fields as appropriate.
Step 3 Click Change for your edits to become effective.
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 web admin customer name username password string
Example:Router(config-telephony-service)# web admin customer name user44 password pw10293847
Defines a username and password for a customer administrator. The default username is Customer. There is no default password.
• name username—Username of customer administrator.
• password string—String to verify customer administrator identity.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
6-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUICreating Additional GUI Login Accounts
Figure 6-6 Using the ITS GUI to Define a Phone User
Method 2: Using the Cisco IOS CLI to Define the GUI Login for a Phone User
This method uses the Cisco IOS CLI to create an ITS GUI login account for a phone user.
SUMMARY STEPS
1. ephone phone-tag
2. username username password password
3. exit
6-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUIWhat to Do Next
DETAILED STEPS
What to Do NextOnce you have set up your ITS system and phones, call transfer, call forwarding, and the ITS GUI, you can use the GUI to complete your specification of optional ITS features. These tasks are documented in online help in the ITS GUI itself.
The remaining chapters in this guide explain how to configure the same optional ITS features using the Cisco IOS CLI on the ITS router.
Command or Action Purpose
Step 1 ephone tag
Example:Router(config)# ephone 2
Enters ephone configuration mode to register Cisco IP phones.
Step 2 username username password password
Example:Router(config-ephone)# username prx password pk59wq
Assigns a phone user login account name and password. This allows individual phone users to log in to the Cisco ITS router through a web interface and change their personal settings.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits ephone configuration mode.
6-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 6 Setting Up the ITS GUIWhat to Do Next
6-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 7
Setting Up Optional ITS System FeaturesThis chapter describes features that are set up for all phone users systemwide in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Secondary Dial Tone, page 7-1
• Interdigit Timeout, page 7-2
• Ringing Timeout, page 7-3
• Music on Hold, page 7-4
Secondary Dial ToneA secondary dial tone is available for Cisco IP phones that are running ITS. The secondary dial tone is generated when a phone user dials a predefined PSTN access prefix and terminates when additional digits are dialed. An example is when a secondary dial tone is heard after the number 9 is dialed to reach an outside line.
SUMMARY STEPS
1. telephony-service
2. secondary-dialtone digit-string
3. exit
7-1Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesInterdigit Timeout
DETAILED STEPS
Example
The following example sets the number 8 to trigger a secondary dial tone:
telephony-servicesecondary-dialtone 8
Interdigit Timeout This task configures the interdigit timeout value for all Cisco IP phones. The interdigit timeout is the amount of time that can elapse between the dialing of digits before the dialing process times out and is terminated.
SUMMARY STEPS
1. telephony-service
2. timeouts interdigit seconds
3. exit
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 secondary-dialtone digit-string
Example:Router(config-telephony-service)# secondary-dialtone 9
Activates a secondary dial tone when digit-string is dialed.
• digit-string—String of up to 32 digits that, when dialed, activates a secondary dial tone.Typical usage is that digit-string contains a single digit.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
7-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesRinging Timeout
DETAILED STEPS
Example
The following example sets an interdigit timeout of 30 seconds:
telephony-servicetimeouts interdigit 30
Ringing TimeoutThe ringing timeout is the amount of time a phone can ring with no answer before returning a disconnect code to the caller. This timeout is used only for extensions that do not have no-answer call forwarding enabled. The ringing timeout prevents hung calls received over interfaces such as Foreign Exchange Office (FXO) that do not have forward-disconnect supervision.
SUMMARY STEPS
1. telephony-service
2. timeouts ringing seconds
3. exit
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 timeouts interdigit seconds
Example:Router(config-telephony-service)# timeouts interdigit 30
Configures the interdigit timeout value for all Cisco IP phones attached to the router.
The interdigit timeout specifies the number of seconds that the system waits after the caller has entered the initial digit or a subsequent digit of the dialed string. If the timeout ends before the destination is identified, a tone sounds and the call ends. This value is important when using variable-length dial-peer destination patterns (dial plans). For more information on setting dial plans, refer to the “Configuring Dial Plans, Dial Peers, and Digit Manipulation” chapter of the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2.
• seconds—Number of seconds before the interdigit timer expires. Range is from 2 to 120. Default is 10.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
7-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
DETAILED STEPS
Example
The following example sets the ringing timeout default to 30 seconds:
telephony-servicetimeouts ringing 30
Music on HoldMusic on hold (MOH) is an audio stream that is played to PSTN and VoIP G.711 callers who are placed on hold by phones in an ITS system. This audio stream is intended to reassure callers that they are still connected to their calls. MOH is not played to local ITS phones that are on hold with other ITS phones; these parties hear a periodic repeating tone instead.
The audio stream that is used for MOH can derive from one of two sources: an audio file or a live feed. If both are configured concurrently on the ITS router, the router seeks the live feed first. If the live feed is found, it displaces the audio file source. If the live feed is not found or fails at any time, the router falls back to the audio file source that was specified for MOH during configuration.
If the MOH audio stream is also identified as a multicast source, the ITS router additionally transmits the stream on the physical IP interfaces of the ITS router that you specify during configuration, which permits external devices to have access to it.
A MOH audio stream from an audio file is supplied from an .au or .wav file held in router Flash memory. A MOH audio stream from a live feed is supplied from a standard line-level audio connection that is directly connected to the router through an FXO or “ear and mouth” (E&M) analog voice port. The live-feed feature is typically used to connect to a CD jukebox player. Only one live MOH feed is supported per system.
Configuration of MOH is explained in the following sections:
• Configuring Music on Hold from an Audio File, page 7-5
• Configuring Music on Hold from a Live Feed, page 7-7
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 timeouts ringing seconds
Example:Router(config-telephony-service)# timeouts ringing 30
Sets the duration, in seconds, for which the ITS system allows ringing to continue if a call is not answered. Range is from 5 to 60000. The default is 180.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
7-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
Configuring Music on Hold from an Audio FileThis section explains how to configure music on hold when you are using a file to supply the audio stream. You can also optionally specify that this audio stream should be multicast on router interfaces.
If MOH from an audio file and MOH from a live feed are both configured on the ITS router, the router seeks the live feed first. If a live feed is found, it displaces an audio file source. If the live feed is not found or fails at any time, the router falls back to the audio file source.
To change the audio file to a different file, you must remove the first file using the no moh command before specifying a second file, as shown in the following example:
Router(config-telephony-service)# no moh file1Router(config-telephony-service)# moh file2
If you configure a second file without removing the first file, the MOH mechanism stops working and may require a router reboot to clear the problem.
Prerequisites
A music file must be in stored in the router’s Flash memory. This file should be in G.711 format. The file can be in .au or .wav file format, but the file format must contain 8-bit 8-kHz data; for example, Consultative Committee for International Telegraph and Telephone (CCITT) a-law or mu-law data format.
Restrictions
• MOH is supplied only to PSTN and VoIP G.711 calls. Local IP phone callers hear a repeating tone on hold for reassurance that they are still connected.
• IP phones do not support multicast at 224.x.x.x addresses.
SUMMARY STEPS
1. telephony-service
2. moh filename
3. multicast moh ip-address port port-number [route ip-address-list]
4. exit
7-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
DETAILED STEPS
Examples
The following example enables music on hold and specifies the music file to use:
telephony-service moh minuet.wav
The following example enables music on hold and additionally specifies a multicast address for the audio stream:
telephony-service moh minuet.wav multicast moh 239.23.4.10 port 2000
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 moh filename
Example:Router(config-telephony-service)# moh minuet.au
Configures music on hold using the specified file.
• filename—Source of the audio stream for MOH.
Note If you specify a filename with this command and later want to use a different file, you must disable use of the first file with the no moh command before configuring the second file.
Step 3 multicast moh ip-address port port-number [route ip-address-list]
Example:Router(config-telephony-service)# multicast moh 239.10.16.4 port 2123 route 10.10.29.17 10.10.29.33
(Optional) Directs that the MOH audio stream should also be multicast as specified.
• ip-address—Specifies that this audio stream is to be used for multicast as well as for MOH, and specifies the destination IP address for multicast.
• port-number—Media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because it is already used for normal RTP media transmissions between IP phones and the router.
• route—(Optional) Specifies a list of explicit router interfaces on which to transmit the IP multicast packets.
• ip-address-list—(Optional) List of up to four explicit routes for multicast MOH. The default is that the MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command.
Step 4 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
7-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
Configuring Music on Hold from a Live Feed To configure MOH from a live feed, you establish a voice port and dial peer for the call and also create a “dummy” ephone-dn. The ephone-dn must have a phone or extension number assigned to it so that it can make and receive calls, but the number is never assigned to a physical phone.
The recommended interface for live-feed MOH is an analog E&M port because it requires the minimum number of external components. You connect a line-level audio feed (standard audio jack) directly to pins 3 and 6 of an E&M RJ-45 connector. The E&M WAN interface card (WIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. (An audio connection on an E&M port does not require loop-current). The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by a digital signal processor (DSP) on the E&M port.
If you are using an FXO voice port for live-feed MOH instead of an E&M port, connect the MOH source to the FXO voice port. This connection requires an external adapter to supply normal telephone company (telco) battery voltage with the correct polarity to the tip and ring leads of the FXO port. The adapter must also provide transformer-based isolation between the external audio source and the tip and ring leads of the FXO port.
Music from a live feed is continuously fed into the MOH playout buffer instead of being read from a Flash file, so there is typically a 2-second delay. An outbound call to a MOH live-feed source is attempted (or reattempted) every 30 seconds until the connection is made by the directory number that has been configured for MOH. If the live-feed source is shut down for any reason, the Flash memory source will automatically activate.
A live-feed MOH connection is established as an automatically connected voice call that is made by the Cisco ITS MOH system itself or by an external source directly calling in to the live-feed MOH port. A MOH call can be from or to the PSTN or can proceed via VoIP with voice activity detection (VAD) disabled. The call is assumed to be an incoming call unless the optional out-call keyword is used with the moh command during configuration.
The ITS router uses the audio stream from the call as the source for the MOH stream, displacing any audio stream that is available from a Flash file. An example of a MOH stream received over an incoming call is an external H.323-based server device that calls the ephone-dn to deliver an audio stream to the ITS router.
Restrictions
• An FXO port can be used for a live feed if the port is supplied with an external third-party adapter to provide a battery feed.
• An FXS port cannot be used for a live feed.
• For live feed from VoIP, VAD must be disabled.
• MOH is supplied only to PSTN and VoIP G.711 calls. Local IP phone callers hear a repeating tone on hold for reassurance that they are still connected.
SUMMARY STEPS
1. voice-port port
2. input gain decibels
3. auto-cut-through (E&M only)
4. operation 4-wire (E&M only)
7-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
5. signal immediate (E&M only)
6. exit
7. dial peer voice tag pots
8. destination-pattern string
9. port port
10. exit
11. ephone-dn dn-tag
12. number number
13. moh [out-call outcall-number] [ip ip-address port port-number [route ip-address-list]]
14. exit
DETAILED STEPS
Command or Action Purpose
Step 1 voice-port port
Example:Router(config)# voice-port 1/1/0
Enters voice-port configuration mode. To find the correct definition of the port argument for your router, refer to the Cisco IOS Voice Command Reference, Release 12.2 T.
Step 2 input gain decibels
Example:Router(config-voice-port)# input gain 0
Specifies, in decibels, the amount of gain to be inserted at the receiver side of the interface. Acceptable values are integers from –6 to 14.
Step 3 auto-cut-through
Example:Router(config-voice-port)# auto-cut-through
(E&M ports only) Enables call completion when a PBX does not provide an M-lead response. MOH requires that you use this command with E&M ports.
Step 4 operation 4-wire
Example:Router(config-voice-port)# operation 4-wire
(E&M ports only) Selects the 4-wire cabling scheme. MOH requires that you specify 4-wire operation with this command for E&M ports.
Step 5 signal immediate
Example:Router(config-voice-port)# signal immediate
(E&M ports only) For E&M tie trunk interfaces, directs the calling side to seize a line by going off-hook on its E-lead and to send address information as DTMF digits.
Step 6 exit
Example:Router(config-voice-port)# exit
Exits voice-port configuration mode.
Step 7 dial peer voice tag pots
Example:Router(config)# dial peer voice 7777 pots
Enters dial-peer configuration mode.
7-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
Step 8 destination-pattern string
Example:Router(config-dial-peer)# destination-pattern 7777
Specifies either the prefix or the full E.164 telephone number to be used for a dial peer.
Step 9 port port
Example:Router(config-dial-peer)# port 1/1/0
Associates the dial peer with the voice port that was specified in Step 1.
Step 10 exit
Example:Router(config-dial-peer)# exit
Exits dial-peer configuration mode.
Step 11 ephone-dn dn-tag
Example:Router(config)# ephone-dn 55
Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies this ephone-dn during configuration tasks. Range is from 1 to 288.
Step 12 number number
Example:Router(config-ephone-dn)# number 5555
Configures a valid extension number for this ephone-dn instance. This number is not assigned to any phone; it is only used to make and receive calls that contain an audio stream to be used for MOH.
• number—String of up to 16 digits that represents a telephone or extension number to be associated with this ephone-dn.
Command or Action Purpose
7-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
Example
The following example enables MOH from an outgoing call on voice port 1/1/0 and dial peer 7777:
voice-port 1/1/0auto-cut-throughoperation 4-wiresignal immediate
!dial-peer voice 7777 potsdestination-pattern 7777port 1/1/0
!ephone-dn 55number 5555moh out-call 7777
Step 13 moh [out-call outcall-number] [ip ip-address port port-number [route ip-address-list]]
Example:Router(config-ephone-dn)# moh out-call 7777 ip 239.10.16.8 port 2311 route 10.10.29.3 10.10.29.45
Specifies that this ephone-dn is to be used for an incoming or outgoing call that is to be the source for a MOH stream. If this command is used without the out-call keyword, the MOH stream is received from an incoming call.
• out-call outcall-number—(Optional) Indicates that the router is calling out for a live feed that is to be used for MOH and specifies the number to be called. Forces a connection to the local router voice port that was specified in Step 1.
• ip ip-address—(Optional) Indicates that this audio stream is to be used as a multicast source as well as for MOH, and specifies the destination IP address for multicast.
Note If you specify a multicast address with this command and a different multicast address with the multicast moh command under telephony-service configuration mode, you can send the MOH audio stream to two multicast addresses.
• port port-number—(Optional) Media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because it is already used for RTP media transmissions between IP phones and the router.
• route ip-address-list—(Optional) Indicates specific router interfaces on which to transmit the IP multicast packets. Up to four IP addresses can be listed. The default is that the MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command.
Step 14 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Command or Action Purpose
7-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
Troubleshooting Tips
The following commands can help troubleshoot live-feed MOH:
• debug ephone moh
• show ephone summary—Note that this command provides extended output if the debug ephone moh command is enabled.
7-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 7 Setting Up Optional ITS System FeaturesMusic on Hold
7-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 8
Configuring ITS Phone FeaturesThis chapter describes optional features that affect individual IP phone use in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Related Features, page 8-1
• Automatic Line Selection, page 8-2
• On-Hook Dialing, page 8-3
• Three-Party G.711 Conference Calls, page 8-4
• Caller ID Blocking on Outbound Calls, page 8-5
• Caller ID Blocking per Call, page 8-6
• Callback Busy Subscriber, page 8-7
• Speed-Dial Features, page 8-7
• Configurable Phone Displays, page 8-14
Related Features• A configurable label supplies text that is displayed next to a line button for an ephone-dn. See the
“Label Support” section in Chapter 10, “Configuring an Attendant for Primary Call Coverage.”
• Call pickup and call pickup groups are described in Chapter 12, “Configuring Secondary Call Coverage.”
• Paging and intercom features are described in Chapter 14, “Configuring Productivity Tools.”
8-1Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesAutomatic Line Selection
Automatic Line SelectionFor a multiline phone, it is often useful to set up the phone so that lifting the handset automatically selects the first ringing line on the phone or, if no line is ringing, selects the first available idle line on the phone. This is the behavior of all multiline IP phones before ITS V3.0.
Under some circumstances, however, you might want to specify that a line button must be explicitly pressed to select an outgoing line or to answer an incoming call. Starting in ITS V3.0, you have the flexibility to assign the type of line selection that each IP phone employs.
Any of the following behaviors can be assigned on a per-phone basis:
• Automatic line selection—Picking up the handset answers the first ringing line or, if no line is ringing, selects the first idle line.
• Manual line selection (no automatic line selection)—Pressing the Answer soft key answers the first ringing line, and pressing a line button selects a line for an outgoing call. Picking up the handset does not answer calls or provide dial tone.
• Automatic line selection for incoming calls only—Picking up the handset answers the first ringing line, but if no line is ringing, it cannot select an idle line for an outgoing call. Pressing a line button selects a line for an outgoing call.
SUMMARY STEPS
1. ephone phone-tag
2. [no] auto-line [incoming]
3. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 24
Enters ephone configuration mode.
• phone-tag—Unique sequence number for the phone on which you want to configure automatic line selection.
8-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesOn-Hook Dialing
Example
The following example assigns no automatic line selection to phones 1 and 2 and assigns automatic line selection for incoming calls only to phone 3:
ephone 1mac-address 00e0.8646.9242button 1:1 2:4 3:16no auto-line
ephone 2mac-address 01c0.4612.7142button 1:5 2:4 3:16no auto-line
ephone 3mac-address 10b8.8945.3251button 1:6 2:4 3:16auto-line incoming
On-Hook DialingOn-hook dialing allows you to enter dialed digits with the phone on-hook and the handset still in its cradle. Digits appear in the phone display as they are dialed, and a Backspace soft key (<<) allows you to erase digits that are entered incorrectly. When you have finished entering the digits and want the phone to dial the number, use one of the following methods:
• Press a line button or the Dial soft key if you are using the phone speaker or a headset.
• Pick up the handset.
No configuration is required to activate this feature.
Step 2 [no] auto-line [incoming]
Example:Router(config-ephone)# no auto-line
Assigns a type of line selection behavior to this phone.
• auto-line—Picking up a handset answers the first ringing line or, if no line is ringing, selects the first idle line. This is also the default if this command is not used.
• no auto-line—Pressing the Answer soft key answers the first ringing line, and pressing a line button selects a line for an outgoing call. Picking up the handset does not answer calls or provide dial tone.
• auto-line incoming—Picking up the handset answers the first ringing line but, if no line is ringing, does not select an idle line for an outgoing call. Pressing a line button selects a line for an outgoing call.
Step 3 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Command or Action Purpose
8-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesThree-Party G.711 Conference Calls
Three-Party G.711 Conference Calls Cisco ITS supports three-party conference for local and on-net calls. To participate in a conference, all conference participants must use G.711. This service also supports conversion between G.711 mu-law and a-law. The maximum number of simultaneous conferences is platform-specific.
SUMMARY STEPS
1. telephony-service
2. max-conferences max-conference-number
3. exit
DETAILED STEPS
Example
The following example sets 6 as the maximum number of simultaneous three-party conferences for an ITS system.
telephony-servicemax-conferences 6
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 max-conferences max-conference-number
Example:Router(config-telephony-service)# max-conferences 6
Sets the maximum number of simultaneous three-party conferences supported by the ITS router. The default is half of the maximum simultaneous three-party conferences per platform.
The maximum number of simultaneous three-party conferences supported by a router is platform-dependent:
• 8—Cisco 1751, Cisco 1760, Cisco 2610XM, Cisco 2611XM, Cisco 2620XM, Cisco 2621XM, Cisco 2650XM, Cisco 2691, Cisco 3640, Cisco 3640A
• 16—Cisco 3660, Cisco 3725, Cisco 3745
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
8-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesCaller ID Blocking on Outbound Calls
Caller ID Blocking on Outbound CallsThis task configures caller ID blocking for calls that are outbound from a particular ephone-dn.
RestrictionsCaller ID blocking does not apply to PSTN calls that are made through FXO ports. Caller ID features on FXO-connected subscriber lines are under the control of your PSTN service provider, who may require that you subscribe to their caller ID blocking service.
SUMMARY STEPS
1. ephone-dn dn-tag
2. caller-id block
3. exit
DETAILED STEPS
Example
The following example sets caller ID blocking for the ephone-dn with tag 3.
ephone-dn 3caller-id block
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 3
Enters ephone-dn configuration mode.
Step 2 caller-id block
Example:Router(config-ephone-dn)# caller-id block
Configures caller ID blocking for outbound calls that originate from this ephone-dn. This command requests the far-end gateway device to block display of calling-party information for the calls received from this ephone-dn. This configuration does not affect the ephone-dn calling-party information display for inbound calls received by the ephone-dn.
By default, caller ID is not blocked on calls that originate from a Cisco IP phone.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
8-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesCaller ID Blocking per Call
Caller ID Blocking per CallThe display of caller ID can be blocked for outgoing calls on a per-call basis, allowing users to maintain their privacy when necessary. The system administrator first defines a code for caller ID blocking in the system. Users can then dial the code prior to making any call on which they do not want their number displayed on the called-party phone. The caller ID is still sent, but its presentation parameter is set to “restricted” so that the caller ID is not displayed.
To enable caller ID blocking on a per-call basis, a system administrator must first define a code. Users then enter the code prior to making calls on which they do not want their number sent.
SUMMARY STEPS
1. telephony-service
2. caller-id block code code-string
3. exit
DETAILED STEPS
Example
The following example defines a code of *1234 for users to enter to block caller ID on their outgoing calls:
telephony-servicecaller-id block code *1234
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 caller-id block code code-string
Example:Router(config-telephony-service)# caller-id block code *1234
Defines a code to be entered before making calls on which the caller ID should not be sent.
• code-string—Digit string of up to 16 characters. The first character must be an asterisk (*).
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
8-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesCallback Busy Subscriber
Callback Busy SubscriberThis feature allows callers who dial a busy extension number to request a callback from the system when a called number that was busy is free. Callers can also request callbacks for extensions that do not answer, and the system will notify them after the called phone is next used.
This feature is available only on the Cisco IP Phone 7940 and Cisco IP Phone 7960.
To activate the callback feature after dialing an extension number and hearing a busy or no-answer tone, press the CallBack soft key. When the system calls back to notify you that the called line is free, the phone rings once, briefly, and displays “CallBack Redial” and the extension number. To call the number, press the Redial soft key.
There can be only one callback request pending against a particular extension number, although one caller may initiate a number of callbacks to different numbers. If a caller attempts to place a callback request on a number that already has a pending callback request, the caller hears a fast-busy tone.
If the called number has call forwarding enabled, the callback request is placed against the final destination number.
No configuration is required for this feature. The show ephone callback command lists phones that have pending callback requests against them.
Speed-Dial FeaturesThis section describes the following three types of speed-dial features:
• Speed-Dial Buttons—Unused extension buttons can be assigned personal speed-dial numbers that can be programmed by phone users or programmed and locked by system administrators. Phone users access personal speed-dial numbers by pressing the button associated with the number desired. Analog phone users with ATA devices access personal speed-dial numbers by pressing asterisk (*) and the digit associated with the number desired.
• Local Speed Dial—A set of common, systemwide speed-dial numbers can be programmed for all phones in an ITS system. Phone users access local speed-dial numbers through the Directories > Local Services > Local Speed Dial menu.
• Personal Speed Dial—Up to 24 personal speed-dial numbers can be programmed on each Cisco IP Phone 7940 or Cisco IP Phone 7960. Phone users access personal speed-dial numbers through the Directories > Local Services > Personal Speed Dial menu.
Speed-Dial ButtonsIP phone buttons that are not used for extensions can be programmed as speed-dial buttons. An administrator must first configure the phone with speed-dial definitions. The speed-dial definitions are then used to automatically populate the unused buttons with speed-dial functionality. For example, an administrator creates four speed-dial definitions for a six-button phone on which only two buttons are assigned to phone extensions. The remaining four buttons are assigned to the four speed-dial definitions and can be programmed with speed-dial numbers by the administrator or by the user.
An administrator can create a speed-dial definition with or without an associated speed-dial number. If the speed-dial definition has a number in it, the administrator can lock the number so that it cannot be changed from the phone. If the number is not locked or if there is no number associated with the definition, the phone user can program a speed-dial number from the phone. If more definitions are created than there are buttons available on a phone, the extra definitions are ignored.
8-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesSpeed-Dial Features
Analog phone users who use Cisco ATA-186 or Cisco ATA-188 devices to connect to ITS have a different method to access speed-dial numbers. Instead of pressing a speed-dial button, Phone users with ATA devices press the asterisk key and the number of a speed-dial identifier to dial a speed-dial number. For instance, a phone user with an ATA-186 would press *1 to dial the number that has been programmed as speed-dial 1. Phones with ATA devices are limited to a maximum of 9 speed-dial numbers that must be programmed by the system administrator. The numbers cannot be programmed from the phone. With phones that use ATA devices, system administrators must be sure to tell phone users when speed-dial numbers have been programmed for their phones.
The following tasks are contained in this section:
• Defining Speed-Dial Button Information from ITS Router CLI, page 8-8
• Changing Existing Speed-Dial Button Information from an IP Phone, page 8-10
Defining Speed-Dial Button Information from ITS Router CLI
Speed-dial definitions can be added or modified by an administrator from the Cisco ITS router CLI. The numbers can be locked so that they cannot be changed from the phone. Changes that are made to speed-dial button definitions are saved into the router NVRAM configuration after a timer-based delay.
A speed-dial definition consists of a unique identifier (dial-tag), a number to dial, and an optional label. Definitions are automatically assigned to any phone buttons that remain unused after all the extensions have been assigned to a phone. Definitions are assigned in the order of their speed-dial identifier (dial-tag) numbers. Note that these identifier numbers are not related to the physical button layout of the phone.
For example, speed-dial 1 is assigned to the first button that is available for speed-dial purposes, not to the first (topmost) button on the phone. If you have two extensions and four speed-dial definitions on a six-button phone, speed-dial 1 appears on the third physical button on the phone (the first button that is available for speed-dial). The button that a particular speed-dial definition is assigned to will change automatically if the number of buttons used for extensions changes. Using the previous example, if you added a third extension to this phone on button 3, speed-dial 1 would move to button 4 (which is now the first button that is available for speed dial). The first three buttons would contain extensions and the final three buttons would contain speed-dial definitions. The fourth speed-dial definition would no longer appear on the phone because there would not be a button available for it. The fourth speed-dial definition is simply ignored.
SUMMARY STEPS
1. ephone phone-tag
2. speed-dial speed-tag digit-string [label label-text]
3. restart
4. exit
8-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesSpeed-Dial Features
DETAILED STEPS
Example
The following example defines two locked speed-dial numbers with labels to appear next to the speed-dial buttons. These speed-dial definitions are assigned to the next empty buttons after all extensions have been assigned. For instance, if two extensions are assigned on a Cisco IP Phone 7960, these speed-dial definitions appear on the third and fourth buttons.
ephone 1mac-address 1234.5678.ABCDbutton 1:24 2:25speed-dial 1 +5002 label Receptionistspeed-dial 2 +5001 label Security
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 55
Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies the phone on which you are adding speed-dial capability.
Step 2 speed-dial speed-tag digit-string [label label-text]
Example:Router(config-ephone)# speed-dial 1 +5001 label “Head Office”
Defines a unique speed-dial identifier, a digit string to dial, and an optional label to display next to the button. There can be a maximum of 34 speed-dial definitions for IP phones and 9 for phones with ATA adaptors.
• speed-tag—Identifier for a speed-dial definition. Range is from 1 to 34.
• digit-string—Digits to be dialed when the speed-dial button is pressed. If the first character of this string is the plus sign (+), this speed-dial number is locked and cannot be changed at the phone. If the only character in this string is a pound sign (#), an empty speed-dial definition is defined with no speed-dial number attached to it. An empty speed-dial definition can be programmed at the phone.
• label label-text—Keyword and string that contains identifying text to be displayed next to the speed-dial button. Enclose the string in quotation marks if it includes spaces. Maximum length is 32 characters, but the phone is only able to display 16 characters.
Step 3 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 4 exit
Example:Router(config-ephone)# exit
Exits ephone-dn configuration mode.
8-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesSpeed-Dial Features
Changing Existing Speed-Dial Button Information from an IP Phone
Once an administrator has created one or more speed-dial definitions for an IP phone, the phone user can reprogram buttons without numbers or buttons with unlocked numbers by using the following steps.
SUMMARY STEPS
1. Select an IP phone button that has a speed-dial definition associated with it.
2. Press the pound key (#).
3. Press the speed-dial button that you want to program.
4. Enter the speed-dial number.
5. Press the speed-dial button that you are programming a second time.
6. Hang up the receiver or press a new speed-dial button.
DETAILED STEPS
Step 1 Select an IP phone button that has a speed-dial definition associated with it. The speed-dial definition must be empty (no speed-dial number was assigned during configuration) or unlocked (a speed-dial number was assigned but the number was not locked by the administrator). Listen for the dial tone.
Step 2 Press the pound key (#).
Step 3 Press the speed-dial button that you want to program. A short beep confirms that you are starting to program this button.
Step 4 Enter the speed-dial number. The digits are output to the phone display. When speed-dial numbers are entered on a Cisco IP Phone 7940 or Cisco IP Phone 7960, the Backspace soft key (<<) is available to let you correct digits that were typed incorrectly. To remove a speed-dial number without replacing it with a new one, press the pound key (#).
Step 5 Press the speed-dial button that you are programming a second time to indicate that you have finished entering the speed-dial digits and to store the new speed-dial number.
Step 6 Hang up the receiver or press a new speed-dial button, and repeat the process.
8-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesSpeed-Dial Features
Local Speed Dial The local speed dial feature provides a systemwide list of frequently called numbers that can be programmed by an administrator on all phones, up to a maximum of 32 entries. Local speed-dial numbers are available from the Directories button on a phone.
To define local speed-dial numbers, a system administrator first creates an XML file called speeddial.xml, similar to the example shown in Figure 8-1 on page 8-11. After the administrator places the speeddial.xml file in the ITS router’s Flash memory, the local speed-dial menu appears when Local Speed Dial is selected from the Directories menu.
Prerequisites
• In any text editor, create a file called speeddial.xml in the Cisco-specified directory DTD format. Use the keywords and format shown in Figure 8-1 on page 8-11 to specify names and numbers for a local speed-dial list. For more information about Cisco DTD formats, refer to Cisco IP Phone Services Application Development Notes.
• Copy the file to the TFTP server application on the ITS router.
Figure 8-1 Sample speeddial.xml file
<CiscoIPPhoneDirectory><Title>Local Speed Dial</Title><Prompt>Record 1 to 1 of 1 </Prompt>
<DirectoryEntry><Name>Security</Name><Telephone>71111</Telephone>
</DirectoryEntry>
<DirectoryEntry><Name>Marketing</Name><Telephone>71234</Telephone>
</DirectoryEntry>
<DirectoryEntry><Name>Tech Support</Name><Telephone>71432</Telephone>
</DirectoryEntry>
</CiscoIPPhoneDirectory>
SUMMARY STEPS
1. copy tftp flash
2. configure terminal
3. ip http server
4. ip http path flash:
8-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesSpeed-Dial Features
DETAILED STEPS
Example
The following example enables the Cisco web browser and sets the HTTP path to Flash memory so that the speeddial.xml file in Flash memory is accessible to IP phones:
ip http serverip http path flash:
Troubleshooting Tips
Use the debug ephone detail command to diagnose problems with local speed-dial numbers.
Command or Action Purpose
Step 1 copy tftp flash
Example:Router# copy tftp flash
Address or name of remote host []? 172.24.59.11Source filename []? speeddial.xmlDestination filename [speeddial.xml]?Accessing tftp://172.24.59.11/speeddial.xml...Erase flash:before copying? [confirm]nLoading speeddial.xml from 172.24.59.11 (viaFastEthernet0/0):![OK - 329 bytes]
Verifying checksum... OK (0xF5DB)329 bytes copied in 0.044 secs (7477 bytes/sec)
Copies the file from the TFTP server to the router Flash memory.
• At the first prompt, enter the IP address or the DNS name of the remote host.
• At both filename prompts, enter speeddial.xml.
• At the prompt to erase Flash, enter no.
Step 2 configure terminal
Example:Router# configure terminal
Enters global configuration mode.
Step 3 ip http server
Example:Router(config)# ip http server
Enables the Cisco web-browser user interface on the ITS router.
Step 4 ip http path flash:
Example:Router(config)# ip http path flash:
Sets the base HTTP path to Flash memory.
8-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesSpeed-Dial Features
Personal Speed DialThe personal speed-dial feature allows you to program up to 24 personal speed-dial numbers per IP phone. This feature is available only on the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
Personal speed-dial numbers appear as menu entries displayed from the Directories > Local Services > Personal Speed Dials option on the Cisco IP Phone 7940 and Cisco IP Phone 7960. Personal speed-dial entries are displayed in the order in which they were entered.
SUMMARY STEPS
1. ephone phone-tag
2. fastdial dial-tag number name name-string
3. exit
DETAILED STEPS
Example
The following example creates a directory of three personal speed-dial listings for one IP phone:
ephone 1fastdial 1 5489 name Marketingfastdial 2 12125550155 name Sales-NYfastdial 3 12135550112 name Sales-LA
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 1
Enters ephone configuration mode.
• phone-tag—Unique sequence number for the phone for which you want to program personal speed-dial numbers.
Step 2 fastdial dial-tag number name name-string
Example:Router(config-ephone)# fastdial 1 5552 name Sales
Creates an entry for a personal speed-dial number on this IP phone.
• dial-tag—Unique identifier to identify this entry during configuration. Range is from 1 to 24.
• number—Telephone number or extension to be dialed.
• name name-string—Label to appear in the Personal Speed Dial menu containing a string of up to 24 alphanumeric characters.
Step 3 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
8-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
Configurable Phone DisplaysThe following types of displays on IP phones can be customized for phone users on an ITS system:
• IP Phone Header Bar, page 8-14
• System Text Message for the Cisco IP Phone 7940 and Cisco IP Phone 7960, page 8-15
• System Display Message (Idle URL) for the Cisco IP Phone 7940 and Cisco IP Phone 7960, page 8-16
• URL Provisioning for Customized Function Buttons, page 8-18
IP Phone Header BarNormally the IP phone header bar, or top line, of a Cisco IP Phone 7940 or Cisco IP Phone 7960 replicates the text that appears next to the first line button. The header bar is shown in Figure 8-2. The header bar can, however, contain a user-definable message instead of the extension number. For example, the header bar can be used to display a name or the full E.164 number of the phone. If no description is specified, the header bar replicates the extension number that appears next to the first button on the phone.
Figure 8-2 Cisco IP Phone Display
SUMMARY STEPS
1. ephone-dn dn-tag
2. description display-text
3. exit
4. ephone phone-tag
5. restart
6. exit
13:09 06/08/01 3270Title line
Content linesService window
Header bar
Prompt and status area
Softkey 1 Softkey 2 Softkey 3 Softkey 4 8287
8
8-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
DETAILED STEPS
Example
The following example provides the full E.164 number for a phone line in the phone header bar:
ephone-dn 55description 408-555-0149
System Text Message for the Cisco IP Phone 7940 and Cisco IP Phone 7960For the Cisco IP Phone 7940 and Cisco IP Phone 7960, the system text message feature allows you to set the default static text display for phones that are idle. If no message is set, the default message “Cisco IOS Telephony Services” is displayed.
The number of characters that can be displayed is not fixed because IP phones typically use a proportional (as opposed to fixed-width) font. There is room for approximately 30 alphanumeric characters.
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 55
Enters ephone-dn configuration mode.
• dn-tag—The unique sequence number that identifies the ephone-dn for which the description should be in effect.
Step 2 description display-text
Example:Router(config-ephone-dn)# description 408-555-0134
Defines a description for the header bar of a Cisco IP Phone 7940 or Cisco IP Phone 7960 that has the specified ephone-dn associated with its first line button.
• display-text—Alphanumeric character string, up to 40 characters. String is truncated to 14 characters in the display.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Step 4 ephone phone-tag
Example:Router(config)# ephone 1
Enters ephone configuration mode.
• phone-tag—Unique sequence number of the ephone on which the new description appears.
Step 5 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 6 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
8-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
The display message is refreshed with a new message after one of the following events occurs:
• Busy phone goes back on-hook.
• Idle phone receives a keepalive message.
• Phone is restarted.
A similar feature allows you to name a URL that contains a file that you want displayed on idle phones. See the “System Display Message (Idle URL) for the Cisco IP Phone 7940 and Cisco IP Phone 7960” section on page 8-16.
SUMMARY STEPS
1. telephony-service
2. system message text-message
3. exit
DETAILED STEPS
Example
The following example specifies text that should be displayed on IP phones when they are not being used:
telephony-servicesystem message ABC Company
System Display Message (Idle URL) for the Cisco IP Phone 7940 and Cisco IP Phone 7960
The system display message feature allows you to specify a file to display on Cisco IP Phone 7940s and Cisco IP Phone 7960s when they are not in use. You can use this feature to provide the phone display with a system message that is refreshed at configurable intervals, similar to the way that the system text
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 system message text-message
Example:Router(config-telephony-service)# system message ABC Company
Sets the message to display when a phone is idle.
• text-message—Alphanumeric string to display. Display uses proportional-width font, so the number of characters that are displayed varies based on the width of the characters that are used. The maximum number of displayed characters is approximately 30.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
8-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
message feature provides a message. The difference between the two is that the system text message feature displays a single line of text at the bottom of the phone display, whereas the system display message feature can use the entire display area and contain graphic images. For more information about the system text message feature, see the “System Text Message for the Cisco IP Phone 7940 and Cisco IP Phone 7960” section on page 8-15.
The system display message feature requires a back-end web server to serve the browser page to the phone display, as the ITS system only provisions the URL. The system display message display can also provide soft keys for the phone and thereby take input from the phone user for interactive services.
To specify an system display message for idle phones, you specify a URL that contains an XML file to be displayed on Cisco IP Phone 7940s and Cisco IP Phone 7960s that are not in use. You also specify the refresh interval for the display, in seconds. The file can contain text, icons, or images, and must conform to the Cisco XML DTD that is described in Cisco IP Phone Services Application Development Notes.
SUMMARY STEPS
1. telephony-service
2. url idle url idle-timeout seconds
3. exit
DETAILED STEPS
Example
The following example specifies that a file called logo.htm should be displayed on IP phones when they are not being used:
telephony-serviceurl idle http://www.abcwrecking.com/public/logo.htm idle-timeout 35
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 url idle url idle-timeout seconds
Example:Router(config-telephony-service)# url idle http://www.abcwrecking.com/public/logo idle-timeout 35
Defines a URL that contains a file to display on the phone when the phone is not in use, and specifies the interval between refreshes of the display, in seconds.
• url—Any URL that conforms to RFC 2396.
• seconds—Range is from 0 to 300.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
8-17Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
URL Provisioning for Customized Function ButtonsThe Cisco IP Phone 7940 and the Cisco IP Phone 7960 have customized function buttons that show the phone call status and activities on the display panels. These customized function buttons also invoke programmable noncall-related services. The four buttons—Services, Directories, Messages, and Information (the i button)—are linked to appropriate feature operations through programmable URLs. You cannot customize the Settings button.
Specific URLs are provisioned on the Cisco IP phone to populate these buttons. The URLs point to XML-based web pages formatted with XML tags that the Cisco IP phone understands and uses. When you press a function button, the Cisco IP phone uses the configured URL to access the appropriate XML web page for instructions. The web page sends instructions to the Cisco IP phone to display information on the screen for you to navigate. You can select options and enter information by using soft keys and the scroll button.
The Cisco IP Phone 7940 and Cisco IP Phone 7960 can support four URLs in association with the four programmable feature buttons on IP phones. The four feature buttons on an IP phone are configured using the url command keywords. The fifth button—Settings—is managed entirely by the phone. Operation of these services is determined by the IP phone capabilities and the content of the referenced URL.
SUMMARY STEPS
1. telephony-service
2. url {directory | information | messages | services} url
3. exit
8-18Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
DETAILED STEPS
Example
The following example provisions the Information, Directories, Services, and Messages buttons.
telephony-service url information http://10.4.212.4/CCMUser/GetTelecasterHelpText.asp url directories http://10.4.212.11/localdirectory url services http://10.4.212.4/CCMUser/123456/urltest.html url message http://10.4.212.4/Voicemail/MessageSummary.asp
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 url {directory | information | messages | services} url
Example:Router(config-telephony-service)# url information http://10.4.212.4/CCMUser/GetTelecasterHelpText.asp
Provisions URLs for use by the Cisco IP phones. The four keywords (directory, information, messages, and services) correspond with the four feature buttons on an IP phone: Directories, Information, Messages, and Services. The purpose of the url command is simply to provision the URLs through the SEPDEFAULT.cnf configuration file supplied by the Cisco ITS router to the Cisco IP phones during phone registration. The maximum character length for the URL is 128.
You can disable the local directory by entering the url directories none command. You must reset the Cisco IP phones before the url command can take effect.
Note By default, the router automatically uses the local directory service. Provisioning the directory URL to select an external directory resource disables the Cisco ITS local directory service.
Step 3 reset all [time-interval]
Example:Router(config-telephony-service)# reset all
Performs a complete reboot of all phones, including contacting the DHCP and TFTP servers for the latest configuration information.
• all—Resets all phones associated with an ITS router.
• time-interval—Time interval, in seconds, between the start of each phone reset. Range is 0 to 60. Default is 15.
Step 4 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
8-19Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 8 Configuring ITS Phone FeaturesConfigurable Phone Displays
8-20Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 9
Integrating Voice Mail with ITSThis chapter describes how to configure a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system for Cisco Unity Voice Mail and how to specify appropriate in-band DTMF integration for other types of voice-mail systems.
Contents• Configuring ITS for Cisco Unity Voice Mail, page 9-1
• Configuring DTMF for Legacy Voice-Mail Devices, page 9-12
Configuring ITS for Cisco Unity Voice Mail
Note This chapter describes the tasks to configure the ITS side of the integration. For information about configuring Cisco Unity voice mail, refer to the documents listed at the Cisco Unity web site at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/.
The Cisco Unity Voice Mail system supports voice-mail integration with Cisco ITS. If you want voice-mail integration, you must configure the Cisco ITS router for voice mail and then configure Cisco Unity software on a PC to get voice-mail service.
To prepare Cisco ITS to integrate with Cisco Unity voice mail, see the tasks in the following sections.
• Configuring an Access Number for Voice Mail, page 9-2 (required)
• Configuring the Router for Cisco Unity Voice Mail Integration Using SCCP, page 9-2 (required)
• Associating a Voice-Mail Device, page 9-3 (required)
• Configuring Message Waiting Indication, page 9-5 (optional)
9-1Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
Configuring an Access Number for Voice Mail You must configure an access number to connect to the voice-mail system. This number is required for any kind of voice-mail integration.
Note The same number is configured on all Cisco IP phone ephone-dns to connect to voice mail. For more information, see the “Configuring the Router for Cisco Unity Voice Mail Integration Using SCCP” section on page 9-2.
SUMMARY STEPS
1. telephony-service
2. voicemail phone-number
3. exit
DETAILED STEPS
Configuring the Router for Cisco Unity Voice Mail Integration Using SCCP To configure a Cisco Unity voice-mail system on a Cisco ITS router using Skinny Client Control Protocol (SCCP), you allocate and configure one or more ephone-dns to link your ITS router to your voice-mail system. Define an ephone-dn with the same number that you used in the voicemail command to identify the number to dial for voice mail. This configuration is required for all voice-mail system integrations, including Cisco Unity Voice Mail.
SUMMARY STEPS
1. ephone-dn dn-tag
2. number number
3. name name
4. no huntstop
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 voicemail phone-number
Example:Router(config-telephony-service)# voicemail 6000
Configures the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed to dial in to a configured voice-mail system.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
9-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
5. preference preference-order
6. exit
DETAILED STEPS
Associating a Voice-Mail Device To associate the actual Cisco Unity voice-mail device port (vm-device-id) to the correct pilot extension number on the ITS system, associate the ephone-dn entry for the voice-mail pilot number with an ephone entry that corresponds to the vm-device-id.
Note The default vm-device-id prefix is CiscoUM-VI. The name that you use should match the device name prefix configuration on the Cisco Unity Telephony Services Provider (TSP) side. You must also complete the configuration on the TSP side as explained in the documents listed at the Cisco Unity web site at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/.
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 2
Enters ephone-dn configuration mode.
• dn-tag—The unique sequence number of the ephone-dn that will link the ITS router to the voice-mail system.
Step 2 number number
Example:Router(config-ephone-dn)# number 5439
Specifies a pilot number for voice-mail access.
Step 3 name name
Example:Router(config-ephone-dn)# name Voice Mail
Defines a username associated with voice mail and message waiting indication (MWI). This name appears in caller-ID displays and directory listings. For example, specify “Voice Mail” or “MWI only” as the name value.
Step 4 no huntstop
Example:Router(config-ephone-dn)# no huntstop
Disables huntstop.
Step 5 preference preference-order
Example:Router(config-ephone-dn)# preference 1
Sets preference for the attached dial peer for an ephone-dn. The default is 0.
Step 6 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
9-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
SUMMARY STEPS
1. ephone tag
2. vm-device-id id-string
3. button button-number:dn-tag
4. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 11
Enters ephone configuration mode.
• phone-tag—Unique sequence number that is associated with the vm-device-id for the purposes of configuration.
Step 2 vm-device-id id-string
Example:Router(config-ephone)# vm-device-id CiscoUM-VI2
Defines the voice-mail ID string.
• id-string—Identifying string that corresponds to the vm-device-id number. For example, CiscoUM-VI1 for the first port and CiscoUM-VI2 for the second port, and so on. The default prefix is CiscoUM-VI.
Step 3 button button-number:dn-tag
Example:Router(config-ephone)# button 1:10
Assigns a line button to an ephone-dn. The line button number is separated from the ephone-dn tag number by a colon. The maximum number of button-DN pairs is determined by phone type, as follows:
• Cisco IP Phone 7910, Cisco IP Conference Station 7935, and Cisco IP Phone 7940—Up to two button-DN pairs.
• Cisco IP Phone 7960—Up to six button-DN pairs.
Note The Cisco IP Phone 7910 has only one physical line button, but you can assign it up to two ephone-dns.
Step 4 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
9-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
Configuring Message Waiting Indication The MWI mechanism turns on the light indicator on a Cisco IP phone to notify the phone user that a voice-mail message is pending. Figure 9-1 shows a network with a Cisco IP phone and an ITS router connected to a Cisco Unity Voice Mail system.
Figure 9-1 Basic MWI Network
Information About the MWI Mechanism
The MWI mechanism is triggered when someone leaves a voice-mail message. The internal MWI mechanism of the Cisco ITS router is illustrated in Figure 9-2.
Figure 9-2 MWI Mechanism
IP
PSTN
2001
Cisco UnityVoice Mail
4001 10.10.12.1
2001-2049 6270
0V
IP
PSTN
2001
Cisco UnityVoice Mail
4001
Cisco IOSTelephony Services
6270
1V
Voice-mailaccess DNs
4001(voice calls)
MWIDN
80008001
4001(voice calls)
4001(voice calls)
4002(MWI only)
4 ports created for voice mail
10.10.12.1
ephoneDN
2001
9-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
In the network topology in Figure 9-2, the following events occur:
1. The Cisco IP phone with extension 2001 receives a call, and the call is not answered.
2. The Cisco IP phone with extension 2001 forwards the call to voice-mail access port 4001.
3. The Cisco Unity Voice Mail system (extension 4001) stores the new message for extension 2001.
4. The Cisco Unity Voice Mail then places an MWI notification call to MWI processing ephone-dn 8000 (through MWI access port 4002) with the calling party ID for the notification call set to 2001.
5. The ephone-dn 8000 accepts the MWI notification call and switches on the message waiting light for extension 2001.
The ITS router can convey MWI information to the ephone-dns if the Cisco IP phones are associated with the router. If the Cisco IP phones are not associated with the ITS router connected to the Cisco Unity Voice Mail system, the MWI information is conveyed by using the MWI relay feature. For further details, see the “Configuring MWI Relay” section on page 9-10.
When a voice-mail system has MWI information for any extension, local or remote, it dials the central-site ITS router. When the central site receives the MWI information, it attempts to determine whether the extension is local to the central site. If it cannot find the extension, it passes the MWI information to its notifier interface of SIP MWI. If the notifier interface on the central site has the extension as a subscriber, it relays the MWI information to the remote ITS router.
In Figure 9-3, Router 1 is the central-site ITS router—the MWI notifier—and uses the MWI integration mechanism described earlier to interface with the Cisco Unity Voice Mail system. The ephone-dns on Router 2 and Router 3 register with Router 1 by using the Session Initiation Protocol (SIP) subscriber mechanism. Router 1 as the SIP notifier recognizes the ephone-dns associated with Router 2 and Router 3 to relay MWI.
Figure 9-3 Network with MWI Relay
IP
IP
10.9.24.25
10.8.17.25
10.10.12.1
6001
IP
5001
Router 35001-5025
Router 26001-6025
Router 12001-2049
IP
2001
4001
Voice mail
6270
2
V
V
V
9-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
Information About the MWI Relay Mechanism
The MWI relay mechanism is triggered when someone leaves a voice-mail message on the remote voice-mail message system. In the network topology in Figure 9-3, the following events occur:
1. The Cisco IP phone with extension 5001 receives a call, and the call is not answered.
2. The Cisco IP phone with extension 5001 forwards the call to voice-mail access port 4001.
3. The Cisco Unity Voice Mail system (extension 4001) stores the new message for extension 5001.
4. Cisco Unity Voice Mail then places an MWI notification call to MWI processing ephone-dn 8000 (through MWI access port 4002) to the central ITS router, Router 1, with the calling party ID for the notification as extension 5001.
5. Router 1, acting as the SIP notifier, relays MWI notification to Router 3, one of the SIP subscribers.
6. Router 3, the local Cisco ITS router for extension 5001, turns on the MWI light of the Cisco IP phone that has extension 5001 associated with one of its line buttons.
To configure the MWI relay mechanism, perform the following tasks:
• Configuring the SIP-Based MWI Server, page 9-7
• Configuring MWI for Each ephone-dn, page 9-8
• Configuring an ephone-dn for MWI Notification, page 9-9
• Configuring MWI Relay, page 9-10
Configuring the SIP-Based MWI Server
This task configures the IP address and port for the SIP-based MWI server.
SUMMARY STEPS
1. telephony-service
2. mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited]
3. exit
9-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
DETAILED STEPS
Configuring MWI for Each ephone-dn
This task configures MWI notification for each ephone-dn.
SUMMARY STEPS
1. ephone-dn dn-tag
2. number number
3. name name
4. mwi sip
5. exit
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited]
Example:Router(config-telephony-service)# mwi sip-server 172.18.33.10
Configures the IP address and port for the SIP-based MWI server in the same LAN as the voice-mail server. The MWI SIP server is a Cisco ITS router. This IP address is used in conjunction with the mwi sip command in ephone-dn configuration mode to subscribe individual ephone-dn extension numbers to the MWI SIP server’s notification list. The SIP MWI client runs TCP by default.
• transport tcp keyword is the default setting. The transport udp keyword allows you to integrate with the SIP MWI client.
• port—TCP port for MWI server. The default SIP port number is 5060.
• reg-e164—Registers E.164 numbers with the SIP-based MWI server.
• unsolicited—Sends SIP NOTIFY for MWI without any need to send a SUBSCRIBE from ITS.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
9-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
DETAILED STEPS
Configuring an ephone-dn for MWI Notification
MWI integration on the Cisco ITS router is performed by dedicating ephone-dns to process MWI status notification calls that originate from the Cisco Unity Voice Mail system. You must allocate a minimum of one MWI processing ephone-dn for each MWI ephone-dn access port. The MWI processing ephone-dn extension numbers are configured to match the MWI dial-out notification numbers configured on the Cisco Unity Voice Mail system.
SUMMARY STEPS
1. ephone-dn dn-tag
2. number number [secondary number]
3. mwi {on | off | on-off}
4. exit
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 2
Enters ephone-dn configuration mode.
Step 2 number number
Example:Router(config-ephone-dn)# number 1023
Configures a valid number for the Cisco IP phone that receives the MWI notification.
Step 3 name name
Example:Router(config-ephone-dn)# name MWI
Configures a name for this ephone-dn. This name appears in caller-ID displays and directory listings. For example, “MWI” can be used as the name associated with this ephone-dn.
Step 4 mwi sip
Example:Router(config-ephone-dn)# mwi sip
Subscribes an extension that is attached to an ITS router to receive MWI notification from a SIP MWI server. This integrates an ITS router with an MWI service based on SIP protocol.
Note The mwi sip-server command under telephony-service configuration mode should be set prior to enabling the mwi sip command in ephone-dn configuration mode.
Step 5 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
9-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
DETAILED STEPS
Configuring MWI Relay
MWI relay is required when one Cisco Unity Voice Mail system is shared by multiple ITS routers. All ITS routers can use the SIP subscriber and notifier mechanism for MWI relay. Figure 9-3 on page 9-6 shows an MWI relay mechanism in which the ITS router is attached to the Cisco Unity Voice Mail system. The ITS router is running the SIP MWI relay server and is the SIP notifier. The other remote ITS routers are the SIP subscribers.
SUMMARY STEPS
1. telephony-service
2. mwi relay
3. mwi expires seconds
4. mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited]
5. exit
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 4
Enters ephone-dn configuration mode.
Step 2 number number [secondary number]
Example:Router(config-ephone-dn)# number 2388 secondary 2389
Configures a valid number for the Cisco IP phone. The secondary keyword allows you to associate a second telephone number with an ephone-dn.
Note For MWI notification, two numbers should be set for the MWI. The first number turns the MWI light to ON and the second number turns the MWI light to OFF when the message is picked up by the IP phone user.
Step 3 mwi {on | off | on-off}
Example:Router(config-ephone-dn)# mwi on
Configures specific ephone-dns to receive MWI notification from an external voice-mail system. The MWI notification is set for all the IP phones connected to the Cisco ITS router. The external voice-mail systems are often able to communicate MWI status by making telephone calls to dummy extension numbers, where the MWI information is embedded in either the called or the calling party IP phone number.
Note This command cannot be configured unless the number command is configured in ephone-dn configuration mode.
Step 4 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
9-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring ITS for Cisco Unity Voice Mail
DETAILED STEPS
Troubleshooting Tips
If calls are not being forwarded to the Cisco Unity Voice Mail or the MWI light is not turning on or off, use the debug commands for debugging the Cisco ITS router to verify that the appropriate calls are set up between Cisco Unity and the router.
Note This chapter describes the tasks to configure the ITS side of the integration. For information about configuring Cisco Unity voice mail, refer to the documents listed at the Cisco Unity web site at http://www.cisco.com/univercd/cc/td/doc/product/voice/c_unity/.
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 mwi relay
Example:Router(config-telephony-service)# mwi relay
Enables the Cisco ITS router to relay MWI information to remote Cisco IP phones.
Step 3 mwi expires seconds
Example:Router(config-telephony-service)# mwi expires 43200
Sets the expiration time, in seconds, for registration for either the client or the server. Range is from 600 to 99999. Default is 86400 (24 hours).
Step 4 mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited]
Example:Router(config-telephony-service)# mwi sip-server 172.18.155.10
Configures IP address and port for a SIP-based MWI server in the same LAN as the voice-mail server. The MWI SIP server is a Cisco ITS router. This IP address is used together with the mwi sip (ephone-dn) command to subscribe individual extension numbers to the MWI SIP server’s notification list. The SIP MWI client runs TCP by default.
• transport tcp keyword is the default setting. The transport udp keyword allows you to integrate with the SIP MWI client.
• port—TCP port for MWI server. The default SIP port number is 5060.
• reg-e164—Registers E.164 numbers with the SIP-based MWI server.
• unsolicited—Sends SIP NOTIFY for MWI without needing to send SUBSCRIBE from ITS.
Step 5 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
9-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring DTMF for Legacy Voice-Mail Devices
Configuring DTMF for Legacy Voice-Mail DevicesFor dual tone multifrequency (DTMF) integrations, information on how to route incoming or forwarded calls is sent by a telephone system in the form of DTMF digits. The DTMF digits are sent in a pattern that is based on the integration file in the voice-mail system connected to the Cisco ITS router. These patterns are required for the DTMF integration of ITS with most voice-mail systems. DTMF integration configuration on the Cisco ITS router works with any analog voice-mail system. Voice-mail systems are designed to respond to DTMF after the system has answered the incoming calls. The following tasks are required.
• Configuring DTMF Patterns on the Router, page 9-12 (required)
• Configuring Integration Files on Legacy Voice-Mail Systems, page 9-14 (required)
Configuring DTMF Patterns on the RouterThe Cisco ITS router provides the flexibility to integrate with any legacy voice-mail system. You can configure multiple tags and tokens for each pattern, depending on the voice-mail system and type of access. The tag in the configuration pattern must match the number defined in the voice-mail system’s integration file to identify the type of call. The keywords—CGN (calling number), CDN (called number), and FDN (forwarding number)—define the type of call information that is sent to the voice-mail system.
SUMMARY STEPS
1. vm-integration
2. pattern direct tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
3. pattern ext-to-ext busy tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
4. pattern ext-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
5. pattern trunk-to-ext busy tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
6. pattern trunk-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
7. exit
9-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring DTMF for Legacy Voice-Mail Devices
DETAILED STEPS
Command or Action Purpose
Step 1 vm-integration
Example:Router(config) vm-integration
Enters voice-mail integration configuration mode and enables voice-mail integration with DTMF and an analog voice-mail system.
Step 2 pattern direct tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
Example:Router(config-vm-integration) pattern direct 2 CGN *
Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system when the user presses the messages button on the phone.
• The tag attribute is an alphanumeric string fewer than four DTMF digits in length. The alphanumeric string consists of a combination of four letters (A, B, C, and D), two symbols (* and #), and ten digits (0 to 9). The tag numbers match the numbers defined in the voice-mail system’s integration file, immediately preceding either the number of the calling party, the number of the called party, or a forwarding number. The Cisco SRS Telephony router supports a maximum of four tags.
• The keywords—CGN, CDN, and FDN—configure the type of call information sent to the voice-mail system, such as calling number (CGN), called number (CDN), or forwarding number (FDN).
Step 3 pattern ext-to-ext busy tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
Example:Router(config-vm-integration) pattern ext-to-ext busy 7 FDN * CGN *
Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system once an internal extension attempts to connect to a busy extension and the call is forwarded to voice mail.
Step 4 pattern ext-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
Example:Router(config-vm-integration) pattern ext-to-ext no-answer 5 FDN * CGN *
Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system once an internal extension fails to connect to an extension and the call is forwarded to voice mail.
Step 5 pattern trunk-to-ext busy tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
Example:Router(config-vm-integration) pattern trunk-to-ext busy 6 FDN * CGN *
Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system once an external trunk call reaches a busy extension and the call is forwarded to voice mail.
9-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 9 Integrating Voice Mail with ITSConfiguring DTMF for Legacy Voice-Mail Devices
Note Although it is unlikely that you will use multiple instances of the CGN, CDN, or FDN keyword in a single command line, it is permissible to do so.
Configuring Integration Files on Legacy Voice-Mail Systems To configure the integration files on a third-party legacy voice-mail system, follow the instructions in the documents that accompany the voice-mail system. You must design the DTMF integration patterns appropriately so that the voice-mail system and the Cisco ITS router work with each other.
Step 6 pattern trunk-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag]
Example:Router(config-vm-integration)# pattern trunk-to-ext no-answer 4 FDN * CGN *
Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system when an external trunk call reaches an unanswered extension and the call is forwarded to voice mail.
Step 7 exit
Example:Router(config-vm-integration)# exit
Exits voice-mail integration configuration mode.
Command or Action Purpose
9-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 10
Configuring an Attendant for Primary Call CoverageThis chapter describes features that assist you in setting up an attendant to be the single initial source of incoming call coverage in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Related Features, page 10-1
• Label Support, page 10-2
• Monitor Lamp and Direct Station Select, page 10-3
• Silent Ring, page 10-5
• On-Hold Call Notification, page 10-6
• Night Service, page 10-8
• IVR Auto-Attendant, page 10-12
Related FeaturesThe following related features in Chapter 12, “Configuring Secondary Call Coverage,” provide additional call coverage functionality:
• Ephone-dn Overlays
• Ephone-dn Dial-Peer Preference
• Huntstop
• Ephone Hunt Groups
• Call-Pickup Groups
10-1Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageLabel Support
Label Support The label support feature controls the display adjacent to an ephone-dn line button. By default, an IP phone displays the extension number that is set using the number command under an ephone-dn. The label support feature allows you to enter a meaningful text string for each ephone-dn so that a phone user with multiple lines can select a line by name instead of by phone number, thus eliminating the need to consult in-house phone directories.
SUMMARY STEPS
1. ephone-dn dn-tag
2. label label-string
3. exit
4. ephone phone-tag
5. restart
6. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 1
Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies the ephone-dn to which the label is to be associated.
Step 2 label label-string
Example:Router(config-ephone-dn)# label user1
Creates a custom label that is displayed on the phone next to the line button that is associated with this ephone-dn. The custom label replaces the default label, which is the number that was assigned to this ephone-dn.
• label-string—String of up to 30 alphanumeric characters that provides the label text.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Step 4 ephone phone-tag
Example:Router(config)# ephone 1
Enters ephone configuration mode.
• phone-tag—Unique identifier (sequence number) of the ephone on which you are defining the new label.
10-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageMonitor Lamp and Direct Station Select
Example
The following example creates text labels for two ephone-dns:
ephone-dn 1number 2001label Sales
ephone-dn 2number 2002label Engineering
Monitor Lamp and Direct Station SelectFor multibutton phones and expansion modules, the buttons for lines that are shared with other phones can be designated as monitor buttons. A monitor button is created primarily to show the status of a line that also appears on another phone. When the shared line is in use on the other phone, the console display for the line’s monitor button shows an icon of a phone covered by an X. An idle line is represented by an icon of a phone with the handset in the on-hook position. Monitor buttons cannot be used to make outgoing calls, as opposed to line buttons for ordinary shared lines. This functionality is known on PBXs as a monitor lamp.
When a monitored line is idle, a multibutton phone user can transfer calls to the other phone on which the line appears by pressing the Transfer key and then the appropriate monitor button. This functionality is sometimes known as fast transfer or direct station select.
The monitor lamp feature is configured using the m keyword of the button command. This feature can be configured on any multibutton IP phone, such as a Cisco IP Phone 7960 with one or two Cisco IP Phone 7914 modules. Phones are configured with a shared line for each extension that uses the monitor function.
SUMMARY STEPS
1. ephone phone-tag
2. button button-numbermdn-tag[[button-numbermdn-tag]...]
3. exit
Step 5 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 6 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Command or Action Purpose
10-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageMonitor Lamp and Direct Station Select
DETAILED STEPS
Example
In this example, lines 1 through 4 represent incoming PSTN lines, and lines 5 and 6 are monitored extension numbers.
ephone 1button 1:10 2:11 3:12 4:13 5m21 6m22
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 1
Enters ephone (Ethernet phone) configuration mode.
• phone-tag—Unique sequence number that identifies the phone on which you are adding a button in monitor mode.
Step 2 button button-numbermdn-tag [[button-numbermdn-tag]...]
Example:Router(config-ephone)# button 1m22
This command with the m keyword as a separator assigns an ephone-dn to a line button in monitor mode.
• button-number—Number of a phone button, starting with 1 as the topmost button on the phone.
• dn-tag—Ephone-dn tag (sequence number) of the extension that you want to monitor on this phone. This ephone-dn tag must also be assigned to a button on another phone. This is a shared ephone-dn.
For a description of other arguments and keywords used in this command, see the “Setting Up Individual Directory Numbers and Phones” section in Chapter 3, “Setting Up Phones in an ITS System.”
Step 3 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 4 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
10-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageSilent Ring
Silent RingThe silent ring feature allows you to designate phone buttons that do not emit an audible ring when they receive incoming calls. Although this feature is supported by all phone types, it is most useful on phone buttons that are used to display the activity of shared lines, which are typically found on the Cisco IP Phone 7960 and Cisco IP Phone Expansion Module 7914.
When the silent ring feature is enabled, the visible cues that signal an incoming call are a flashing ((< icon in the phone display and a flashing red light on the handset. On the Cisco IP Phone Expansion Module 7914, a flashing yellow light also accompanies incoming calls. On lines that have silent ring, you can specify whether you want to hear call-waiting beeps or whether you want them suppressed if a second call comes in.
The silent ring feature is enabled when a line button is configured with ringer option s or b.
SUMMARY STEPS
1. ephone phone-tag
2. button button-number{b | s}dn-tag [[button-number{b | s}dn-tag]...]
3. restart
4. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 4
Enters ephone (Ethernet phone) configuration mode.
• phone-tag—Unique sequence number that identifies the phone on which you are adding a button in silent mode.
Step 2 button button-number{b | s}dn-tag [[button-number{b | s}dn-tag]...]
Example:Router(config-ephone)# button 1b10 2b11 3s12
This command with a b or s keyword assigns an ephone-dn to a line button in silent mode.
• b—Beep allowed, but no ring. Audible ring is suppressed for incoming calls, but call-waiting beeps are allowed. Visible cues are the same as for normal ring.
• s—Silent ring. Audible ring and call-waiting beeps are suppressed for incoming calls. Visible cues are the same as for normal ring.
• dn-tag—Ephone-dn tag (sequence number) of the extension to which you want to assign the silent ring on this phone.
For a description of other arguments and keywords used with this command, see the “Setting Up Individual Directory Numbers and Phones” section in Chapter 3, “Setting Up Phones in an ITS System.”
10-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageOn-Hold Call Notification
Example
The following example sets buttons 1 and 2 for silent ring with call-waiting beeps allowed and sets button 3 for silent ring:
ephone 4button 1b10 2b11 3s12
On-Hold Call Notification This service adds an audible alert as a reminder to an IP phone user that a call is waiting on hold. This feature is primarily intended for use by an attendant but may be used on any IP phone.
SUMMARY STEPS
1. ephone-dn dn-tag
2. hold-alert timeout {idle | originator | shared}
3. exit
Step 3 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 4 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Command or Action Purpose
10-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageOn-Hold Call Notification
DETAILED STEPS
Example
The following example generates a burst of audible ringing every 10 seconds that a call is on hold on an idle phone:
ephone-dn 1 hold-alert 10 idle
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 11
Enters ephone-dn configuration mode.
• dn-tag—The unique sequence number that identifies the ephone-dn to which you want to assign the hold-alert feature.
Step 2 hold-alert timeout {idle | originator | shared}
Example:Router(config-ephone-dn)# hold-alert 15 idle
Sets audible alert notification on the Cisco IP phone for alerting the user about on-hold calls. The timeout argument specifies the time interval in seconds from the time the call is placed on hold to the time the on-hold audible alert is generated. The alert is repeated at the end of the set timeout value.
• idle—Generates a 1-second burst of ringing on the IP phone that placed the call into the hold state if that phone is in the idle state. If the phone is in active use, no on-hold alert is generated.
• originator—Generates a 1-second burst of ringing on the phone that placed the call into the hold state if the phone is in the idle state. If the phone is in use on another call, an audible beep is generated (call-waiting tone).
Note From the perspective of the originator of the call on hold, the originator and shared keywords provide the same functionality.
• shared—Generates a 1-second burst of ringing for all the idle phones that share the same line appearance. If the phones are in use, they do not hear an audible beep. Only the phone that initiated the call, if it is in use on another call, hears call-waiting beeps.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
10-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageNight Service
Night ServiceThe night service feature allows you to designate an extension number (ephone-dn) that notifies phones other than the phone on which it appears when it rings during designated night service periods. Phone users can then answer the calls on those phones using the call pickup feature.
Night service allows an employee working late at night to intercept calls that are presented to an unattended receptionist’s phone and redirect them to be answered at the employee’s phone. This feature is useful when all incoming PSTN calls have to be transferred by the receptionist because the PSTN connection to the ITS system does not support Direct Inward Dialing (DID). When a call arrives at the unattended receptionist’s phone during hours that are specified as night service, a ring burst notifies a specified set of phones of the incoming call. Any phone user at one of the specified phones can intercept the call using the call pickup feature.
Night service can be manually toggled on and off from any phone that has a line that is designated as a night-service line. When night service is active, a message is displayed on the night-service phones.
Night service requires that you define the following parameters:
1. Night-service time period—Day or date and hours during which night service is active. Steps 2 and 3 in the following procedure define the night-service period.
2. Night-service extensions (ephone-dns)—When a night-service extension receives an incoming call during the night-service period, night-service notification is triggered. Steps 6 through 8 in the following procedure define an ephone-dn as having night service and specify the ephone on which the ephone-dn appears.
3. Night-service phones (ephones)—Night-service phones are alerted with a distinctive ring when incoming calls are received on night-service lines during the night-service time period. The night-service phone user answers the call using call pickup or group call pickup. Steps 9 through 11 in the following procedure assigns night-service notification to a phone. This phone receives a distinctive alerting ring and notification display when a night-service extension receives an incoming call.
4. (Optional) Night-service toggle code—A code to allow night-service treatment to be manually toggled off and on from each phone that has lines assigned to night service. Step 4 in the following procedure defines a night-service toggle code.
Figure 10-1 illustrates night service.
10-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageNight Service
Figure 10-1 Night Service
SUMMARY STEPS
1. telephony-service
2. night-service day day start-time stop-time
3. night-service date month date start-time stop-time
4. night-service code digit-string
5. exit
6. ephone-dn dn-tag
7. night-service bell
! ephone-dn 1 number 1000 night-service bell ! ephone-dn 10 number 1010 ! ephone-dn 11 number 1011 ! ephone 5 mac-address 1111.2222.0001 button 1:1! ephone 14 mac-address 1111.2222.0002 button 1:10 night-service bell ! ephone 15 mac-address 1111.2222.0003 button 1:11 night-service bell
Extension 1000 has been designated as a night-service extension (ephone-dn). When extension 1000 receives an incoming call during a night-service period, phone 5 rings and notification is made to the night-service phones.
Phones 14 and 15 have been designated as night-service phones. When phone 5 starts ringing, phones 14 and 15 ring once and display “Night Service 1000.” The incoming call on extension 1000 can be answered from phone 14 or phone 15 using call pickup.
Phone 5Button 1 is extension 1000Extension 1000 is a night-
service extension
Phone 15Button 1 is extension 1011Phone 15 is a night-service phone
Phone 14Button 1 is extension 1010Phone 14 is a night-service phone
8895
1
IP
IP
IP
V
2
1
telephony-service night-service day fri 17:01 17:00 night-service day sat 17:01 17:00 night-service day sun 17:01 07:59 night-service date jan 1 00:00 00:00 night-service code *1234
10-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageNight Service
8. exit
9. ephone phone-tag
10. night-service bell
11. exit
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 night-service day day start-time stop-time
Example:Router(config-telephony-service)# night-service day mon 19:00 07:00
Defines a recurring time period associated with a day of the week during which night service is active.
• day—Day of the week abbreviation. The following are valid day abbreviations: sun, mon, tue, wed, thu, fri, sat.
• start-time stop-time—Beginning and ending times for night service, in an HH:MM format using a 24-hour clock. If the stop time is a smaller value than the start time, the stop time occurs the day following the start time. For example, “mon 19:00 07:00” means “from Monday at 7 p.m. until Tuesday at 7 a.m.”
Step 3 night-service date month date start-time stop-time
Example:Router(config-telephony-service)# night-service date jan 1 00:00 00:00
Defines a recurring time period associated with a month and date during which night service is active.
• month—Month abbreviation. The following are valid month abbreviations: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.
• date—Date of the month. Range is from 1 to 31.
• start-time stop-time—Beginning and ending times for night service, in an HH:MM format using a 24-hour clock. The stop time must be greater than the start time. The value 24:00 is not valid. If 00:00 is entered as an stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified date.
Step 4 night-service code digit-string
Example:Router(config-telephony-service)# night-service code *7898
Designates a code that can be dialed from any night-service line (ephone-dn) to toggle night service on and off for all the lines on the phone assigned to night service. The code must begin with an asterisk (*). The night-service state is indicated in a display message on phones that have active night-service lines.
Step 5 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
10-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageNight Service
Example
The following example provides night service before 8 a.m. and after 5 p.m. Monday through Friday, before 8 a.m. and after 1 p.m. on Saturday, and all day Sunday. Extension 1000 is designated as a night-service extension, which means that incoming calls to extension 1000 during the night-service period will ring on extension 1000 and provide night-service notification to phones that are designated as night-service phones. In this example, the night-service phones are ephone 14 and ephone 15. The night-service notification consists of a single ring on the phone and a display of “Night Service 1000.”
In the sample configuration below, a call to extension 1000 on Monday at 7:30 p.m. rings normally on ephone 5 and makes a night-service notification to ephones 14 and 15.
telephony-servicenight-service day mon 17:00 08:00night-service day tue 17:00 08:00night-service day wed 17:00 08:00night-service day thu 17:00 08:00night-service day fri 17:00 08:00night-service day sat 13:00 12:00night-service day sun 12:00 08:00night-service code *1234
Step 6 ephone-dn dn-tag
Example:Router(config)# ephone-dn 55
Enters ephone-dn configuration mode to define an ephone-dn to receive night-service treatment.
• dn-tag—Unique sequence number that identifies the ephone-dn to receive night-service treatment.
Step 7 night-service bell
Example:Router(config-ephone-dn)# night-service bell
Marks this ephone-dn for night-service treatment. Incoming calls to this ephone-dn during the night-service time period send an alert notification to all IP phones that are marked to receive night-service bell notification.
Step 8 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Step 9 ephone phone-tag
Example:Router(config)# ephone 12
Enters ephone configuration mode. This is a phone that will be notified when an incoming call is received by a night-service ephone-dn during a night-service period.
• phone-tag—The unique sequence number of the phone that you are designating as a night-service phone.
Step 10 night-service bell
Example:Router(config-ephone)# night-service bell
Marks this phone to receive night-service bell notification when incoming calls are received on ephone-dns marked for night service during the night-service time period. The alert notification is a splash ring that is not associated with any of the individual lines on the IP phone and a visual display of the ephone-dn line number. The phone user can pick up the call by executing a PickUp or GPickUp.
Step 11 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Command or Action Purpose
10-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageIVR Auto-Attendant
!ephone-dn 1number 1000night-service bell
!ephone-dn 2number 1001night-service bell
!ephone-dn 10number 2222
!ephone-dn 11number 3333
!ephone 5mac-address 1111.2222.0001button 1:1 2:2
!ephone 14mac-address 1111.2222.0002button 1:10night-service bell
!ephone 15mac-address 1111.2222.0003button 1:11night-service bell
IVR Auto-Attendant The interactive voice response (IVR) auto-attendant mechanism can support the handling of inbound calls on Foreign Exchange Office (FXO) ports and outbound calls on Foreign Exchange Station (FXS) ports, including analog phones configured through the POTS and Cisco IP phones configured through ephone-dn virtual FXS ports. Tool Command Language (TCL) scripts are used to play prompts (welcome, phone number, store hours, and store locations, for example), collect digits, and place calls. The IVR prompts used in the TCL scripts must be downloaded to the ITS router Flash memory. The IVR prompts require an audio file (.au) format of 8-bit, mu-law, and 8-kHz encoding.
If you want Cisco to develop customized application scripts for you, contact the Developer Support group at [email protected]. This is a fee-based service.
In addition, if you are interested in developing TCL scripts, you can join the Cisco Developer Support Program. This program provides you with a consistent level of support. It also provides an easy process to open, update, and track issues using the Online Case tracking tool available at Cisco.com. This is also a fee-based service.
Note To participate in the Cisco Developer Support Program, you must have a signed Developer Support Agreement. For more details and for access to this agreement, go to http://www.cisco.com/warp/public/570/index.html, or contact [email protected].
For information about IVR and TCL scripts, refer to the Cisco IOS TCL and VoiceXML Application Guide.
The following task enables an IVR auto-attendant application on the specified extension (ephone-dn).
10-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageIVR Auto-Attendant
SUMMARY STEPS
1. ephone-dn dn-tag
2. application application-name
3. exit
DETAILED STEPS
Example
The following example associates the TCL application called app2 with ephone-dn 13:
ephone-dn 13application app2
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 4
Enters ephone-dn configuration mode.
• dn-tag—The unique sequence number that identifies the ephone-dn for which the application should be in effect.
Step 2 application application-name
Example:Router(config-ephone-dn)# application app2
Assigns a TCL IVR application to the ephone-dn.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
10-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 10 Configuring an Attendant for Primary Call CoverageIVR Auto-Attendant
10-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 11
Configuring Call BlockingThis chapter describes features that can be used to restrict calls in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Call-Blocking (Toll Bar) Based on Time of Day and Day of Week or Date, page 11-1
• Call-Blocking (Toll Bar) Override, page 11-4
• Do Not Disturb Service, page 11-6
• Class of Restriction, page 11-6
Call-Blocking (Toll Bar) Based on Time of Day and Day of Week or Date
Call blocking to prevent unauthorized use of phones is implemented by matching a pattern of specified digits during a specified time of day and day of week or date. Up to 32 patterns of digits can be specified. Call blocking is supported on IP phones only and not on analog FXS phones.
When a user attempts to place a call to digits that match a pattern that has been specified for call blocking during a time period that has been defined for call blocking, a fast-busy signal is played for approximately 10 seconds. The call is then terminated, and the line is placed back in on-hook status.
Call blocking applies to all IP phones in a Cisco ITS system, although individual IP phones can be exempted from all call blocking.
Individual phone users can be allowed to override call blocking associated with designated time periods by entering personal identification numbers (PINs) that have been assigned to their phones. For more information, see the “Call-Blocking (Toll Bar) Override” section on page 11-4.
SUMMARY STEPS
1. telephony-service
2. after-hours block pattern tag pattern [7-24]
3. after-hours day day start-time stop-time
4. after-hours date month date start-time stop-time
11-1Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingCall-Blocking (Toll Bar) Based on Time of Day and Day of Week or Date
5. exit
6. ephone phone-tag
7. after-hour exempt
8. exit
DETAILED STEPS
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 after-hours block pattern tag pattern [7-24]
Example:Router(config-telephony-service)# after-hours block pattern 1 91900
Defines a pattern of outgoing digits to be blocked. Up to 32 patterns can be defined, using individual commands.
• If the 7-24 keyword is specified, the pattern is always blocked, 7 days a week, 24 hours a day.
• If the 7-24 keyword is not specified, the pattern is blocked during the days and dates that are defined using the after-hours day and after-hours date commands.
Step 3 after-hours day day start-time stop-time
Example:Router(config-telephony-service)# after-hours day mon 19:00 7:00
Defines a recurring time period based on the day of the week during which calls are blocked to outgoing dial patterns that are defined using the after-hours block pattern command.
• day—Day of the week abbreviation. The following are valid day abbreviations: sun, mon, tue, wed, thu, fri, sat.
• start-time stop-time—Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. If the stop time is a smaller value than the start time, the stop time occurs on the day following the start time. For example, “mon 19:00 07:00” means “from Monday at 7 p.m. until Tuesday at 7 a.m.”
11-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingCall-Blocking (Toll Bar) Based on Time of Day and Day of Week or Date
Example
The following example defines several patterns of digits for which outgoing calls are blocked. Patterns 1 and 2, which block calls to external numbers that begin with “1” and “011,” are blocked on Monday through Friday before 7 a.m. and after 7 p.m., on Saturday before 7 a.m. and after 1 p.m., and all day Sunday. Pattern 3 blocks calls to 900 numbers 7 days a week, 24 hours a day. The IP phone with sequence number (phone-tag) 23 and MAC address 00e0.8646.9242 is not restricted from calling any of the blocked patterns.
telephony-serviceafter-hours block pattern 1 91after-hours block pattern 2 9011after-hours block pattern 3 91900 7-24after-hours block day mon 19:00 07:00after-hours block day tue 19:00 07:00
Step 4 after-hours date month date start-time stop-time
Example:Router(config-telephony-service)# after-hours date jan 1 0:00 0:00
Defines a recurring time period based on month and date during which calls are blocked to outgoing dial patterns that are defined using the after-hours block pattern command.
• month—Month abbreviation. The following are valid month abbreviations: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.
• date—Date of the month. Range is from 1 to 31.
• start-time stop-time—Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time must be larger than the start time. The value 24:00 is not valid. If 00:00 is entered as an stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified date.
Step 5 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Step 6 ephone phone-tag
Example:Router(config)# ephone 4
Enters ephone configuration mode.
• phone-tag—The unique sequence number for the phone that is to be exempt from call blocking.
Step 7 after-hour exempt
Example:Router(config-ephone)# after-hour exempt
Specifies that this phone is exempt from call blocking. Note that phones exempted in this manner are not restricted from any call-blocking patterns and that no authentication of the phone user is required.
For a different method of allowing phone users to call blocked patterns, see the “Call-Blocking (Toll Bar) Override” section on page 11-4.
Step 8 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Command or Action Purpose
11-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingCall-Blocking (Toll Bar) Override
after-hours block day wed 19:00 07:00after-hours block day thu 19:00 07:00after-hours block day fri 19:00 07:00after-hours block day sat 13:00 12:00after-hours block day sun 12:00 07:00
!ephone 23mac 00e0.8646.9242button 1:33after-hour exempt
ephone 24mac 2234.1543.6352button 1:34
Call-Blocking (Toll Bar) OverrideFor IP phones that support soft keys, such as the Cisco 7940 IP Phone and the Cisco 7960 IP Phone, the call blocking override feature allows individual phone users to override the call blocking that has been defined for designated time periods. The system administrator must first assign a personal identification number (PIN) to any phone that will be allowed to override call blocking.
Then, to override call blocking, the phone user presses the Login soft key on the phone and enters the PIN that is associated with the phone. Note that logging in to a phone with a PIN only allows the user to override call blocking that is associated with particular time periods. Blocking patterns that are created with the 7-24 keyword in the after-hours block pattern command are in effect 7 days a week, 24 hours a day, and they cannot be overridden by using a PIN.
When PINs are configured for call-blocking override, they are cleared at a specific time of day or after phones have been idle for a specific amount of time. The time of day and amount of time can be set by the system administrator, or the defaults can be accepted.
RestrictionsCall-blocking override is available only on IP phones that have soft-key support, such as the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
SUMMARY STEPS
1. ephone phone-tag
2. pin pin-number
3. exit
4. telephony-service
5. login [timeout [minutes]] [clear time]
6. restart all
7. exit
11-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingCall-Blocking (Toll Bar) Override
DETAILED STEPS
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 2
Enters ephone configuration mode.
• phone-tag—The unique sequence number of the phone to which you are assigning a PIN.
Step 2 pin pin-number
Example:Router(config-ephone)# pin 5555
Declares a personal identification number (PIN) for a designated ephone.
• pin-number—Number from four to eight digits in length.
Step 3 exit
Example:Router(config-ephone) # exit
Exits ephone configuration mode.
Step 4 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 5 login [timeout [minutes]] [clear time]
Example:Router(config-telephony-service)# login timeout 120 clear 23:00
Specifies that the ITS system should deactivate all user logins at a specific time or after a designated period of idle time on a phone.
• timeout—(Optional) Deactivates logins a given number of minutes after a phone becomes idle.
• minutes—(Optional) Number from 5 to 1440. Default is 60.
• clear—(Optional) Deactivates all logins at a specified time.
• time—(Optional) Time of day using 00:00 to 24:00 on a 24-hour clock. For example, 10:30 p.m. is 22:30. Default is 24:00 (midnight).
Step 6 restart all
Example:Router(config-telephony-service)# restart all
Performs a fast reboot of all phones associated with this ITS router. Does not contact the DHCP or TFTP server for updated information.
Step 7 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
11-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingDo Not Disturb Service
Example
The following example deactivates a phone’s login after three hours of idle time and clears all logins at 10 p.m.:
ephone 1pin 1000
!telephony-servicelogin timeout 180 clear 2200
Troubleshooting Tips
Use the show ephone login command to display the login status of all phones.
Do Not Disturb ServiceDo not disturb (DND) service can be enabled using a soft key on a Cisco IP Phone 7940 or a Cisco IP Phone 7960. When DND is enabled, incoming calls do not ring on the phone, but do provide visual alerting and call information and can be answered if desired. A display message indicates that DND is in effect. Call forwarding on busy and no answer operates the same as without DND.
No configuration is required for the DND feature. The show ephone dnd command displays all phones that have DND enabled.
Class of RestrictionClass of restriction (COR) is used to specify which incoming dial peer can use which outgoing dial peer to make a call. Each dial peer can be provisioned with an incoming and an outgoing COR list. The cor command sets the dial-peer COR parameter for dial peers and the directory numbers that are created for Cisco IP phones associated with the ITS router. COR functionality provides the ability to deny certain call attempts on the basis of the incoming and outgoing class of restrictions that are provisioned on the dial peers. This functionality provides flexibility in network design, allows users to block calls (for example, calls to 900 numbers), and applies different restrictions to call attempts from different originators.
For more information on setting COR, see the “Configuring Dial Peer Matching Features” section in the “Configuring Dial Plans, Dial Peers, and Digit Manipulation” chapter of the Cisco IOS Voice, Video, and Fax Configuration Guide, Release 12.2.
SUMMARY STEPS
1. ephone-dn dn-tag
2. cor {incoming | outgoing} cor-list-name
3. exit
11-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingClass of Restriction
DETAILED STEPS
Example
The following example specifies the use of a COR list called “corlist2” for outgoing calls from ephone-dn 3.
ephone-dn 3cor outgoing corlist2
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 12
Enters ephone-dn configuration mode.
• dn-tag—The unique sequence number for the ephone-dn to which you want to apply a COR.
Step 2 cor {incoming | outgoing} cor-list-name
Example:Router(config-ephone-dn)# cor outgoing corlist2
Configures a COR on the dial peers associated with an ephone-dn.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
11-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 11 Configuring Call BlockingClass of Restriction
11-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 12
Configuring Secondary Call CoverageThis chapter describes features that allow you to selectively control the ways in which calls are routed to IP phone users to ensure incoming call coverage in the absence of, or in addition to, a primary attendant in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Related Features, page 12-1
• Information About Configuring Call Coverage, page 12-1
• Ephone-dn Overlays, page 12-2
• Ephone-dn Dial-Peer Preference, page 12-4
• Huntstop, page 12-5
• Ephone Hunt Groups, page 12-7
• Call-Pickup Groups, page 12-13
Related FeaturesSee features in Chapter 10, “Configuring an Attendant for Primary Call Coverage.”
Information About Configuring Call CoverageCall coverage can be defined as the ability to ensure that all incoming calls are answered by someone, even if the number that was originally dialed is busy or does not answer. Call coverage means that you ensure an adequate number of ephone-dns (virtual voice ports) for incoming calls as well as the ability for incoming calls to search among available ephone-dns until they are answered. There are many ways to design call coverage plans to meet your needs using Cisco ITS. This chapter explains some of the ITS options that you can use to provide call coverage.
Ephone-dn overlays, for example, are a means of placing more lines (ephone-dns) on a phone than there are line buttons to accommodate them. The ephone-dns that are overlaid on a button can also be shared among other phones to increase the likelihood that someone will be available to answer calls on them. See the “Ephone-dns” section in Chapter 1, “Cisco IOS Telephony Services Overview,” for information about the types of ephone-dn that can be used for various types of call coverage.
12-1Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone-dn Overlays
Another feature, ephone dial-peer preference, allows you to specify the order in which you would like ephone-dns hunted, and the huntstop command allows you to control whether calls continue to hunt if the number that was dialed is busy or does not answer. Specific ephone hunt groups can be created that hunt only through a designated set of ephone-dns in a specified order.
Call-pickup groups enable phone users to easily answer calls that are ringing on other phones. Any or all of these features can be combined with the use of shared lines and secondary numbers to design the call coverage plan that is best suited to your needs.
Ephone-dn OverlaysAn ephone-dn overlay allows more than one ephone-dn to share the same physical line button on an IP phone. Overlaid ephone-dns can be used to receive incoming calls and place outgoing calls.
When more than one ephone-dn is ringing at the same time within the overlay set, the first call that was placed is selected by the phone for presentation on the line button. If this call comes in on a line that is shared (it appears on other phones also) and the call is answered on another phone, or if the caller hangs up before the call is answered, the phone reviews the ephone-dns in its overlay set from left to right as entered in the button command and presents the first incoming call it finds as the new ringing call on this line button. The caller ID display is updated to show the caller ID for the currently presented call.
Once a call on an overlay ephone-dn is answered, that ephone-dn is no longer accessible to other phones that share the ephone-dn in overlay mode. For example, if an overlay ephone-dn call is put on hold, it is not visible as a shared-line hold to the other phones. Other phones using the ephone-dn as overlay are not able to directly pick up the on-hold call using a simple shared-line pickup.
If there are more phones than ephone-dns associated with an ephone-dn overlay set, it is possible for some phones to find that all the ephone-dns within their overlay set are in use by other phones. For example, if there are five phones that each have a line button configured with the same overlay set that contains only three ephone-dns, there may be times when three of the five phones are using all three of the ephone-dns in the overlay set. When that occurs, the other two phones will not be able to use an ephone-dn in the overlay set. When all ephone-dns in an overlay set are in use, phones with this overlay set display the remote-line-in-use icon (a picture of a phone with a flashing X through it) for the corresponding line button. When at least one ephone-dn becomes available within the overlay set (that is, an ephone-dn is either idle or ringing), the phone display reverts to showing the status of the available ephone-dn (idle or ringing).
Ephone-dn overlays allow more than one ephone-dn to be assigned to a single physical line button. This feature is useful when you want to be able to share multiple equivalent phone lines across several phones in such a way that you can have multiple simultaneous calls. With a simple shared-line arrangement in which a single ephone-dn is shared among multiple phones, an incoming call on the shared line can be answered by any phone. However, this arrangement supports only a single call at any one time. With ephone-dn overlays, you can create multiple instances of a shared line and assign the multiple shared lines to a number of phones using a single button per phone. This option lets you support multiple simultaneous calls while still preserving the shared-line advantage that you can answer any call on any of several phones, and does so without consuming all the line buttons on the phones.
SUMMARY STEPS
1. ephone phone-tag
2. mac-address mac-address
3. button button-numberodn-tag, dn-tag... [[button-numberodn-tag, dn-tag...]...]
4. exit
12-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone-dn Overlays
DETAILED STEPS
Example
The following example shows three instances of a shared line with the extension number 1001 overlaid onto a single button on each of three phones. The first call arrives on ephone-dn 1 and rings button 1 on all three phones. The call is answered on ephone 1. A second call to extension 1001 hunts onto ephone-dn 2 and rings on the two remaining ephones, 11 and 12, and is answered by ephone 12. A third call to extension 1001 hunts onto ephone-dn 3 and rings on ephone 11, where it is answered. This configuration creates a three-way shared line across three IP phones and can handle three simultaneous calls to the same telephone number.
ephone-dn 1number 1001no huntstop
ephone-dn 2number 1001no huntstoppreference 1
ephone-dn 3number 1001no huntstoppreference 2
Command or Action Purpose
Step 1 ephone phone-tag
Example:Router(config)# ephone 4
Enters ephone (Ethernet phone) configuration mode.
• phone-tag—Unique sequence number that identifies the phone to which you are adding an overlay set.
Step 2 mac-address mac-address
Example:Router(config-ephone)# mac-address 1234.5678.abcd
Specifies the MAC address of the registering phone.
Step 3 button button-numberodn-tag, dn-tag... [[button-numberodn-tag, dn-tag...]...]
Example:Router(config-ephone)# button 1o14,15,16
Creates a set of ephone-dns overlaid on a single button.
• o—Overlay button. Multiple ephone-dns share this button. A maximum of ten ephone-dns can be specified for a single button, separated by commas.
• dn-tag—Unique identifier previously defined with the ephone-dn command for the ephone-dn to be added to this overlay set.
For other keywords used with this command, see the “Setting Up Individual Directory Numbers and Phones” section in Chapter 3, “Setting Up Phones in an ITS System.”
Step 4 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
12-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone-dn Dial-Peer Preference
ephone 10button 1o1,2,3
ephone 11button 1o1,2,3
ephone 12button 1o1,2,3
Ephone-dn Dial-Peer Preference Dial peers in the ITS router use certain call-matching criteria to route calls. One call-matching criterion for incoming calls is the destination pattern, which associates a dialed number with an ephone-dn. When more than one ephone-dn matches the destination pattern (which can include wildcards), you can set the ephone-dn dial-peer preference for each of the matching ephone-dns to designate the order in which incoming calls should be routed to the matching ephone-dns. Use the preference (ephone-dn) command to assign each matching ephone-dn a preference value from 0 to 10, with 0 as the highest preference. The default is 0 if no preference is assigned.
For example, you have two ephone-dns with the same extension number, 2680. These two ephone-dns both match the same destination pattern because they both have the same extension number. One of the ephone-dns is on button 1 of your phone, and the other is on button 2. The ephone-dn on button 1 has been assigned a preference value of 0 (the highest value and also the default if this command is not used), and the ephone-dn on button 2 has been assigned a preference value of 1. The first call to extension 2680 is routed to button 1 because the ephone-dn on button 1 has the higher preference value. Incoming calls will always be routed to button 1 if it is free. If the ephone-dn on button 1 is occupied when a second call to extension 2680 is received by the ITS system, the second call is routed to button 2.
SUMMARY STEPS
1. ephone-dn dn-tag
2. preference preference-order [secondary secondary-order]
3. exit
12-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageHuntstop
DETAILED STEPS
Example
The following example sets an ephone-dn preference number of 2 for the primary number of the ephone-dn with dn-tag 3:
ephone-dn 3preference 2
HuntstopHuntstop prevents an incoming call from rolling over to another ephone-dn if the called ephone-dn is busy or does not answer. This allows you to prevent hunt-on-busy from redirecting a call to a busy phone into a dial-peer setup with a catch-all default destination.
In ephone-dn configuration mode, huntstop is set by default. The no huntstop command disables huntstop to allow hunting to a nonbusy ephone-dn.
Channel huntstop works in a similar way for the two channels of a dual-line ephone-dn. If it is enabled, channel huntstop keeps incoming calls from hunting to the second channel if the first channel is busy or does not answer. This keeps the second channel free for call transfer, call waiting, or three-way conferencing. Channel huntstop also prevents situations in which a call can ring for 30 seconds on the first channel of a line with no person available to answer and then ring for another 30 seconds on the second channel before rolling over to another line.
No-huntstop call redirection is based on standard Cisco IOS voice gateway routing mechanisms.
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 33
Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies the ephone-dn for which you are setting dial peer preference.
Step 2 preference preference-order [secondary secondary-order]
Example:Router(config-ephone-dn)# preference 2
Sets the preference value for an ephone-dn with the associated dial peer.
• preference-order—Preference value for the primary number of an ephone-dn. Range is from 0 to 10, where 0 is the highest preference and 10 is the lowest preference. Default is 0.
• secondary secondary-order—(Optional) Preference value for the secondary number of an ephone-dn. Range is from 0 to 10, where 0 is the highest preference and 10 is the lowest preference. Default is 0.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
12-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageHuntstop
SUMMARY STEPS
1. ephone-dn dn-tag
2. no huntstop
3. huntstop channel
4. exit
DETAILED STEPS
Examples
The following example shows an instance in which huntstop is not desired and is explicitly disabled. In this example, ephone 4 is configured with two lines, each with the same extension number 5001. This is done to allow the second line to provide call waiting notification for extension number 5001 when the first line is in use. Setting no huntstop on the first line (ephone-dn 1) allows incoming calls to hunt to the second line (ephone-dn 2) on the same phone when the ephone-dn 1 line is busy.
Ephone-dn 2 has call forwarding set to extension 6000, which corresponds to a locally attached answering machine connected to a Foreign Exchange Station (FXS) voice port. The POTS dial peer for extension 6000 also has the dial-peer huntstop attribute explicitly set to prevent further hunting.
ephone-dn 1 number 5001 no huntstop preference 1 call-forward noan 6000
ephone-dn 2 number 5001 preference 2 call-forward busy 6000 call-forward noan 6000
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 4
Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies the ephone-dn for which you want to change huntstop status.
Step 2 no huntstop
Example:Router(config-ephone-dn)# no huntstop
(Optional) Disables huntstop, allowing calls to hunt to the next ephone-dn if this ephone-dn is busy or does not answer. Default is that huntstop is enabled. To reenable huntstop, use the huntstop command.
Step 3 huntstop channel
Example:Router(config-ephone-dn)# huntstop channel
(Optional) For dual-line ephone-dns, enables channel huntstop, which keeps a call from hunting to the next channel of an ephone-dn if the first channel is busy or does not answer. Default is no huntstop channel.
Step 4 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
12-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone Hunt Groups
ephone 4 button 1:1 2:2 mac-address 0030.94c3.8724
dial-peer voice 6000 pots destination-pattern 6000 huntstop port 1/0/0 description answering-machine
The following is an example that uses the huntstop channel command. It shows a dual-line ephone-dn configuration in which calls do not hunt to the second channel of any ephone-dn, but they do hunt through each ephone-dn’s channel 1 in this order: ephone-dn 10, ephone-dn 11, ephone-dn 12.
ephone-dn 10 dual-linenumber 1001no huntstophuntstop channel
ephone-dn 11 dual-linenumber 1001no huntstophuntstop channelpreference 1
ephone-dn 12 dual-linenumber 1001
no huntstophuntstop channel
preference 2
Ephone Hunt GroupsEphone hunt groups provide the ability to direct incoming calls for a specific number (the ephone hunt-group pilot number) to a defined group of ephone-dns. Incoming calls are redirected on busy or no answer from ephone-dn to ephone-dn in the list until they are answered or they reach the number that was defined as the final number. The number of maximum redirects is configurable from 5 to 20 using the max-redirect command. The default is 5 redirects. If the maximum number of redirects is reached, the call is dropped. The following types of ephone hunt groups can be defined:
• Sequential ephone hunt groups—Ephone-dns ring in the left-to-right order in which they are listed when the hunt group is defined.
• Peer ephone hunt groups—The first ephone-dn to ring is the number to the right of the ephone-dn that was the last to ring when the pilot number was last called. Ringing proceeds in a circular manner, left-to-right, for the number of hops specified when the ephone hunt group is defined.
Note that the final element in a hunt-group list may also be the pilot number for another hunt group (with suitable protection to avoid infinite loops). If a final number is assigned as the pilot number of a second hunt group, the pilot number of the first hunt group cannot be configured as a final number in any hunt group.
Figure 12-1 on page 12-8 illustrates a sequential ephone hunt group, and Figure 12-2 on page 12-9 illustrates a peer ephone hunt group.
To create ephone hunt groups, complete the tasks in the following sections:
• Configuring Sequential Ephone Hunt Groups, page 12-9
• Configuring Peer Ephone Hunt Groups, page 12-11
12-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone Hunt Groups
Figure 12-1 Sequential Ephone Hunt Group
ephone-dn 88 number 5001
ephone-dn 89 number 5002
ephone-dn 90 number 5017
ephone 1 mac-address 1111.1111.1111 button 1:88
ephone 2 mac-address 2222.2222.2222 button 1:89
ephone 3 mac-address 3333.3333.3333 button 1:90
ephone-hunt 1 sequential pilot 5601 list 5001, 5002, 5017 final 6000 preference 1 timeout 30
Any phone dials the pilot number, 5601.
Any phone dials the pilot number.
Phone 1Button 1 is extension 5001
5601
Phone 2Button 1 is extension 5002
Phone 3Button 1 is extension 5017
6000 Voice-mail server
Pilot number
8895
5
1
2
3
4
IP
IP
IP
IP
V
Extension 5001, the leftmost number in the hunt group list, rings first on phone 1. If extension 5001 is busy or does not answer, the call is redirected to extension 5002 on phone 2.
If extension 5002 on phone 2 is busy or does not answer, the call is redirected to extension 5017 on phone 3.
If phone 3 is busy or does not answer, the call is redirected to the final number, extension 6000, which is associated with a voice-mail server.
12-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone Hunt Groups
Figure 12-2 Peer Ephone Hunt Group
Configuring Sequential Ephone Hunt GroupsIn a sequential ephone hunt group, ephone-dns ring in the left-to-right order in which they are listed when the hunt group is defined. The first number to ring is always the leftmost number in the list.
SUMMARY STEPS
1. ephone-hunt hunt-tag sequential
2. pilot pilot-number
3. list dn-number, dn-number[, dn-number...]
4. final final-number
5. preference preference-order
6. timeout seconds
7. exit
ephone-dn 88 number 5001
ephone-dn 89 number 5002
ephone-dn 90 number 5017
ephone-dn 91 number 5044
ephone 1 mac-address 1111.1111.1111 button 1:88
ephone 2 mac-address 2222.2222.2222 button 1:89
ephone 3 mac-address 3333.3333.3333 button 1:90
ephone 4 mac-address 4444.4444.4444 button 1:91
ephone-hunt 1 sequential pilot 5601 list 5001, 5002, 5017, 5044 final 6000 hops 3 preference 1 timeout 30 no-reg
Any phone dials the pilot number, 5601, which is not associated with a physical phone instrument.
8895
6
Any phone dials the pilot number.
Voice-mail serverPilot number
Phone 1Button 1 is extension 5001
Phone 2Button 1 is extension 5002
Phone 3Button 1 is extension 5017
Phone 4Button 1 is extension 5044
IP
IP
IP
IP
IP
5601 6000
V
1
2
3
4
If extension 5044 is busy or does not answer, the call is redirected to extension 5001 on phone 1 (second hop).
If extension 5001 is busy or does not answer, the call has reached the maximum number of hops (3), and it is redirected to the final number, extension 6000, which is associated with a voice-mail server.
Extension 5017 on phone 3 is selected to ring first because extension 5002 was the last number to ring the last time that the pilot numberwas called.
12-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone Hunt Groups
8. telephony-service
9. max-redirect number
10. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-hunt hunt-tag sequential
Example:Router(config)# ephone-hunt 5 sequential
Enters ephone-hunt configuration mode to define a sequential ephone hunt group.
• hunt-tag—Unique sequence number that identifies this hunt group during all configuration tasks. Range is from 1 to 10.
Step 2 pilot pilot-number
Example:Router(config-ephone-hunt)# pilot 5601
Defines the pilot number, which is the number that callers dial to reach the ephone hunt group.
• pilot-number—E.164 number with a maximum length of 27 characters. A dial-plan pattern can be applied to the pilot number.
Step 3 list dn-number, dn-number[, dn-number...]
Example:Router(config-ephone-hunt)# list 5001, 5002, 5017, 5028
Defines the list of numbers to which the ephone hunt group redirects the incoming calls that are made to the pilot number. There must be from two to ten numbers in the list.
• dn-number—An ephone-dn primary or secondary number.
Step 4 final final-number
Example:Router(config-ephone-hunt)# final 6000
Defines the last number in the ephone hunt group, after which the call is no longer redirected. This number can be an ephone-dn primary or secondary number, a voice-mail pilot number, a pilot number of another hunt group, or an FXS number.
Note Once a final number is defined as a pilot number of another hunt group, the pilot number of the first hunt group cannot be configured as a final number in any other hunt group.
Step 5 preference preference-order
Example:Router(config-ephone-hunt)# preference 1
Sets a preference order for the ephone-dn associated with the hunt-group pilot number.
• preference-order—Range is from 0 to 10, where 0 is the highest preference and 10 is the lowest preference.
Step 6 timeout seconds
Example:Router(config-ephone-hunt)# timeout 30
Sets the number of seconds after which a call that is not answered at one number is redirected to the next number in the hunt-group list.
• seconds—Number of seconds. Range is from 3 to 60000. Default is 180.
Step 7 exit
Example:Router(config-ephone-hunt)# exit
Exits ephone-hunt configuration mode.
12-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone Hunt Groups
Example
The following example defines a sequential ephone hunt group with the pilot number 5601 and the final number 6000, with four numbers in the list of phones that answer for the pilot number.
ephone-hunt 1 sequentialpilot 5601list 5001, 5002, 5017, 5028 final 6000preference 1 timeout 30
Configuring Peer Ephone Hunt GroupsIn a peer ephone hunt group, the first ephone-dn to ring is the number to the right of the ephone-dn that was the last to ring when the pilot number was last called. Ringing proceeds in a circular manner, left-to-right, for the number of hops specified when the ephone hunt group is defined.
SUMMARY STEPS
1. ephone-hunt hunt-tag peer
2. pilot pilot-number
3. list dn-number, dn-number[, dn-number...]
4. final final-number
5. preference preference-order
6. hops number
7. timeout seconds
8. no-reg
9. exit
10. telephony-service
11. max-redirect number
12. exit
Step 8 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 9 max-redirect number
Example:Router(config-telephony-service)# max-redirect 8
Sets the number of times that a call can be redirected within a Cisco ITS system.
• number—Range is from 5 to 20. Default is 5.
Step 10 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Command or Action Purpose
12-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageEphone Hunt Groups
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-hunt hunt-tag peer
Example:Router(config)# ephone-hunt 5 peer
Enters ephone-hunt configuration mode to define a peer ephone hunt group.
• hunt-tag—Unique sequence number that identifies this hunt group during all configuration tasks. Range is from 1 to 10.
Step 2 pilot pilot-number
Example:Router(config-ephone-hunt)# pilot 5601
Defines the pilot number, which is the number that callers dial to reach the hunt group.
• pilot-number—E.164 number with a maximum length of 27 characters. The dialplan pattern can be applied to the pilot number.
Step 3 list dn-number, dn-number[, dn-number...]
Example:Router(config-ephone-hunt)# list 5001, 5002, 5017, 5028
Defines the list of numbers to which the ephone hunt group redirects the incoming calls that are made to the pilot number. There must be from two to ten numbers in the list.
• dn-number—An ephone-dn primary or secondary number.
Step 4 final final-number
Example:Router(config-ephone-hunt)# final 6000
Defines the last number in the ephone hunt group, after which the call is no longer redirected. This number can be an ephone-dn primary or secondary number, a voice-mail pilot number, a pilot number of another hunt group, or an FXS caller ID number.
Note Once a final number is defined as a pilot number of another hunt group, the pilot number of the first hunt group cannot be configured as a final number in any other hunt group.
Step 5 preference preference-order
Example:Router(config-ephone-hunt)# preference 1
Sets a preference order for the ephone-dn associated with the hunt-group pilot number.
• preference-order—Range is from 0 to 10, where 0 is the highest preference and 10 is the lowest preference.
Step 6 hops number
Example:Router(config-ephone-hunt)# hops 7
Sets the number of hops before a call proceeds to the final number. Range is from 2 to 10.
Step 7 timeout seconds
Example:Router(config-ephone-hunt)# timeout 30
Sets the number of seconds after which a call that is not answered at one number is redirected to the next number in the hunt-group list.
• seconds—Number of seconds. Range is from 3 to 60000. Default is 180.
Step 8 no-reg
Example:Router(config-ephone-hunt)# no-reg
Prevents the hunt-group pilot number from registering with an H.323 gatekeeper.
12-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageCall-Pickup Groups
Example
The following example defines peer ephone hunt group 1 with a pilot number 5601, a final number 6000, and eight numbers in the list. After a call is redirected four times (makes four hops), it is redirected to the final number.
ephone-hunt 1 peerpilot 5601 list 5001, 5002, 5017, 5028, 5066, 5067, 5077, 5085final 6000 hops 4preference 1 timeout 30 no-reg
Call-Pickup GroupsCisco ITS allows administrators to associate pickup groups with individual ephone-dn entries, making it easier for phone users to answer, or pick up, a call that is ringing on a different ephone-dn. If both ephone-dns are in the same pickup group, the user presses fewer keys to pick up the call.
Call pickup has the following variations:
• Call pickup, explicit ringing extension—The phone user presses the PickUp soft key and then dials the ephone-dn of the ringing telephone. Note that this method can also be used to pick up a call that is on hold on another ephone-dn.
• Call pickup, explicit group ringing extension—The phone user presses the GPickUp soft key and then dials the group number of the ringing telephone. If there is only one pickup group defined in the entire ITS system, the user needs only to press the GPickUp soft key.
• Call pickup, local group ringing extension—If the ringing telephone and the user’s phone are in the same pickup group, the phone user presses the GPickUp soft key and presses the asterisk (*) key to pick up the call on the ringing telephone.
Step 9 exit
Example:Router(config-ephone-hunt)# exit
Exits ephone-hunt configuration mode.
Step 10 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 11 max-redirect number
Example:Router(config-telephony-service)# max-redirect 8
Sets the number of times that a call can be redirected within a Cisco ITS system.
• number—Range is from 5 to 20. Default is 5.
Step 12 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
Command or Action Purpose
12-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageCall-Pickup Groups
Administrators can assign each ephone-dn independently to a maximum of one pickup group. A ephone-dn that does not belong to any pickup group can still pick up a ringing call by dialing the ephone-dn on which the call is ringing or the pickup group number of that ephone-dn.
Pickup group numbers may be of varying length, but must have unique leading digits. For example, you cannot define pickup group 17 and pickup group 177 for the same Cisco ITS system, because a pickup in group 17 will always be triggered before the user can enter the final 7 for 177.
There is no limit to the number of ephone-dns that can be assigned to a single pickup group, and there is no limit to the number of pickup groups that can be defined in a Cisco ITS system.
Figure 12-3 on page 12-15 shows four call pickup scenarios.
12-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageCall-Pickup Groups
Figure 12-3 Call Pickup
ephone-dn 55 number 5555 pickup-group 33
ephone-dn 56 number 5556 pickup-group 33
ephone-dn 57 number 5557 pickup-group 44
ephone-dn 58 number 5558...ephone 1 mac-address 1111.1111.1111 button 1:55
ephone 2 mac-address 2222.2222.2222 button 1:56
ephone 3 mac-address 3333.3333.3333 button 1:57
ephone 4 mac-address 4444.4444.4444 button 1:58...
Phone 3Extension 5557Pickup group 44
Phone 4Extension 5558No pickup group
Phone 1Extension 5555Pickup group 33
Phone 2Extension 5556Pickup group 33
Extension 5555 rings. User at phone 3 presses soft key and dials 33.
Phone 3Extension 5557Pickup group 44
Phone 4Extension 5558No pickup group
Phone 1Extension 5555Pickup group 33
Phone 2Extension 5556Pickup group 33
Extension 5555 rings. User at phone 2 presses GPickUp soft key and * (asterisk).
Phone 1Extension 5555Pickup group 33
Phone 2Extension 5556Pickup group 33
Extension 5555 rings. User at phone 2 presses
Phone 3Extension 5557Pickup group 44
Phone 4Extension 5558No pickup group
Phone 1Extension 5555Pickup group 33
Phone 2Extension 5556Pickup group 33
Extension 5555 rings.
8895
4
21
21
21
21
IP IP
IP IP
IP IP
IP
IP IP
IP IP
IPIP
IP
Call Pickup, No Group or Unknown Group
Call Pickup in the Same Group
Call Pickup from a Different Group
Call Pickup, a Single Group for All ITS Phones
GPickUp
GPickUp soft key.
This scenario assumes that every phone in the ITS system is in pickup group 33, which differs slightly from the sample configuration shown to the right.
User at phone 4 presses PickUp soft key and dials 5555.
12-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 12 Configuring Secondary Call CoverageCall-Pickup Groups
SUMMARY STEPS
1. ephone-dn dn-tag
2. pickup-group number
3. exit
DETAILED STEPS
Example
The following example assigns the line that has an ephone-dn tag of 55 to pickup group 2345:
ephone-dn 55pickup-group 2345
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 55
Enters ephone-dn configuration mode.
• dn-tag—Unique identifier for the ephone-dn (extension) that you want to add to a pickup group.
Step 2 pickup-group number
Example:Router(config-ephone-dn)# pickup-group 2345
Assigns this ephone-dn to a pickup group.
• number—Digit string of up to 32 characters. Group numbers in an ITS system may be of varying length, but they must have unique leading digits. For example, if there is a group numbered 17, there cannot also be a group numbered 177.
Step 3 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
12-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 13
Configuring DirectoriesThis chapter describes features related to directory service in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Local Directory Order, page 13-1
• Additional Directory Entries, page 13-2
• Local Directory Disable, page 13-3
Local Directory OrderThis task configures whether the names in the local directory appear with their first names first or their last names first.
SUMMARY STEPS
1. telephony-service
2. directory {first-name-first | last-name-first}
3. exit
13-1Version 3.0 System Administrator Guide
Chapter 13 Configuring DirectoriesAdditional Directory Entries
DETAILED STEPS
Example
The following example defines the naming order for the local directory on IP phones served by the ITS router:
telephony-servicedirectory last-name-first
Additional Directory EntriesThe Cisco ITS system automatically creates a local phone directory according to the telephone numbers that are assigned during ephone-dn configuration. Additional entries to the local ITS directory can be made using the directory entry command. The additional numbers can be nonlocal numbers, such as telephone numbers of other Cisco ITS systems used by the same corporation.
Use the show telephony-service directory-entry command to display the entries made using the directory entry command.
SUMMARY STEPS
1. telephony-service
2. directory entry {[entry-tag number name name] | clear}
3. exit
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 directory {first-name-first | last-name-first}
Example:Router(config-telephony-service)# directory last-name-first
Defines the local directory naming order.
Note The actual directory of names and phone numbers is built using the name command and the number command in ephone-dn configuration mode.
When the command is set with the first-name-first keyword, you see the directory information displayed on the phone, for example, Jane E. Smith; and when the command is set with the last-name-first keyword, you see the directory information displayed on the phone as, for example, Smith, Jane E.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
13-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 13 Configuring DirectoriesLocal Directory Disable
DETAILED STEPS
Example
The following example creates a directory of three telephone listings:
telephony-servicedirectory entry 1 14045550111 name Salesdirectory entry 2 13125550122 name Marketingdirectory entry 3 12135550144 name Support
Local Directory DisableThe local directory that is displayed on an IP phone (item 4 in the Local Services menu) is served as an XML page that is accessed through HTTP without password protection. The no service local-directory command disables the directory HTTP service to suppress the availability of this directory.
SUMMARY STEPS
1. telephony-service
2. no service local-directory
3. exit
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 directory entry {entry-tag number name name | clear}
Example:Router(config-telephony-service)# directory entry 1 5550111 name Sales
Creates a telephone directory entry that is displayed on an IP phone. Entries appear in the order in which they are entered.
• entry-tag—Unique sequence number that identifies this directory entry during all configuration tasks. Range is from 1 to 100.
• number—Telephone number or extension for the entry, up to 32 characters.
• name name—Name of up to 24 characters that will appear in the directory.
• clear—Removes all directory entries.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
13-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 13 Configuring DirectoriesLocal Directory Disable
DETAILED STEPS
Example
The following example disables the local directory on IP phones served by the ITS router:
telephony-serviceno service local-directory
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 no service local-directory
Example:Router(config-telephony-service)# no service local-directory
Disables local directory service on IP phones.
Step 3 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
13-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 14
Configuring Productivity ToolsThis chapter describes several features that can help phone users be more productive in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system.
Contents• Related Features, page 14-1
• Flash Soft Key for Hookflash Functionality, page 14-2
• Intercom, page 14-3
• Paging, page 14-6
• Account Code Entry by User, page 14-14
• Applications Integration with Cisco ITS, page 14-14
Related FeaturesOther features that can be used on Cisco IP phones to improve productivity include the following:
• Label support, in Chapter 10, “Configuring an Attendant for Primary Call Coverage.”
• Silent ring on Cisco IP Phone 7960 and Cisco IP Phone Expansion Module 7914, in Chapter 10, “Configuring an Attendant for Primary Call Coverage.”
14-1Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsFlash Soft Key for Hookflash Functionality
Flash Soft Key for Hookflash FunctionalityCertain PSTN services, such as three-way calling and call waiting, require hookflash intervention from a phone user. A new soft key, labeled Flash, has been introduced to provide this functionality for Cisco IP Phone 7940 and Cisco IP Phone 7960 users on FXO lines attached to the ITS system. The Flash soft key is enabled using the fxo hook-flash command.
Once a Flash soft key has been enabled on an IP phone, it is available to provide hookflash functionality during all calls except for local IP-phone-to-IP-phone calls. Note that hookflash-controlled services can be activated only if they are supported by the PSTN connection that is involved in the call and that the availability of the Flash soft key does not guarantee that hookflash-based services are actually accessible to the phone user.
SUMMARY STEPS
1. telephony-service
2. fxo hook-flash
3. restart all
4. exit
DETAILED STEPS
Example
The following example enables the Flash soft key for a Cisco IP Phone 7940 or a Cisco IP Phone 7960 that receives calls from PSTN phones through an FXO voice port.
telephony-servicefxo hook-flash
Command or Action Purpose
Step 1 telephony-service
Example:Router(config)# telephony-service
Enters telephony-service configuration mode.
Step 2 fxo hook-flash
Example:Router(config-telephony-service)# fxo hook-flash
Enables the Flash soft key on a Cisco IP Phone 7940 or a Cisco IP Phone 7960 that receives calls from PSTN phones through an FXO voice port.
The Flash soft key display is automatically disabled for local IP-phone-to-IP-phone calls.
Step 3 restart all
Example:Router(config-telephony-service)# restart all
Performs a fast reboot of all phones associated with this ITS router. Does not contact the DHCP or TFTP server for updated information.
Step 4 exit
Example:Router(config-telephony-service)# exit
Exits telephony-service configuration mode.
14-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsIntercom
IntercomCisco ITS supports intercom functionality for one-way and press-to-answer voice connections using a dedicated pair of intercom ephone-dns on two phones that speed-dial each other.
When an intercom speed-dial button is pressed, a call is speed-dialed to the ephone-dn that is the other half of the dedicated pair. The called ephone-dn automatically answers the call in speakerphone mode with mute activated, which provides a one-way voice path from the initiator to the recipient. A beep is sounded when the call is auto-answered to alert the recipient to the incoming call. To respond to the intercom call and open a two-way voice path, the recipient deactivates the mute function by taking one of the following actions:
• On a multibutton phone, pressing the Mute button.
• On a Cisco IP Phone 7910, lifting the handset.
Intercom lines cannot be used in shared-line configurations. If an ephone-dn is configured for intercom operation, it must be associated with one IP phone only. The intercom attribute causes an IP phone line (ephone-dn) to operate as an autodial line for outbound calls and as an autoanswer-with-mute line for inbound calls. Figure 14-1 shows an intercom between a receptionist and a manager.
To prevent an unauthorized phone from dialing an intercom line (and creating a situation in which a phone automatically answers a non-intercom call), you can assign the intercom ephone-dn a dialing string with an alphabetic character. No one can dial the alphabetic character from a normal phone, but the phone at the other end of the intercom can be configured to dial the number that contains the alphabetic character through the ITS router. For example, the intercom ephone-dns in Figure 14-1 have been assigned numbers with alphabetic characters so that no one but the receptionist can call the manager on their intercom line, and no one but the manager can call the receptionist on their intercom line.
Note An intercom requires configuration of two ephone-dns, each on a separate phone.
Figure 14-1 Intercom
ephone-dn 2 number 2345
ephone-dn 3 number 4578
ephone-dn 18 number A5001 name "Intercom" intercom A5002
ephone-dn 19 number A5002 name "Intercom" intercom A5001
ephone 6 button 1:2 2:18
ephone 7 button 1:3 2:19
The receptionist at phone 6 makes an intercom call to phone 7 by pressing button 2.
Phone 7 beeps once and automatically answers in speakerphone mode with mute activated. The manager hears the receptionist’s voice and deactivates the mute function to open a two-way voice path for a reply.
Phone 7 - ManagerButton 1 is extension 4578, a normal line.
Phone 6 - ReceptionistButton 1 is extension 2345, a normal line.
8895
2
21
IP IPV
Button 2 is extension A5001, a dedicated intercom connection to intercom extensionA5002 on phone 7.
Button 2 is extension A5002, a dedicated intercom connection to intercom extensionA5001 on phone 6.
14-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsIntercom
SUMMARY STEPS
1. ephone-dn dn-tag
2. number number
3. name name
4. intercom directory-number [barge-in | no-auto-answer] [label label]
5. exit
6. Repeat Steps 1 through 5 for the second ephone-dn.
7. ephone phone-tag
8. button button-number:dn-tag [[button-number:dn-tag] ...]
9. restart
10. exit
11. Repeat Steps 7 through 10 for the second phone.
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn dn-tag
Example:Router(config)# ephone-dn 11
Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies this intercom ephone-dn during configuration tasks. Range is from 1 to 288.
Step 2 number number
Example:Router(config-ephone-dn)# number A2345
Assigns a valid intercom number.
• number—String that contains up to 16 numeric characters. If this ephone-dn is an intercom ephone-dn, alphabetic characters can be included for security. One or more alphabetic characters in an intercom number ensures that the number can only be dialed from the one other intercom number that is programmed to dial this number. The number cannot be dialed from a normal phone if it contains an alphabetic character.
Step 3 name name
Example:Router(config-ephone-dn)# name intercom
Sets a name to be associated with the ephone-dn. This name is used for caller-ID displays and also shows up in the local directory associated with the ephone-dn.
14-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsIntercom
Step 4 intercom directory-number [barge-in | no-auto-answer] [label label]
Example:Router(config-ephone-dn)# intercom A2346 label Security
Defines the ephone-dn that is speed-dialed for the intercom feature when this line is used.
• directory-number—Number to speed-dial for this intercom function.
• barge-in—Specifies that an intercom call on this ephone-dn will force an existing call on the associated ephone into a call-hold state and allow the intercom call to be immediately answered.
• no-auto-answer—Creates a connection for the IP phone line resembling private line automatic ringdown (PLAR).
• label label—Defines a text label of up to 24 characters for the intercom ephone-dn. This label is used for caller-ID displays and directory lists.
Step 5 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Step 6 Repeat Steps 1 through 5 for the second ephone-dn. The intercom feature requires configuration of separate ephone-dns at each end of the two-way voice path.
Step 7 ephone phone-tag
Example:Router(config)# ephone 24
Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies the ephone that is to receive the intercom ephone-dn.
Step 8 button button-number:dn-tag [[button-number:dn-tag] ...]
Example:Router(config-ephone)# button 1:1 2:4 3:14
Assigns a button number to the intercom ephone-dn that you just defined. Use the colon separator (:) between the button number and the intercom ephone-dn tag to indicate a normal ring for the intercom line.
For other keywords and arguments for this command, see the “Setting Up Individual Directory Numbers and Phones” section in Chapter 3, “Setting Up Phones in an ITS System.”
Step 9 restart
Example:Router(config-ephone)# restart
Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information.
Step 10 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Step 11 Repeat Steps 7 through 10 for the second phone. The intercom feature requires configuration of an ephone at each end of the two-way voice path.
Command or Action Purpose
14-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Example
The following example shows an intercom between two Cisco IP phones. In this example, ephone-dn 2 and ephone-dn 4 are normal extensions, while ephone-dn 18 and ephone-dn 19 are set as an intercom pair. Ephone-dn 18 is associated with line button 2 on Cisco IP phone 4. Ephone-dn 19 is associated with line button 2 on Cisco IP phone 5. The two ephone-dns provide a two-way intercom between the two Cisco IP phones.
ephone-dn 2number 5333
ephone-dn 4number 5222
ephone-dn 18number 5001name “intercom”intercom 5002 barge-in
ephone-dn 19name “intercom”number 5002intercom 5001 barge-in
ephone 4button 1:2 2:18
ephone 5button 1:4 2:19
PagingAudio paging provides a one-way voice path to the phones that have been designated to receive paging. It does not have a press-to-answer option like the intercom feature. A paging group is created using a dummy ephone-dn, known as the paging ephone-dn, that can be associated with any number of local IP phones. The paging ephone-dn can be dialed from anywhere, including on-net. Figure 14-2 shows a paging group with two phones.
When a caller dials the paging number (ephone-dn), each idle IP phone that has been configured with the paging number automatically answers using its speakerphone mode. Displays on the phones that answer the page show the caller ID that has been set using the name command under the paging ephone-dn. When the caller finishes speaking the message and hangs up, the phones are returned to their idle states.
Several paging groups can be specified in an ITS system and two or more paging groups can be joined into a combined group.
The paging mechanism supports audio distribution using IP multicast, replicated unicast, and a mixture of both (so that multicast is used where possible, and unicast is used for specific phones that cannot be reached using multicast).
To configure paging, complete one the first or both of the following tasks:
• Configuring Paging for a Single Group, page 14-8
• Configuring Paging for a Combined Group, page 14-11
14-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Figure 14-2 Paging
RestrictionsIP phones do not support multicast at 224.x.x.x addresses.
Note that paging-dns are not assigned to phone buttons.
Any phone dials 4444.
ephone-dn 4 number 4444 name Paging Shipping
ephone-dn 21 number 2121
ephone-dn 22 number 2222
ephone 1 mac-address 3662.0234.6ae2 button 1:21 paging-dn 4 ephone 2 mac-address 9387.6738.2873 button 1:22 paging-dn 4
Phone 1Button 1 is extension 2121, a normal line.This phone has a paging-dn to receive pages.
To page all the phones in the shipping department, a person at any phone dials the number associated with the paging ephone-dn for the shipping department. The paging ephone-dn has a number that does not appear on any phone (in this example, extension 4444).
Phone 2Button 1 is extension 2222, a normal line.This phone has a paging-dn to receive pages.
Ephone-dn 4Extension 4444This is a paging ephone-dn; no physical phone instrument is associated with this number.
4444
8895
3
2
1
V
IP
IP
IP
paging ip 239.0.1.20 port 2000
A one-way voice connection is automaticallymade with all idle ephones that are configured with paging ephone-dn 4. In this example, that is phone 1 and phone 2. Both phones answer the call in speakerphone mode. The voice of the calling party is heard through the speaker, and the phone displays the caller ID (name) of paging ephone-dn 4 ("Paging Shipping").
14-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Configuring Paging for a Single GroupThe paging feature defines an ephone-dn that broadcasts unicast audio paging to a single group of idle Cisco IP phones that have been associated with the paging ephone-dn tag.
SUMMARY STEPS
1. ephone-dn paging-dn-tag
2. number number
3. name name
4. paging [ip multicast-address port udp-port-number]
5. exit
6. ephone phone-tag
7. paging-dn paging-dn-tag {multicast | unicast}
8. exit
9. Repeat Steps 6 through 8 to add additional IP phones to the paging group.
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn paging-dn-tag
Example:Router(config)# ephone-dn 42
Enters ephone-dn configuration mode.
• paging-dn-tag—A unique sequence number that identifies this paging ephone-dn during all configuration tasks. This is the ephone-dn that is dialed to initiate a page. This ephone-dn is not associated with a physical phone. Range is from 1 to 288.
Step 2 number number
Example:Router(config-ephone-dn)# number 3556
Defines an extension number associated with the paging ephone-dn. This is the number that people call to initiate a page.
Step 3 name name
Example:Router(config-ephone-dn)# name paging4
Assigns to the paging number a name to appear in caller-ID displays and directories.
14-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Step 4 paging [ip multicast-address port udp-port-number]
Example:Router(config-ephone-dn)# paging ip 239.1.1.10 port 2000
Specifies that this ephone-dn is to be used to broadcast audio paging messages to the idle IP phones that are associated with the paging dn-tag. If the optional keywords and arguments are not used, IP phones are paged individually using IP unicast transmission (to a maximum of ten IP phones). The optional keywords and arguments are as follows:
• ip multicast-address port udp-port-number—Specifies multicast broadcast using the specified IP address and UDP port. When multiple paging numbers are configured, each paging number must use a unique IP multicast address. Port 2000 is recommended because it is already used for normal nonmulitcast RTP media streams between phones and the ITS router.
Note IP phones do not support multicast at 224.x.x.x addresses.
Step 5 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Step 6 ephone phone-tag
Example:Router(config)# ephone 2
Enters ephone configuration mode to add IP phones to the paging group.
• phone-tag—Unique sequence number of a phone that should receive audio pages from the paging ephone-dn.
Step 7 paging-dn paging-dn-tag {multicast | unicast}
Example:Router(config-ephone)# paging-dn 42 multicast
Associates this ephone with the ephone-dn tag used for the audio paging ephone-dn. Note that the paging ephone-dn tag is not associated with a line button on this ephone.
The paging mechanism supports audio distribution using IP multicast, replicated unicast, and a mixture of both (so that multicast is used where possible and unicast is allowed to specific phones that cannot be reached through multicast).
• paging-dn-tag—Unique sequence number that was assigned to the paging ephone-dn.
• multicast—Multicast paging for groups. By default, audio paging is transmitted to the Cisco IP phone using multicast.
• unicast—Unicast paging for a single Cisco IP phone. This keyword indicates that the Cisco IP phone is not capable of receiving audio paging through multicast and requests that the phone receives the audio paging through a unicast transmission directed to the individual phone.
Note The number of phones supported through unicast is limited to a maximum of ten phones.
Command or Action Purpose
14-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Examples
The following example sets up an ephone-dn for multicast paging. This example creates a paging number for 5001 on ephone-dn 22 and adds ephone 4 as a member of the paging set. Multicast is set for the paging-dn.
ephone-dn 22 name Paging Shipping number 5001 paging ip 239.1.1.10 port 2000
ephone 4 mac-address 0030.94c3.8724 button 1:1 2:2 paging-dn 22 multicast
In this example, paging calls to 2000 are multicast to Cisco IP phones 1 and 2, and paging calls to 2001 go to Cisco IP phones 3 and 4. Note that the paging ephone-dns (20 and 21) are not assigned to any phone buttons.
ephone-dn 20number 2000paging ip 239.0.1.20 port 2000
ephone-dn 21number 2001paging ip 239.0.1.21 port 2000
ephone 1mac-address 3662.024.6ae2button 1:1paging-dn 20
ephone 2mac-address 9387.678.2873button 1:2paging-dn 20
ephone 3mac-address 0478.2a78.8640button 1:3paging-dn 21
ephone 4mac-address 4398.b694.456button 1:4paging-dn 21
Step 8 exit
Example:Router(config-ephone)# exit
Exits ephone configuration mode.
Step 9 Repeat Steps 6 through 8 to add more phones to the paging group.
Command or Action Purpose
14-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Configuring Paging for a Combined GroupYou can join the groups that you created using the instructions in the “Configuring Paging for a Single Group” section on page 14-8 into a combined group.
By configuring the ability to page combined groups in addition to single groups, you provide phone users with the flexibility to page a small local paging group (for example, paging to four phones in a company’s technical support department) or to page a combined set of several paging groups (for example, by paging a group that consists of technical support and sales phones).
Prerequisites
You must specify two or more individual paging groups as explained in the “Configuring Paging for a Single Group” section on page 14-8 before combining those groups in this task.
SUMMARY STEPS
1. ephone-dn group-paging-dn-tag
2. number number
3. name name
4. paging [ip multicast-address port udp-port-number]
5. paging group paging-dn-tag,paging-dn-tag[[,paging-dn-tag]...]
6. exit
DETAILED STEPS
Command or Action Purpose
Step 1 ephone-dn group-paging-dn-tag
Example:Router(config)# ephone-dn 20
Enters ephone-dn configuration mode to create a paging ephone-dn for the multiple group.
• group-paging-dn-tag—Unique sequence number to identify this combined paging group during configuration tasks.
Step 2 number number
Example:Router(config-ephone-dn)# number 2000
Assigns an extension number to be dialed in order to send a page to the combined paging group that is being defined.
Step 3 name name
Example:Router(config-ephone-dn)# name Paging AllGroups
Assigns to the combined paging number a name to appear in caller-ID displays and directories, up to 24 characters.
14-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
Example
This example sets the following paging behavior:
• When extension 2000 is dialed, a page is sent to ephones 1 and 2 (single paging group).
• When extension 2001 is dialed, a page is sent to ephones 3 and 4 (single paging group).
• When extension 2002 is dialed, a page is sent to ephones 1, 2, 3, 4, and 5 (combined paging group).
Ephones 1 and 2 are included in paging ephone-dn 22 through the membership of ephone-dn 20 in the combined paging group. Ephones 3 and 4 are included in paging ephone-dn 22 through membership of ephone-dn 21 in the combined paging group. Ephone 5 is directly subscribed to paging-dn 22.
ephone-dn 20 number 2000 paging ip 239.0.1.20 port 2000
ephone-dn 21 number 2001 paging ip 239.0.1.21 port 2000
Step 4 paging [ip multicast-address port udp-port-number]
Example:Router(config-ephone-dn)# paging ip 239.1.1.10 port 2000
Specifies that this ephone-dn is to be used to broadcast audio paging messages to the idle IP phones that are associated with the paging dn-tag. If the optional keywords and arguments are not used, IP phones are paged individually using IP unicast transmission (to a maximum of ten IP phones). The optional keywords and arguments are as follows:
• ip multicast-address port udp-port-number—Specifies multicast broadcast using the specified IP address and UDP port. This is the recommended operation. When multiple paging numbers are configured, each number must use a unique IP multicast address.
Step 5 paging group paging-dn-tag,paging-dn-tag [[,paging-dn-tag]...]
Example:Router(config-ephone-dn)# paging group 20,21
Sets the audio paging directory number for a combined group. The paging group command combines the individual paging group ephone-dns into a combined group so that a page can be sent to more than one paging group at one time.
Note Configure the paging command for all ephone-dns in a group prior to configuring the paging group command for that group.
• paging-dn-tag—Unique sequence number associated with the paging number for an individual paging group, as described in the “Configuring Paging for a Single Group” section on page 14-8. List the paging-dn-tags of all the individual groups that you want to include in this combined group, separated by commas. You can include up to ten paging ephone-dn tags in this command.
Step 6 exit
Example:Router(config-ephone-dn)# exit
Exits ephone-dn configuration mode.
Command or Action Purpose
14-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsPaging
ephone-dn 22 number 2002 paging ip 239.0.2.22 port 2000 paging group 20,21
ephone-dn 6 number 1103name user3
ephone-dn 7 number 1104 name user4
ephone-dn 8 number 1105 name user5
ephone-dn 9 number 1199
ephone-dn 10 number 1198
ephone 1 mac-address 1234.8903.2941button 1:6paging-dn 20
ephone 2 mac-address CFBA.321B.96FAbutton 1:7paging-dn 20
ephone 3 mac-address CFBB.3232.9611button 1:8paging-dn 21
ephone 4 mac-address 3928.3012.EE89button 1:9paging-dn 21
ephone 5 mac-address BB93.9345.0031button 1:10paging-dn 22
14-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsAccount Code Entry by User
Account Code Entry by UserCisco IP Phone 7940 and Cisco IP Phone 7960 users can enter account codes during call setup or while connected to an active call using the Acct soft key. Account codes are inserted into call detail records (CDRs) on the ITS router for later interpretation by billing software.
An account code is visible in the output of the show call active command and the show call history command for telephony call legs and is supported by the CISCO-VOICE-DIAL-CONTROL-MIB. The account code also appears as a named string of “account-code” in RADIUS Vendor-Specific Attribute (VSA) Vendor Type field 1 for voice AAA accounting.
No configuration is required for this feature. To enter an account code during call setup or while in a connected state, press the Acct soft key and enter the account code from the phone keypad.
Applications Integration with Cisco ITSCisco ITS provides an interface that enables simple one-to-one remote control of a Cisco IP phone by an associated PC that is running Cisco IOS Telephony Services Provider (TSP), a Telephony Application Programming Interface (TAPI) that supports the placing of outbound calls from an application phone address book. This interface is intended to support only basic TAPI services to enable caller-ID-based screen pop-ups for incoming calls and to support simple outgoing call placement using one-click address-book-style speed-dialing from the PC application.
Note This service does not add full TAPI support for multiple users or the multiple call handling required to implement complex features like automatic call distributor (ACD) or IP contact center (IPCC).
The PC applications software for the Cisco IOS Telephony Service—Cisco IOS TSP, a TAPI service provider software package—works as an interface between the TAPI that is running on Microsoft Windows and the ITS router. This software provides the following functionality:
• Communicates with the TAPI using the Telephony Service Provider Interface (TSPI).
• Implements a required set of APIs and works with TAPI.
• Enables other TAPI-based applications to provide call control to the Cisco IP phones connected to the Cisco ITS router.
Note Cisco ITS implements only a small subset of TAPI functionality. It supports only TAPI clients that operate on one phone line at a time. The Cisco IOS TSP support does not have full TAPI support for multiple users or for complex features. Also, this TAPI version does not have direct media- and voice-handling capabilities.
Cisco IOS TSP software increases personal productivity because users can handle call management from a PC without picking up a phone handset or dialing numbers on the phone keypad. The following functionality is available:
• Answering of incoming calls
• Forwarding of incoming calls to voice mail
• Dialing of address book entries (placing outbound calls from an application address and phone and address book)
14-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
• Providing of screen pop-ups with caller-ID displays
• Placing of calls on hold
Note Cisco IOS TSP software does not support media or voice. Media or voice is sent to the phone.
This section explains the following tasks that are related to applications integration with Cisco IOS TSP:
• Downloading and Setting Up Cisco IOS TSP, page 14-15
• Modifying a TSP Configuration, page 14-17
• Removing TSP, page 14-19
• Verifying Basic TAPI Operation, page 14-19
• Troubleshooting TSP, page 14-19
Downloading and Setting Up Cisco IOS TSPThis task prepares Cisco IOS TSP for use.
Prerequisites
• On the router, collect the following information for TSP configuration:
– Identify the Cisco IP phone that needs to be associated and controlled by a TAPI client.
– Get the username and password for the Cisco IP phone by entering the show ephone command.
– Get the IP address or name of the Cisco ITS router (if DNS is enabled) and the port number by entering the show telephony-service command.
• Download the CiscoIOSTSP.zip file from http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp to your PC. Uncompress the file and run the Setup program on a PC that is running Windows 2000 where you want to install the TSP.
SUMMARY STEPS
1. Ensure there is network connectivity between your PC and the ITS router.
2. Install CiscoIOSTSP.zip by running the Setup program.
3. Enter information into the required fields in the Cisco IOS Telephony Services Provider dialog box.
4. Following the prompt, restart your PC.
14-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
DETAILED STEPS
Step 1 Ensure that there is network connectivity between your PC and the ITS router. To verify the network connectivity, enter the ping ip-address command on your PC, specifying the IP address of the Cisco ITS router.
Step 2 Install CiscoIOSTSP.zip by running the Setup program that was downloaded. This program installs the following dynamic link library (DLL) files in the system directory of the PC:
• CiscoIOSTSP.tsp
• CiscoIOSTUISP.dll
• LogTrace.dll
Note After the DLL files are installed, a configuration dialog box, Cisco IOS Telephony Services Provider, appears before the installation is complete (shown in Figure 14-3 on page 14-17).
Step 3 Enter information into the required fields in the Cisco IOS Telephony Services Provider dialog box, as shown in Figure 14-3 on page 14-17.
a. Enter the username and password that will be used by the Cisco IP phone user.
b. Enter the IP address and port number of the ITS router.
c. Set the Synchronous Timeout response from the ITS router to the desired value in seconds. (The default is 3 seconds.)
d. If you are using a headset, check the Using HeadSet check box.
Note When the Trace check box is checked, the trace function slows down the TAPI application. Use the trace feature for troubleshooting. For further information, see the “Troubleshooting TSP” section on page 14-19.
Step 4 Following the prompt, restart your PC.
Note After the PC restarts, you have the option to launch third-party applications, such as ACT! or Phone Dialer. For further information on third-party applications, see the documents provided by those vendors.
14-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
Figure 14-3 Cisco IOS Telephony Services Provider Configuration Dialog Box
Modifying a TSP ConfigurationThe following task allows you to modify a TSP configuration that you have previously made on your PC.
SUMMARY STEPS
1. Choose the Phone and Modem option from your PC Control Panel.
2. Choose the Advanced tab to display telephony providers.
3. Choose Cisco IOS Telephony Services Provider and click Configure.
4. Make the changes that you desire in the Cisco IOS Telephony Services Provider dialog box.
5. Restart TAPI applications, and reboot your PC if prompted to do so.
14-17Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
DETAILED STEPS
Step 1 To modify a TSP configuration, choose the Phone and Modem option from your PC Control Panel. The name of this option may vary, depending on your operating system.
Step 2 Choose the Advanced tab in the Phone and Modem Options dialog box, displaying the Cisco IOS Telephony Services Provider in the Providers list (shown in Figure 14-4).
Figure 14-4 Phone and Modem Options Dialog Box
Step 3 Choose Cisco IOS Telephony Services Provider and click Configure, as shown in Figure 14-4.
The Cisco IOS Telephony Services Provider dialog box appears, as shown in Figure 14-3 on page 14-17.
Step 4 Make the changes that you desire in the Cisco IOS Telephony Services Provider dialog box, as shown in Figure 14-3 on page 14-17.
Step 5 Restart TAPI applications and reboot your PC if prompted to do so. After changing the username, password, and IP address or port of the Cisco IOS Telephony Services Provider, close all the TAPI applications for the changes to take effect. If any services, such as Remote Access Connection Manager, that depend on the Telephony service are running, restart the system for the changes to take effect. You might get a prompt to reboot your system.
14-18Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
Removing TSPThis section explains how to remove TSP from your computer.
SUMMARY STEPS
1. Choose Cisco IOS Telephony Services Provider under the Control Panel, and click the Change/Remove button.
2. Use the Add/Remove Programs option under the Control Panel to remove all TSP files from your PC.
DETAILED STEPS
Step 1 Choose Cisco IOS Telephony Services Provider under the Control Panel, and click the Change/Remove button to remove the TSP software.
Step 2 Use the Add/Remove Programs option under the Control Panel to remove all TSP files from your PC.
Verifying Basic TAPI OperationThis section explains how to verify that TAPI is working.
SUMMARY STEPS
1. Place an incoming call.
2. Place an outgoing call.
DETAILED STEPS
Step 1 Place an incoming call from another Cisco IP phone to the phone that you are verifying.
Step 2 Place an outgoing call from the Cisco IP phone that you are verifying.
Troubleshooting TSPIf you have problems with TSP, perform the following tasks:
• Troubleshooting TSP on the ITS Router
• Troubleshooting TSP on a PC
Troubleshooting TSP on the ITS Router
• Verify the IP address and the port number for the router, and make sure that they match those on the Cisco IOS Telephony Services router.
• Verify connectivity between the phone and the router.
14-19Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
• If the TSP fails to connect to the ITS router, a message box with the title “Cisco IOS Telephony Services TSP status” displays the cause for failure.
• If the Line or Address is not listed in the Preferences > Dialer dialog box, check the following settings:
– Verify that the username and password have been configured correctly (case-sensitive) and that Synchronous timeout is configured to a reasonable value (3 seconds).
– Verify that the IP address and the port number in the dialog box match those on the Cisco ITS router.
– Verify connectivity between the Cisco IP phone and the Cisco ITS router.
• Check the Trace check box as shown in Figure 14-5. The trace feature runs the trace utility logs and saves the files in a specified trace file.
Note To save the trace utility logs, name a file that you can recognize to save the trace utility logs. Each time you run the trace log, a new trace file is created, so you may need to regularly remove the old trace files that are not required.
Figure 14-5 Using Trace in the Cisco IOS Telephony Services Provider Configuration Dialog Box
14-20Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
Troubleshooting TSP on a PC
If the Cisco IOS Telephony Services Provider is not listed as one of the available providers in the Control Panel > Phone and Modem Options > Add dialog box, verify whether all the DLL files have been installed in the PC’s system directory.
14-21Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter 14 Configuring Productivity ToolsApplications Integration with Cisco ITS
14-22Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 15
Monitoring and Managing an ITS SystemTo monitor and manage a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system, use the following commands:
Command Purpose
show running-config Displays the configuration.
show telephony-service all Displays the detailed configuration of all the Cisco IP phones, voice ports, and dial peers of the Cisco ITS router.
show telephony-service dial-peer Displays the output of the dial peers of the Cisco ITS router.
show telephony-service ephone-dn Displays the Cisco IP phone destination number of the Cisco ITS router.
show telephony-service tftp-bindings Displays the XML configuration files that are accessible to IP phones.
show telephony-service voice-port Displays output for the voice ports of the Cisco ITS router.
show ephone [mac-address] Displays Cisco IP phone output.
show ephone-dn tag Displays the Cisco IP phone destination number.
show ephone summary Displays a summary of all Cisco IP phones.
show ephone-dn summary Displays a summary of all Cisco IP phone destination numbers.
show voice port summary Displays a summary of all voice ports.
show dial-peer voice summary Displays a summary of all voice dial peers.
15-1Version 3.0 System Administrator Guide
Chapter 15 Monitoring and Managing an ITS System
15-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services
C H A P T E R 16
Troubleshooting an ITS SystemNote For more information about voice and fax troubleshooting, see Cisco IOS Voice Troubleshooting and Monitoring.
To troubleshoot the router in a Cisco IOS Telephony Services (Cisco ITS, hereinafter referred to as ITS) system, perform the following task:
Step 1 Enter the show ephone command to display all registered phones. If no phones are registered, perform the following steps:
a. Configure the Cisco ITS router.
b. Check DHCP configuration, including the default router and the TFTP server address (option 150).
c. Enter the dir command to check that the required files are in the router’s Flash memory.
d. Check that the tftp-server command is set for the required files, and use the show telephony-service tftp-bindings command to check which configuration files are accessible by IP phones using TFTP. Use the debug tftp events command to monitor TFTP file access by the IP phones during their registration attempts.
e. Enter the debug ephone register mac-address command to display Cisco IP phone registration activity.
f. Enter the debug ip dhcp command to confirm DHCP operation.
Step 2 Enter the show ephone command to display all registered phones. If phones are registered and are displayed, perform the following steps:
a. Check that the phone button binding to the directory number is correct.
b. Check that the Cisco IP phones show as registered.
c. Verify the IP parameter settings on the Cisco IP phone using the Settings display on the phone.
d. Check that the keepalive count is being updated when you enter the show ephone command.
e. Reset the phone and observe the reregistration by entering the debug ephone register mac-address command to display the Cisco IP phones.
f. Enter the show ephone-dn summary command to check the state of the Cisco IP phone lines.
g. Check the IP address of the phone, and attempt to ping the address.
Step 3 Enter the debug ephone keepalive command to set keepalive debugging for the Cisco IP phones.
16-1Version 3.0 System Administrator Guide
Chapter 16 Troubleshooting an ITS System
Step 4 Enter the debug ephone state command to set state debugging for the Cisco IP phones.
To troubleshoot other areas of the Cisco ITS router, use the following commands:
• To set detail debugging for a Cisco IP phone, use the debug ephone detail command.
• To set error debugging for a Cisco IP phone, use the debug ephone error command.
• To set message waiting indication (MWI) debugging for a Cisco IP phone, use the debug ephone MWI command.
• To set call statistics debugging for a Cisco IP phone, use the debug ephone statistics command.
• To provide voice-packet-level debugging and display the contents of one voice packet in every 1024 voice packets, use the debug ephone pak command.
• To provide raw low-level protocol debugging display for all SCCP messages, use the debug ephone raw command.
• To provide debugging for local directory search, use the debug ip http token command.
• To troubleshoot HTTP authentication problems, use the debug ip http authentication command.
• To show the URLs accessed from the router, use the debug ip http url command.
• To display HTTP server transaction processing, use the debug ip http transaction command.
For further debugging, you can use the debug commands documented in the Cisco IOS Debug Command Reference, Release 12.2 T.
16-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
C O M M A N D R E F E R E N C E
This section documents new and modified commands. All other commands used with Cisco IOS Telephony Services are documented in the Cisco IOS Release 12.2 T command reference publications at http://www.cisco.com/univercd/cc/td/doc/product/software/ios122/122newft/122tcr/.
New Commands
• after-hour exempt
• after-hours block pattern
• after-hours date
• after-hours day
• auto assign
• auto-line
• directory entry
• ephone-hunt
• fastdial
• feed
• final
• fxo hook-flash
• hops
• label
• list
• login (telephony-service)
• max-redirect
• multicast moh
• night-service bell (ephone)
• night-service bell (ephone-dn)
• night-service code
• night-service date
• night-service day
• no-reg (ephone-hunt)
• pickup-group
• pilot
• pin
• preference (ephone-hunt)
• secondary-dialtone
CR-1Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Reference
• show ephone login
• show telephony-service directory-entry
• system message
• timeout (ephone-hunt)
• timeouts ringing (telephony-service)
Modified Commands
• button
• clid strip
• ephone-dn
• huntstop (ephone-dn)
• load (telephony-service)
• moh (ephone-dn)
• moh (telephony-service)
• mwi sip-server (telephony-service)
• number (ephone-dn)
• preference (ephone-dn)
• speed-dial
• telephony-service
• type (ephone)
CR-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hour exempt
after-hour exemptTo specify that an IP phone does not have any of its outgoing calls blocked even though call blocking has been enabled, use the after-hour exempt command in ephone configuration mode. To remove the exemption, use the no form of this command.
after-hour exempt
no after-hour exempt
Syntax Description This command has no arguments or keywords.
Defaults The IP phone is not exempt from call blocking.
Command Modes Ephone configuration
Command History
Usage Guidelines Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in a Cisco ITS system are restricted if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt command.
Examples The following example specifies that outgoing calls from this phone are not blocked:
Router(config)# ephone 23Router(config-ephone)# mac 00e0.8646.9242Router(config-ephone)# button 1:33Router(config-ephone)# after-hour exempt
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
after-hours block pattern
Defines a pattern of digits for blocking outgoing calls from IP phones.
after-hours date Defines a recurring period based on month and date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
ephone Enters ephone configuration mode.
CR-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hours block pattern
after-hours block patternTo define a pattern of outgoing digits for call blocking from IP phones, use the after-hours block pattern command in telephony-service configuration mode. To delete a call-blocking pattern, use the no form of this command.
after-hours block pattern pattern-tag pattern [7-24]
no after-hours block pattern pattern-tag
Syntax Description
Defaults No pattern is defined.
Command Modes Telephony-service configuration
Command History
Usage Guidelines Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in an ITS system are restricted if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt command.
Blocked calls return a fast-busy tone to the user for approximately 10 seconds before the call is terminated and the line is returned to on-hook status.
Examples The following example defines pattern 1, which blocks international calls after hours for an ITS system that requires dialing 9 for external calls:
Router(config)# telephony-serviceRouter(config-telephony-service)# after-hours block pattern 1 9011
pattern-tag Identifier for a call-blocking pattern. Up to 32 call-blocking patterns can be defined in separate commands.
pattern Outgoing call digits to be matched for blocking.
7-24 (Optional) If the 7-24 keyword is specified, the pattern is always blocked, 7 days a week, 24 hours a day. If the 7-24 keyword is not used, the pattern is blocked during the days and dates that are defined with the after-hours day and after-hours date commands.
Release Modification
12.2(15)ZJ This command was introduced.
CR-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hours block pattern
Related Commands Command Description
after-hour exempt Specifies that an IP phone does not have any of its outgoing calls blocked even though call blocking has been defined.
after-hours date Defines a recurring period based on month and date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
telephony-service Enters telephony-service configuration mode.
CR-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hours date
after-hours dateTo define a recurring period based on month and date during which outgoing calls that match defined block patterns are blocked on IP phones, use the after-hours date command in telephony-service configuration mode. To delete a defined time period, use the no form of this command.
after-hours date month date start-time stop-time
no after-hours date month date
Syntax Description
Defaults No time period based on date is defined for call blocking.
Command Modes Telephony-service configuration
Command History
Usage Guidelines Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in an ITS system are restricted if at least one pattern and at least one time period are defined. Individual IP phones can be exempted from call blocking using the after-hour exempt command.
Call blocking for the time period that is defined in this command recurs annually on the month and date specified in the command.
Examples The following example defines January 1 as an entire day on which calls that match the pattern specified in the after-hours block pattern command are blocked:
Router(config)# telephony-serviceRouter(config-telephony-service)# after-hours date jan 1 00:00 00:00
month Abbreviated month. The following abbreviations for month are valid: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.
date Date of the month. Range is from 1 to 31.
start-time stop-time
Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time must be greater than the start time. The value 24:00 is not valid. If 00:00 is entered as an stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified date.
Release Modification
12.2(15)ZJ This command was introduced.
CR-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hours date
Related Commands Command Description
after-hour exempt Specifies that an IP phone does not have any of its outgoing calls blocked even though call blocking has been defined.
after-hours block pattern
Defines a pattern of digits for blocking outgoing calls from IP phones.
after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
telephony-service Enters telephony-service configuration mode.
CR-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hours day
after-hours dayTo define a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones, use the after-hours day command in telephony-service configuration mode. To delete a defined time period, use the no form of this command.
after-hours day day start-time stop-time
no after-hours day day
Syntax Description
Defaults No time period based on day of the week is defined for call blocking.
Command Modes Telephony-service configuration
Command History
Usage Guidelines Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in an ITS system are restricted if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt command.
Call blocking occurs during the hours between the start time and stop time on the day of the week that is specified in this command. This time period recurs weekly unless it is removed using the no form of this command.
Examples The following example defines the period from Monday night at 7 p.m. to Tuesday morning at 7 a.m. as an after-hours period:
Router(config)# telephony-serviceRouter(config-telephony-service)# after-hours day mon 19:00 7:00
day Abbreviated day of the week. The following abbreviations for day of the week are valid: sun, mon, tue, wed, thu, fri, sat.
start-time stop-time
Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time can be smaller than the start time. The value 24:00 is not valid. If 00:00 is entered as an stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified day.
Release Modification
12.2(15)ZJ This command was introduced.
CR-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceafter-hours day
Related Commands Command Description
after-hour exempt Specifies that an IP phone does not have any of its outgoing calls blocked even though call blocking has been defined.
after-hours block pattern
Defines a pattern of digits for blocking outgoing calls from IP phones.
after-hours date Defines a recurring period based on month and date during which outgoing calls that match defined block patterns are blocked on IP phones.
telephony-service Enters telephony-service configuration mode.
CR-9Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceauto assign
auto assignTo automatically assign ephone-dn tags to Cisco IP phones as they register for service with the Cisco IOS Telephony Services (ITS) router, use the auto assign command in telephony-service configuration mode. To return to the default of not automatically assigning ephone-dn tags to Cisco IP phones, use the no form of this command.
auto assign dn-tag to dn-tag [type phone-type] [cfw extn-number timeout seconds]
no auto assign dn-tag to dn-tag [type phone-type] [cfw extn-number timeout seconds]
Syntax Description
Defaults Ephone-dn tags are not automatically assigned to Cisco IP phones.
Command Modes Telephony-service configuration
Command History
dn-tag to dn-tag Range of ephone-dn tags. The maximum number of ephone-dns per ITS system is platform-dependent and version-dependent. Refer to specifications in the appropriate version-specific Cisco IOS Telephony Services (ITS) documentation. The Cisco IOS software accepts values from 1 to 288.
type phone-type (Optional) Type of Cisco IP phone to which auto-assignment should be restricted.
• phone-type—Valid entries are the following:
– 7902—Cisco IP Phone 7902G
– 7905—Cisco IP Phone 7905G
– 7910—Cisco IP Phone 7910
– 7912—Cisco IP Phone 7912G
– 7935—Cisco IP Conference Station 7935
– 7940—Cisco IP Phone 7940G
– 7960—Cisco IP Phone 7960G
– ATA—Cisco ATA-186 or Cisco ATA-188
cfw (Optional) Automatically assigned ephone-dns are provisioned for call-forward busy and no-answer to the specified extension number.
extn-number (Optional) Extension number to which calls are to be forwarded on busy and no-answer conditions.
timeout seconds (Optional; required if the cfw keyword is used) Amount of time, in seconds, to wait when a call is not being answered before forwarding it. Range is from 3 to 60000. There is no default.
Release Modification
12.2(15)ZJ This command was introduced.
CR-10Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceauto assign
Usage Guidelines This command lets you assign ranges of ephone-dn tags according to the physical phone type. Multiple auto assign commands can be used to provide discontinuous ranges and to support multiple types of IP phones. Overlapping ephone-dn ranges may be assigned so that they map to more than one type of phone. If no type is specified, the values in the range are assigned to phones of any type, but if a specific range is assigned for a phone type, the available ephone-dns in that range are used first.
This command is also used by the ITS setup tool to automatically assign ephone-dns after the tool has gathered information about the desired setup from the user. When lines are assigned by the ITS setup tool in keyswitch mode with two ephone-dn entries created for each individual extension number, the automatic assignment mechanism assigns both ephone-dn entries to an individual phone.
The auto assign command cannot be used for the Cisco IP Phone Expansion Module 7914. Phones with one or more expansion modules must be configured manually.
Automatically assigned ephone-dn tags must belong to normal ephone-dns and cannot belong to paging ephone-dns, intercom ephone-dns, music-on-hold (MOH) ephone-dns, or message-waiting-indication (MWI) ephone-dns. The ephone-dn tags that are automatically assigned must have at least a primary number defined.
All the ephone-dns in a single automatic assignment set must be of the same kind (either single-line or dual-line). Automatic assignment cannot create shared lines.
If an insufficient number of ephone-dns is available in the automatic assignment set, some phones will not receive ephone-dns.
Reversal or undoing of automatic assignment must be performed by manual command-line interface (CLI) entry.
This command must be followed by a reboot of the phones that are assigned. If you use the type keyword with this command, use the reset command to reboot the phones. If you do not use the type keyword with this command, use the restart command to perform a quick reboot.
Note Care should be taken when using the auto assign command because this command grants telephony service to any IP phone that attempts to register. If you use the auto assign configuration option, make sure that your network is secure from unauthorized access by unknown IP phones.
Examples The following example designates ephone-dn tags 1 through 4 for automatic assignment to any type of IP phone:
Router(config)# telephony-serviceRouter(config-telephony-service)# auto assign 1 to 4
The following example designates ephone-dn tags 1 through 12 for automatic assignment to Cisco IP Phone 7910 and designates ephone-dn tags 13 through 20 for automatic assignment to Cisco IP Phone 7960 with call forwarding to extension 5001 on busy or after 30 seconds of ringing with no answer:
Router(config)# telephony-serviceRouter(config-telephony-service)# auto assign 1 to 12 type 7910Router(config-telephony-service)# auto assign 13 to 20 type 7960 cfw 5001 timeout 30
Related Commands Command Description
restart Performs fast reboot of IP phone in a Cisco ITS system.
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-11Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceauto-line
auto-lineTo enable automatic line selection on an IP phone in a Cisco IOS Telephony Services (ITS) system, use the auto-line command in ephone configuration mode. To disable automatic line selection, use the no form of this command.
auto-line [incoming]
no auto-line
Syntax Description
Defaults Automatic line selection is enabled.
Command Modes Ephone configuration
Command History
Usage Guidelines Using the auto-line command without an argument enables automatic line selection on this phone. Picking up a handset answers the first ringing line or, if no line is ringing, selects the first idle line. This is also the default if this command is not used.
Using the no auto-line command disables automatic line selection on this phone. Pressing the Answer soft key answers the first ringing line, and pressing a line button selects a line for an outgoing call. Picking up the handset does not answer calls or provide dial tone.
Using the auto-line incoming command enables automatic line selection only for incoming calls. Picking up the handset answers the first ringing line but, if no line is ringing, does not select an idle line for an outgoing call. Pressing a line button selects a line for an outgoing call.
Examples The following example disables automatic line selection. The phone user must use the Answer soft key or press a line button for calls:
Router(config)# ephone 23Router(config-ephone)# no auto-line
Related Commands
incoming (Optional) Enables automatic line selection only for incoming calls on this phone.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone Enters ephone configuration mode.
CR-12Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencebutton
buttonTo associate ephone-dns with individual buttons on a Cisco IP phone and to specify ring behavior, use the button command in ephone configuration mode. To delete ephone-dns from buttons on a Cisco IP phone, use the no form of this command.
button button-number{separator}dn-tag [[button-number{separator}dn-tag] ...]
no button button-number{separator}dn-tag [[button-number{separator}dn-tag] ...]
Syntax Description button-number Number of a line button on a Cisco IP phone to be associated with an extension (ephone-dn).
The maximum number of button-ephone-dn pairs is determined by phone type, as follows:
• Cisco IP Phone 7902G, Cisco IP Phone 7905G, Cisco IP Phone 7910, Cisco IP Phone 7910, Cisco IP Phone 7912G, Cisco IP Conference Station 7935, and Cisco IP Phone 7940G—one or two button-ephone-dn pairs.
• Cisco IP Phone 7960G—up to six button-ephone-dn pairs.
Note The Cisco IP Phone 7910 has only one physical line button, but you can assign it up to two button-ephone-dn pairs.
separator Single character that denotes the characteristics to be associated with this button and extension or extensions. Valid entries include the following:
• : (colon)—Normal ring. For incoming calls on this extension, the phone produces audible ringing, a flashing ((< icon in the phone display, and a flashing red light on the handset. On the Cisco IP Phone Expansion Module 7914, a flashing yellow light also accompanies incoming calls.
• b—Beep but no ring. Audible ring is suppressed for incoming calls, but call-waiting beeps are allowed. Visible cues are the same as described for normal ring.
• f—Feature ring. Differentiates incoming calls on a special line from incoming calls on other lines on the phone. The feature ring cadence is a triple pulse, as opposed to a single pulse for normal internal calls and a double pulse for normal external calls.
• m—Monitor mode for a shared line. Visible line status indicates in-use or not. Line cannot be used on this phone for incoming or outgoing calls.
• o—Overlay line. Multiple ephone-dns share a single button, up to a maximum of ten on a button. The dn-tag argument can contain up to ten individual dn-tags, separated by commas.
• s—Silent ring. Audible ring and call-waiting beep are suppressed for incoming calls. Visible cues are the same as described for normal ring
dn-tag Ephone-dn tag previously defined using the ephone-dn command. Note that when used with the o keyword, the dn-tag argument can contain up to ten individual dn-tags, separated by commas.
CR-13Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencebutton
Defaults No default behavior or values
Command Modes Ephone configuration
Command History
Usage Guidelines The button command assigns telephone extensions to Cisco IP phones by associating a button number with one or more extensions (ephone-dns).
Note After adding or changing the button configuration on a phone using this command, you must perform a quick reboot of the phone using the restart command.
Telephone services such as call waiting and three-party conferences require a minimum of two phone lines (ephone-dns defined with the ephone-dn command) to be available and configured on a Cisco IP phone. The Cisco IP Phone 7910 has only one physical line button. To support call waiting and three-party conferences on a Cisco IP Phone 7910, a second (hidden) line is required. This line cannot be selected directly using a line button. You can access the second line when you press the Conference button. You can also support multiple-call services using the ephone-dn dual-line configuration option.
Silent ring can be configured on any type of phone, but typically you set silent ring only on buttons of a phone with multiple lines, such as a Cisco IP Phone 7940, a Cisco IP Phone 7960, or a Cisco IP Phone Expansion Module 7914.
A line button set in monitor mode on one phone provides visual line status for a line that also appears on another phone. When monitor mode is set for a button with a shared line, the line status indicates that the shared line is either idle (shows an idle phone icon) or in use (shows a phone icon with a flashing X through it). The line and line button are available in monitor mode for visual status only. Calls cannot be made or received using a line button that has been set in monitor mode. Incoming calls on a line button that is in monitor mode do not ring and do not display caller ID or call-waiting caller ID. Monitor mode is intended to be used only in the context of shared lines so that a receptionist can visually monitor the in-use status of several users’ phone extensions (for example, as a busy-lamp field).
The line button for a monitored line can also be used as a direct-station-select for a call transfer when the monitored line is in an idle state. In this case, the receptionist who transfers a call from a normal line can press the Transfer button and then press the line button of the monitored line, causing the call to be transferred to the phone number of the monitored line. The direct-station-select operation is not supported when the monitored line is in use.
Release Modification
12.1(5)YD This command was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(11)YT The s and b keywords were added.
12.2(15)ZJ The f, m, and o keywords were added.
CR-14Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencebutton
A feature ring is a third type of ring cadence in addition to internal call and external call ring cadences. For example, an internal call in the United States rings for 2 seconds on and 4 seconds off (single-pulse ring), and an external call rings for 0.4 seconds on, 0.2 seconds off, 0.4 seconds on, and 0.2 seconds off (double-pulse ring). A feature ring is a triple-pulse ring. The purpose of associating a feature ring with a line button is to be able to identify from a distance a special line that is ringing on a multiline phone.
Overlay lines are ephone-dns that share a single button on a multibutton phone. When more than one incoming call arrives on lines that are set on a single button, the line (ephone-dn) that is the left-most in the button command is given the highest priority. If this call is answered by another phone or the caller hangs up, the phone selects the next line in its overlay set to present as the ringing call. The caller ID display updates to show the caller ID for the currently presented call.
Ephone-dns that are part of an overlay set can be single-line ephone-dns or dual-line ephone-dns, but the set must contain all single-line ephone-dns or all dual-line ephone-dns, and not a mixture of the two.
Examples The following example assigns four button numbers on the phone to ephone-dn tags, and button 4 has a silent ring:
Router(config)# ephone 1Router(config-ephone)# button 1:1 2:4 3:16 4s19
The following example shows three phones that each have three instances of extension number 1001 overlaid onto a single button, which allows three simultaneous calls to extension 1001. The first call arrives on ephone-dn 1 and rings button 1 on all three phones. The call is answered on ephone 10. A second call for 1001 hunts onto ephone-dn 2 and rings on the remaining two ephones, ephones 11 and 12, and is answered by ephone 12. A third call to 1001 hunts onto ephone-dn 3 and rings on ephone 12, where it is answered. This configuration creates a three-way shared line across three IP phones and can handle three simultaneous calls to the same telephone number.
ephone-dn 1number 1001no huntstop
!ephone-dn 2number 1001no huntstoppreference 1
!ephone-dn 3number 1001no huntstoppreference 2
!! The next ephone configuration includes the first instance of shared line 1001.ephone 10mac-address 1111.2222.3333button 1o1,2,3
!! The next ephone configuration includes the second instance of shared line 1001.ephone 11mac-address 1111.2222.4444button 1o1,2,3
!! The next ephone configuration includes the third instance of shared line 1001.ephone 12mac-address 1111.2222.555button 1o1,2,3
!
CR-15Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencebutton
Related Commands Command Description
ephone Enters ephone configuration mode to register Cisco IP phones.
ephone-dn Enters ephone-dn configuration mode to set ephone-dns and parameters for individual Cisco IP phone lines.
restart Performs fast reboot of IP phone in a Cisco ITS system.
show ephone Displays Cisco IP phone output.
CR-16Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceclid strip
clid stripTo remove the calling party number from the calling line ID (CLID) information and to prevent the calling party number from being presented to the called party, use the clid strip command in dial-peer configuration mode. To remove the restriction, use the no form of this command.
clid strip [name]
no clid strip [name]
Syntax Description
Defaults No default behavior or values
Command Modes Dial-peer configuration
Command History
Usage Guidelines If the clid strip command is issued, the calling party number is null in the information element, and the presentation indicator is set to “n” to prevent its presentation to the called party.
If you want to remove both the number and the name, you must issue the command twice, once with the name keyword, as in the following example:
Router(config-dial-peer)# clid stripRouter(config-dial-peer)# clid strip name
Examples The following example removes the calling party number from the CLID information and prevents the calling party number from being presented:
Router(config-dial-peer)# clid strip
Related Commands
name Removes the calling party name for both incoming and outgoing calls.
Release Modification
12.2(11)T This command was introduced.
12.2(15)ZJ1 The name keyword was added.
Command Description
clid network-number Configures a network number in the router for CLID and uses it as the calling party number.
clid restrict Prevents the calling party number from being presented by CLID.
clid second-number strip Prevents the second network number from being sent in the CLID information.
CR-17Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencedirectory entry
directory entryTo add an entry to a local phone directory that can be displayed on IP phones, use the directory entry command in telephony-service configuration mode. To remove a telephone directory listing, use the no form of this command.
directory entry {directory-tag number name name | clear}
no directory entry {directory-tag number name name | clear}
Syntax Description
Defaults There is no default.
Command Modes Telephony-service configuration
Command History
Usage Guidelines The Cisco ITS system automatically creates a local phone directory according to telephone numbers and names that are entered during ephone-dn configuration. Additional directory entries can be made by administrators using the directory entry command. Phone number directory listings are displayed in the order in which they are entered.
Examples The following creates a directory of five telephone listings:
Router(config)# telephony-serviceRouter(config-telephony-service)# directory entry 1 4045550110 name AtlantaRouter(config-telephony-service)# directory entry 2 3125550120 name ChicagoRouter(config-telephony-service)# directory entry 3 2135550130 name Los AngelesRouter(config-telephony-service)# directory entry 4 2125550140 name New York CityRouter(config-telephony-service)# directory entry 5 2065550150 name Seattle
Related Commands
directory-tag Digit string that provides a unique identifier for this particular directory entry. Range is from 1 to 100.
number Telephone number or extension for directory entry, up to 32 characters.
name name Name that appears in the directory associated with the number. String of up to 24 characters.
clear Clears all directory entries.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-18Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceephone-dn
ephone-dnTo enter ephone-dn configuration mode to create an ephone-dn for a Cisco IP phone line, an intercom line, a paging line, a voice-mail port, or a message-waiting indicator (MWI), use the ephone-dn command in global configuration mode. To delete an ephone-dn, use the no form of this command.
ephone-dn dn-tag [dual-line]
no ephone-dn dn-tag [dual-line]
Syntax Description
Defaults No ephone-dn is configured.
Command Modes Global configuration
Command History
Usage Guidelines This is a top-level command used to configure Cisco IP phones on the Cisco IOS Telephony Services (ITS) router. By default, no ephone-dn is configured.
Before using this command, you must set the maximum number of ephone-dns to appear in your network by using the max-dn command. The maximum number of ephone-dns that you can create depends on the router platform and version of ITS that you are using. Refer to the ITS specifications in the appropriate version-specific Cisco ITS documentation.
Ephone-dns are created in single-line mode if the dual-line keyword is not used. Changing an ephone-dn from dual-line mode to single-line mode (and vice versa) requires that you delete the ephone-dn and then recreate it.
Each dual-line ephone-dn has one virtual voice port and two channels to handle two independent calls. This capacity allows call waiting, call transfer, and conference functions within a single ephone-dn. Dual-line mode is supported on all phone types, but is not appropriate for voice-mail numbers, intercoms, or ephone-dns used for message-waiting indicators, paging, or hunt groups. Overlays of single-line hunt groups onto dual-line buttons are supported.
dn-tag Unique sequence number that identifies this ephone-dn during configuration tasks. Range is from 1 to 288.
dual-line (Optional) Enables dual-line mode for this ephone-dn.
Release Modification
12.1(5)YD This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(15)ZJ The dual-line keyword was added.
CR-19Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceephone-dn
Examples The following example enters ephone-dn configuration mode to create the ephone-dn 5576:
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 5576Router(config-ephone-dn)# exit
The following example creates an ephone-dn with the number 1001 in dual-line mode. The no huntstop command allows calls to continue to hunt to other ephone-dns if this one is busy or does not answer. The huntstop channel command disables call hunting to the second channel of this ephone-dn if the first channel is busy or does not answer.
Router(config)# ephone-dn 10 dual-lineRouter(config-ephone-dn)# number 1001Router(config-ephone-dn)# no huntstopRouter(config-ephone-dn)# huntstop channelRouter(config-ephone-dn)# exit
Related Commands Command Description
max-dn Sets the maximum number of ephone-dns that can be supported by a router.
max-ephones Configures the maximum number of Cisco IP phones that can be supported by a router.
CR-20Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceephone-hunt
ephone-huntTo create a hunt group for use in Cisco IOS Telephony Services (ITS) systems and to enter ephone-hunt configuration mode, use the ephone-hunt command in global configuration mode. To delete a hunt group, use the no form of this command.
ephone-hunt hunt-tag {sequential | peer}
no ephone-hunt hunt-tag
Syntax Description
Defaults No hunt group is defined.
Command Modes Global configuration
Command History
Usage Guidelines A hunt group is a list of phone numbers that are assigned to receive the incoming calls. The incoming calls are dialed to a single pilot number that is defined with the pilot command. The list of numbers is defined using the list command. If a number is busy or does not answer, the call is redirected to the next number in the list. The last number tried is the final number, which is defined using the final command.
The order in which the numbers are chosen can be sequential or peer. If the order is sequential, the first number to which calls are directed is the first number in the list. If that number is busy or does not answer, the call is redirected to the next available number in the list, from left to right. If the order is peer, the first number to which calls are directed is selected at random. If that number is busy or does not answer, the call is directed to the next number in the list and, in the process, circles back to the beginning of the list. In peer hunt groups, the hops command specifies how many times a call can hop from number to number before going to the final number, after which the call is no longer forwarded.
If the number of times that a call is redirected to a new number exceeds 5, the max-redirect command must be used to increase the allowable number of redirects in the Cisco ITS system.
If you configure a new hunt group, you must specify the peer or sequential keyword. Hunting will then proceed in a circular movement, left to right, through the list. If you want to change an existing ephone-hunt group configuration, the keyword is not required. If you want to change the type of hunt group from peer to sequential or sequential to peer, you must remove the existing hunt group first using the no form of the command.
hunt-tag Identifier for the hunt group being created.
sequential (Optional) Hunt group in which phones ring in the order in which they are listed, left to right, when the hunt group is defined.
peer (Optional) Hunt group in which the first phone is picked randomly from the list that is created when the hunt group is defined.
Release Modification
12.2(15)ZJ This command was introduced.
CR-21Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceephone-hunt
Examples The following example defines sequential hunt group number 1. When callers dial extension 5601, the first phone to ring is 5001, then 5002, 5017, and 5028. If none of those extensions answers, the call is forwarded to extension 6000, which is the number for the voice-mail service.
Router(config)# ephone-hunt 1 sequentialRouter(config-ephone-hunt)# pilot 5601Router(config-ephone-hunt)# list 5001, 5002, 5017, 5028 Router(config-ephone-hunt)# final 6000Router(config-ephone-hunt)# preference 1 Router(config-ephone-hunt)# timeout 30 Router(config-ephone-hunt)# exit
The following example defines peer hunt group number 2. Callers dial extension 5610 to reach the hunt group. The first phone to ring may be any one of the four specified in the list command. If the first phone does not answer, the hunt proceeds from left to right, beginning with the extension directly to the right of the first number, for four hops. If none of those extensions answers before the hops limit is reached, the call is forwarded to extension 6000, which is the number for the voice-mail service.
Router(config)# ephone-hunt 2 peerRouter(config-ephone-hunt)# pilot 5610Router(config-ephone-hunt)# list 5601, 5602, 5617, 5633 Router(config-ephone-hunt)# final 6000Router(config-ephone-hunt)# hops 4Router(config-ephone-hunt)# preference 1 Router(config-ephone-hunt)# timeout 30 Router(config-ephone-hunt)# exit
Related Commands Command Description
final Defines the last ephone-dn in an ITS hunt group.
hops Defines the number of times that a call is redirected to the next ephone-dn in an ITS peer hunt-group list before proceeding to the final ephone-dn.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
pilot Defines the ephone-dn that is dialed to reach an ITS hunt group.
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
CR-22Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencefastdial
fastdialTo create an entry for a personal speed-dial number, use the fastdial command in ephone configuration mode. To delete a personal speed-dial number, use the no form of this command.
fastdial dial-tag number name name-string
no fastdial dial-tag
Syntax Description
Defaults No personal speed-dial numbers are present.
Command Modes Ephone configuration
Command History
Usage Guidelines The fastdial command is supported only on the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
Phone users access personal speed-dial numbers through the Directories > Local Services > Personal Speed Dial menu. Personal speed-dial numbers appear on this menu in the order in which they are entered during configuration.
Examples The following creates a directory of five personal speed-dial numbers for an IP phone:
Router(config)# ephone 1Router(config-ephone)# fastdial 1 5001 name “Front Register”Router(config-ephone)# fastdial 2 5002 name SecurityRouter(config-ephone)# fastdial 3 5003 name “Rear Register”Router(config-ephone)# fastdial 4 5004 name OfficeRouter(config-ephone)# fastdial 5 912135550122 Accounting
Related Commands
dial-tag Unique identifier that is used during configuration for this personal speed-dial number. Range is from 1 to 24.
number Telephone number or extension to be dialed.
name name-string Label to appear in the Personal Speed Dial menu containing a string of up to 24 alphanumeric characters.
Release Modification
12.2(15)ZJ This command was introduced for the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
Command Description
ephone Enters ephone configuration mode to configure Cisco IP phones.
CR-23Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencefeed
feedTo enable an audio stream for multicast from a external live audio feed connected directly to the router by an FXO or an E&M analog voice port, use the feed command in ephone-dn configuration mode. To disable the multicast audio stream, use the no form of this command.
feed ip ip-address port port-number [route ip-address-list] [out-call outcall-number]
no feed ip
Syntax Description
Defaults No default behavior or values
Command Modes Ephone-dn configuration
Command History
Usage Guidelines When this command is used, a connection for a live feed audio stream is established as an automatically connected voice call. If the out-call keyword is used, the ITS system calls out to the specified number for the audio stream. If the out-call keyword is not used, it is assumed that the call is incoming to the ephone-dn. This includes VoIP calls if voice activity detection (VAD) is disabled. The typical operation is for the ITS ephone-dn to establish a call to a local router E&M voice port.
Connection via E&M is the recommended mechanism because it requires minimal external components. The E&M port must be placed in 4-wire operation, using E&M immediate signaling and with the auto-cut-through option enabled. You directly connect a line-level audio feed (standard audio jack) to pins 3 and 6 of an E&M RJ-45 connector. The E&M WAN interface card (WIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. (The audio connection on the E&M port does not require loop current.) The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by the digital signal processor (DSP) on the E&M port.
ip ip-address (Optional) Indicates that this audio stream is to be used as a multicast source and specifies the destination IP address for multicast.
port port-number (Optional) Specifies the media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because this port is already used for normal RTP media transmissions between IP phones and the ITS router.
route ip-address-list (Optional) Indicates specific router interfaces on which to transmit the IP multicast packets. Up to four IP addresses can be listed. The default is that the audio stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command.
out-call outcall-number (Optional) Sets up a call to the outcall-number in order to connect to a live audio feed. If this keyword is not used, the live feed is assumed to derive from an incoming call to the ephone-dn that is being configured.
Release Modification
12.2(15)ZJ This command was introduced.
CR-24Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencefeed
If you are using an FXO voice port for live-feed audio stream instead of an E&M port, connect the source to the FXO voice port. This connection requires an external adapter to supply normal telephone company (telco) battery voltage with the correct polarity to the tip and ring leads of the FXO port. The adapter must also provide transformer-based isolation between the external audio source and the tip-and-ring leads of the FXO port.
If the out-call keyword is used, an outbound call to the live-feed source is attempted (or reattempted) every 30 seconds until the call is connected to the ephone-dn (extension) for which the feed command was configured. Note that this ephone-dn is not associated with a physical phone.
The related moh (ephone-dn) and multicast moh commands provide the ability to multicast an audio stream that is also being used as the source for Cisco IOS Telephony Services (ITS) system music on hold (MOH).
Note IP phones do not support multicast at 224.x.x.x addresses.
Examples The following example sets up a call to extension 7777 for a live audio stream and sends it via multicast:
Router(config)# ephone-dn 55Router(config-ephone-dn)# feed ip 239.1.1.1 port 2000 route 10.10.23.3 out-call 7777
Related Commands Command Description
auto-cut-through Enables call completion when an M-lead response is not provided.
ephone-dn Enters ephone-dn configuration mode to set directory numbers and parameters for individual Cisco IP phone lines.
moh (ephone-dn) Enables music on hold from a live feed and multicast of the MOH audio stream.
moh (telephony-service)
Enables music on hold from an audio file.
multicast moh Enables multicast of a music-on-hold audio stream.
signal Specifies the type of signaling for a voice port
CR-25Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencefinal
finalTo define the last ephone-dn in a Cisco IOS Telephony Services (ITS) hunt group, use the final command in ephone-hunt configuration mode. To remove this number from the hunt group, use the no form of this command.
final dn-number
no final dn-number
Syntax Description
Defaults No final number is defined.
Command Modes Ephone-hunt configuration
Command History
Usage Guidelines Once a final number in one hunt group is configured as a pilot number of another hunt group, the pilot number of the first hunt group cannot be configured as a final number in any hunt group.
Examples The following example defines ephone-dn 6000 as the last number of hunt group number 1:
Router(config)# ephone-hunt 1 sequentialRouter(config-ephone-hunt)# final 6000
Related Commands
dn-number Ephone-dn number. Can be an ephone-dn primary or secondary number, voice-mail number, pilot number of another hunt group, or FXS caller ID number.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
hops Defines the number of times that a call is redirected to the next ephone-dn in a ITS peer-hunt group list before proceeding to the final ephone-dn.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
pilot Defines the ephone-dn that is dialed to reach an ITS hunt group.
CR-26Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencefinal
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
Command Description
CR-27Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencefxo hook-flash
fxo hook-flashTo enable display of a Flash soft key on Cisco IP Phone 7940 and Cisco IP Phone 7960 in a Cisco IOS Telephony Services (ITS) system, use the fxo hook-flash command in telephony-service configuration mode. To disable the Flash soft key, use the no form of this command.
fxo hook-flash
no fxo hook-flash
Syntax Description This command has no arguments or keywords.
Defaults FXO hookflash functionality is disabled.
Command Modes Telephony-service configuration
Command History
Usage Guidelines Certain PSTN services, such as three-way calling and call waiting, require hookflash intervention from the phone user. A new soft key, labeled Flash, has been introduced to provide this functionality for Cisco IP Phone 7940 and Cisco IP Phone 7960 users on Foreign Exchange Office (FXO) lines attached to the ITS system. The Flash soft key is enabled using the fxo hook-flash command.
Once a Flash soft key has been enabled on an IP phone, it is available to provide hookflash functionality during all calls except local IP-phone-to-IP-phone calls. Note that hookflash-controlled services can be activated only if they are supported by the PSTN connection that is involved in the call. The availability of the Flash soft key does not guarantee that hookflash-based services are actually accessible to the phone user.
The Flash soft key display is automatically disabled for local IP-phone-to-IP-phone calls.
This command must be followed by a quick reboot of the phones using the restart all command.
Examples The following enables the Flash soft key on Cisco IP Phone 7940 and Cisco IP Phone 7960 phones in an ITS system:
Router(config)# telephony-serviceRouter(config-telephony-service)# fxo hook-flash
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
restart Performs fast reboot of IP phone in a Cisco ITS system.
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-28Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencehops
hopsTo define the number of times that a call can hop to the next ephone-dn in a Cisco IOS Telephony Services (ITS) peer hunt group before the call proceeds to the final ephone-dn, use the hops command in ephone-hunt configuration mode. To return to the default number of hops, use the no form of this command.
hops number
no hops number
Syntax Description
Defaults Number of hops is 2.
Command Modes Ephone-hunt configuration
Command History
Usage Guidelines This command is valid for Cisco ITS peer hunt groups only.
Examples The following example sets the number of hops for peer hunt group 3 to 6:
Router(config)# ephone-hunt 3 peerRouter(config-ephone-hunt)# hops 6
Related Commands
number Number of hops before the call proceeds to the final number. Range is from 2 to 10. Default is 2.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
final Defines the last ephone-dn in an ITS hunt group.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
pilot Defines the ephone-dn that is dialed to reach an ITS hunt group.
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
CR-29Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencehuntstop (ephone-dn)
huntstop (ephone-dn)To set the ephone-dn huntstop attribute or the ephone-dn dual-line channel huntstop attribute, use the huntstop command in ephone-dn configuration mode. To disable huntstop, use the no form of this command.
huntstop [channel]
no huntstop [channel]
Syntax Description
Defaults Ephone-dn huntstop is enabled.Channel huntstop is disabled.
Command Modes Ephone-dn configuration
Command History
Usage Guidelines When you use the huntstop command without the channel keyword, it affects call hunting behavior that relates to ephone-dns (lines or extensions). If the huntstop attribute is set, an incoming call does not roll over (hunt) to another ephone-dn if the called ephone-dn is busy or does not answer. This allows you to prevent hunt-on-busy from redirecting a call to a busy phone into a dial-peer setup with a catch-all default destination. Use the no huntstop command to disable huntstop and allow hunting for ephone-dns.
Channel huntstop works in a similar way, but it affects call hunting behavior for the two channels of a dual-line ephone-dn. If the huntstop channel command is used, incoming calls do not hunt to the second channel of an ephone-dn if the first channel is busy or does not answer. For example, an incoming call might search through these ephone-dns and channels:
ephone-dn 10 (channel 1)ephone-dn 10 (channel 2)
channel (Optional) For dual-line ephone-dns, keeps incoming calls from hunting to the second channel if the first channel is busy or does not answer.
Release Modification
12.1(5)YD This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420.
12.2(2)XT This command was implemented on Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(15)ZJ The channel keyword was introduced.
CR-30Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencehuntstop (ephone-dn)
ephone-dn 11 (channel 1)ephone-dn 11(channel 2)ephone-dn 12(channel 1)ephone-dn 12(channel 2)
When the no huntstop channel command is used (the default), you might have a call ring for 30 seconds on ephone-dn 10 (channel 1) and then after 30 seconds move to ephone-dn 10 (channel 2). This is usually not the behavior that you desire. Also, it is often useful to reserve the second channel of a dual-line ephone-dn for call transfer, call waiting, or conferencing. The huntstop channel command tells the system that if the first channel is in use or does not answer, an incoming call should hunt forward to the next ephone-dn in the hunt sequence instead of to the next channel on the same ephone-dn.
Examples The following example shows how to disable huntstop for the destination dial peer with the extension 5001. The huntstop for the dial peer is set to OFF and prevents calls to extension 5001 from being rerouted to the on-net H.323 dial peer for the 5... destination when 5001 is busy (the three periods are used as wildcards).
ephone-dn 1number 5001no huntstop
The following example shows a typical configuration in which ephone-dn huntstop (default) is required:
ephone-dn 1number 5001
ephone 4button 1:1mac-address 0030.94c3.8724
dial-peer voice 5000 voipdestination-pattern 5...session target ipv4:192.168.17.225
In the previous example, the huntstop attribute is set to ON by default and prevents calls to extension 5001 from being rerouted to the on-net H.323 dial peer for 5... when extension 5001 is busy.
The following example shows another instance in which huntstop is not desired and is explicitly disabled. In this example, ephone 4 is configured with two lines, each with the same extension number 5001. This is done in order to allow the second line to provide call waiting notification for extension number 5001 when the first line is in use. Setting no huntstop on the first line (ephone-dn 1) allows incoming calls to hunt to the second line (ephone-dn 2) on ephone 4 when the ephone-dn 1 line is busy.
Ephone-dn 2 has call forwarding set to extension 6000, which corresponds to a locally attached answering machine connected to a Foreign Exchange Station (FXS) voice port. In this example, the POTS dial peer for extension 6000 also has the dial-peer huntstop attribute explicitly set to prevent further hunting.
ephone-dn 1number 5001no huntstoppreference 1call-forward noan 6000
ephone-dn 2number 5001preference 2call-forward busy 6000call-forward noan 6000
CR-31Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencehuntstop (ephone-dn)
ephone 4button 1:1 2:2mac-address 0030.94c3.8724
dial-peer voice 6000 potsdestination-pattern 6000huntstopport 1/0/0description answering-machine
The following is an example of a dual-line ephone-dn configuration in which calls do not hunt to the second channel of any ephone-dn, but they do hunt through channel 1 for each ephone-dn in the order 10, 11, 12.
ephone-dn 10 dual-linenumber 1001no huntstophuntstop channel
ephone-dn 11 dual-linenumber 1001no huntstophuntstop channelpreference 1
ephone-dn 12 dual-linenumber 1001
no huntstophuntstop channel
preference 2
Related Commands Command Description
ephone-dn Enters ephone-dn configuration mode.
huntstop (dial-peer) Disables all further dial-peer hunting if a call fails using hunt groups.
CR-32Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencelabel
label To create a text identifier instead of a phone number display on IP phone consoles, use the label command in ephone-dn configuration mode. To delete a label, use the no form of this command.
label label-string
no label label-string
Syntax Description
Defaults No labels are defined.
Command Modes Ephone-dn configuration
Command History
Usage Guidelines One label is allowed per ephone-dn. A phone number must be configured with the number command for an ephone-dn before a label can be created for it.
This command must be followed by a quick reboot of the phone on which the label appears, using the restart command.
Examples The following creates three phone labels to appear in place of three phone numbers on IP phone console displays:
Router(config)# ephone-dn 10Router(config-ephone-dn)# label user10Router(config-ephone-dn)# exit
Router(config)# ephone-dn 20Router(config-ephone-dn)# label user20Router(config-ephone-dn)# exit
Router(config)# ephone-dn 30Router(config-ephone-dn)# label user30Router(config-ephone-dn)# exit
Related Commands
label-string Alphanumeric string of up to 30 characters.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-dn Enters ephone-dn configuration mode.
number Configures a valid number for the Cisco IP phone.
restart Performs fast reboot of IP phone in a Cisco ITS system.
CR-33Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencelist
listTo create a list of numbers that are members of a Cisco IOS Telephony Services (ITS) hunt group, use the list command in ephone-hunt configuration mode. To remove a list from the router configuration, use the no form of this command.
list dn-number, dn-number[, dn-number...]
no list
Syntax Description
Defaults No list is defined.
Command Modes Ephone-hunt configuration
Command History
Usage Guidelines The numbers in a hunt group must all be added or deleted from the hunt group list at one time. You cannot add a single number to an existing list or remove one number from a list.
Examples The following example creates sequential hunt group number 7, which contains four ephone-dns:
Router(config)# ephone-hunt 7 sequentialRouter(config-ephone-hunt)# list 7711, 7712, 7713, 7714
Related Commands
dn-number Ephone-dn number. There must be two to ten numbers in the hunt group list, and each number must be an ephone-dn primary or secondary number.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
final Defines the last ephone-dn in an ITS hunt group.
hops Defines the number of times that a call is redirected to the next ephone-dn in a ITS peer hunt-group list before proceeding to the final ephone-dn.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
pilot Defines the ephone-dn that is dialed to reach an ITS hunt group.
CR-34Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencelist
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
Command Description
CR-35Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceload (telephony-service)
load (telephony-service)To associate a type of Cisco IP phone with a phone firmware file, use the load command in telephony-service configuration mode. To disassociate a type of phone from a phone firmware file, use the no form of this command.
load phone-type firmware-file
no load phone-type firmware-file
Syntax Description
Defaults No default behavior or values
Command Modes Telephony-service configuration
Command History
phone-type Type of IP phone. The following choices are valid:
• 7902—Cisco IP Phone 7902G
• 7905—Cisco IP Phone 7905G
• 7910—Cisco IP Phone 7910
• 7912—Cisco IP Phone 7912G
• 7914—Cisco IP Phone Expansion Module 7914
• 7935—Cisco IP Conference Station 7935
• 7960-7940—Cisco IP Phone 7960G and Cisco IP Phone 7940G
• ATA—Cisco ATA-186 and Cisco ATA-188
firmware-file Filename for the IP phone firmware to be associated with the IP phone type. For every phone type except ATA, do not use a file extension. Filenames are case-sensitive.
Release Modification
12.1(5)YD This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(11)YT Support was added for the Cisco IP Phone Expansion Module 7914.
12.2(15)T This command was integrated into Cisco IOS Release 12.2(15)T.
12.2(15)ZJ Support was added for the Cisco IP Phone 7902G, the Cisco IP Phone 7905G, and the Cisco IP Phone 7912G.
CR-36Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceload (telephony-service)
Usage Guidelines This command updates the Cisco IOS Telephony Services (ITS) configuration file for the specified type of IP phone to add the name of the correct firmware file that the phone should load. This filename also provides the version number for the phone firmware that is in the file. Later, whenever a phone is started up or rebooted, the phone reads the configuration file to determine the name of the firmware file that it should load and then looks for that firmware file on the TFTP server.
Cisco IP phones update themselves with new phone firmware whenever they are initially started up or rebooted.
A separate load command is needed for each type of phone. The Cisco IP Phone 7960 and Cisco IP Phone 7940 have the same phone firmware and share the 7960-7940 keyword.
When specifying the phone firmware filename in this command for every phone type except ATA, do not use a file extension. For example, if the firmware file for Cisco IP Phone Expansion Module 7914s is named W05473955.bin, you enter load 7914 W05473955.
Following the load command, you use the tftp-server command to enable TFTP access to the file by Cisco IP phones. Note that the tftp-server command does require that you use the file extension as part of the filename.
The load command must be followed by a reboot of the phones using the reset command.
Examples The following example identifies the Cisco IP phone firmware file that is used by Cisco IP Phone 7960 and Cisco IP Phone 7910, and then defines the ITS router Flash memory as the location of the phone firmware file:
Router(config)# telephony-serviceRouter(config-telephony-service)# load 7960-7940 P00303020209Router(config-telephony-service)# load 7910 P00403020209Router(config-telephony-service)# exitRouter(config)# tftp-server flash:P00303020209.binRouter(config)# tftp-server flash:P00403020209.bin
Related Commands Command Description
reset Resets a Cisco IP phone.
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
tftp-server Enables TFTP access to firmware files on the TFTP server.
CR-37Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencelogin (telephony-service)
login (telephony-service)To define when IP phones in a Cisco IOS Telephony Services (ITS) system are logged out automatically, use the login command in telephony-service configuration mode. To revert to the default minutes and time, use the no form of this command.
login [timeout [minutes]] [clear time]
no login
Syntax Description
Defaults The default for minutes is 60.The default for time is 24:00 (midnight).
Command Modes Telephony-service configuration
Command History
Usage Guidelines The login command is used in conjunction with the pin command to define the capability for individual phone users to override call blocking. Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in an ITS system are restricted if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt command.
The login command applies only to IP phones that have soft keys, such as the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
This command must be followed by a quick reboot of the phones using the restart all command.
A router reboot resets the login status for all phones to the default.
timeout (Optional) Deactivates logins a given number of minutes after a phone becomes idle.
minutes (Optional) The number of minutes for which an IP phone can be idle before it is logged out automatically. The minutes argument is a number from 5 to 1440. Default is 60.
clear time (Optional) Deactivates user login for all IP phones at the specified time of day, using 00:00 to 24:00 on a 24-hour clock. For example, 10:30 p.m. is 22:30. Default is 24:00 (midnight).
Release Modification
12.2(15)ZJ This command was introduced.
CR-38Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencelogin (telephony-service)
Examples The following example sets the login deactivation to occur after a 2-hour idle time and after 11:30 p.m.
Router(config)# telephony-serviceRouter(config-telephony-service)# login timeout 120 clear 2330
Related Commands Command Description
after-hour exempt Specifies that an IP phone does not have any of its outgoing calls blocked even though call blocking has been defined.
after-hours block pattern
Defines a pattern of digits for blocking outgoing calls from IP phones.
after-hours date Defines a recurring period based on month and date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
pin Sets a global/individual PIN for phone users to deactivate call blocking during nonwork hours.
restart Performs fast reboot of IP phone in a Cisco ITS system.
show ephone login Displays the login states of all phones.
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-39Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemax-redirect
max-redirectTo change the number of times that a call can be redirected by call forwarding or transfer within a Cisco IOS Telephony Services (ITS) system, use the max-redirect command in telephony-service configuration mode. To revert to the default number of redirects, use the no form of this command.
max-redirect number
no max-redirect number
Syntax Description
Defaults Number of redirects is 5.
Command Modes Telephony-service configuration
Command History
Usage Guidelines This command supports ITS hunt groups by allowing calls to be redirected more than the default 5 times.
Examples The following example sets the maximum number of redirects to 8:
Router(config)# telephony-serviceRouter(config-telephony-service)# max-redirect 8
Related Commands
number Number of permissible redirects. Range is from 5 to 20. Default is 5.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-40Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemoh (ephone-dn)
moh (ephone-dn)To enable music on hold (MOH) from an external live audio feed (standard line-level audio connection) connected directly to the router by an FXO or an E&M analog voice port, use the moh command in ephone-dn configuration mode. To disable MOH from a live feed or to disable the outcall number or multicast capability, use the no form of this command
moh [out-call outcall-number] [ip ip-address port port-number [route ip-address-list]]
no moh [out-call outcall-number | ip]
Syntax Description
Defaults No default behavior or values
Command Modes Ephone-dn configuration
Command History
Usage Guidelines This command takes the specified live-feed audio stream and uses it as MOH for a Cisco IOS Telephony Services (ITS) system. The connection for the live-feed audio stream is established as an automatically connected voice call. If the out-call keyword is used, the type of connection can include VoIP calls if voice activity detection (VAD) is disabled. The typical operation is for the ITS MOH ephone-dn to establish a call to a local router E&M voice port.
Connection via E&M is the recommended mechanism because it requires minimal external components. The E&M port must be placed in 4-wire operation, using E&M immediate signaling and with the auto-cut-through option enabled. You directly connect a line-level audio feed (standard audio jack) to
out-call outcall-number (Optional) Sets up a call to the outcall-number in order to connect to the MOH feed. If this keyword is not used, the live feed is assumed to derive from an incoming call to the ephone-dn under which this command is used.
ip ip-address (Optional) Indicates that this audio stream is to be used as a multicast source as well as the MOH source and specifies the destination IP address for multicast.
port port-number (Optional) Specifies the media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because this port is already used for normal RTP media transmissions between IP phones and the ITS router.
route ip-address-list (Optional) Indicates specific router interfaces on which to transmit the IP multicast packets. Up to four IP addresses can be listed. The default is that the MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command.
Release Modification
12.2(11)YT This command was introduced.
12.2(15)T This command was integrated into Cisco IOS Release 12.2(15)T.
12.2(15)ZJ The ip, port, and route keywords were added.
CR-41Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemoh (ephone-dn)
pins 3 and 6 of an E&M RJ-45 connector. The E&M WAN interface card (WIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. (The audio connection on the E&M port does not require loop current.) The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by the digital signal processor (DSP) on the E&M port.
If you are using an FXO voice port for live-feed MOH instead of an E&M port, connect the MOH source to the FXO voice port. This connection requires an external adapter to supply normal telephone company (telco) battery voltage with the correct polarity to the tip and ring leads of the FXO port. The adapter must also provide transformer-based isolation between the external audio source and the tip-and-ring leads of the FXO port.
Music from a live feed is continuously fed into the MOH playout buffer instead of being read from an audio file in Flash memory. There is typically a two-second delay with live-feed MOH.
If the out-call keyword is used, an outbound call to the MOH live-feed source is attempted (or reattempted) every 30 seconds until the call is connected to the ephone-dn (extension) that has been configured for MOH. Note that this ephone-dn is not associated with any physical phone.
MOH can also be derived from an audio file when you use the moh command in telephony-service configuration mode with the filename argument. There can only be one MOH stream at a time in an ITS system and if both an audio file and a live feed have been specified for the MOH stream, the router seeks the live feed from the moh (ephone-dn) command first. If the live feed is found, it displaces the audio file source. If the live feed is not found or fails at any time, the router falls back to the audio file source that was specified in the moh (telephony-service) command.
If you use the ip keyword to specify a multicast address in this command, the audio stream is sent to the multicast address in addition to serving as the MOH source. Additionally, if you specified a different multicast address using the multicast moh command under telephony-service configuration mode, the audio stream is also sent to the multicast address that you named in that command. It is therefore possible to send the live-feed audio stream to MOH and to two different multicast addresses: the one that is directly configured under the moh (ephone-dn) command and the one that is indirectly configured under the multicast moh (telephony-service) command.
A related command, the feed command, provides the ability to multicast a different audio stream than the MOH audio stream.
Note IP phones do not support multicast at 224.x.x.x addresses.
Examples The following example establishes a live music-on-hold source by setting up a call to extension 7777:
Router(config)# ephone-dn 55Router(config-ephone-dn)# moh out-call 7777
Related Commands Command Description
auto-cut-through Enables call completion when an M-lead response is not provided.
ephone-dn Enters ephone-dn configuration mode to set directory numbers and parameters for individual Cisco IP phone extensions.
feed Enables multicast of an audio stream.
moh (telephony-service)
Enables music on hold from an audio file.
CR-42Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemoh (ephone-dn)
multicast moh Enables multicast of the music-on-hold audio stream.
signal Specifies the type of signaling for a voice port
Command Description
CR-43Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemoh (telephony-service)
moh (telephony-service)To generate an audio stream from a file for music on hold (MOH) in a Cisco IOS Telephony Services (ITS) system, use the moh command in telephony-service configuration mode. To disable the MOH audio stream from this file, use the no form of this command.
moh filename
no moh
Syntax Description
Defaults Tone-on-hold (a periodic beep is played to the caller)
Command Modes Telephony-service configuration
Command History
Usage Guidelines This command enables MOH from .au and .wav format music files. MOH is played for G.711 callers and on-net VoIP and PSTN callers who are on hold in an ITS system. Local callers within the ITS system hear a repeating tone when they are on hold.
Audio files that are used for MOH must be copied to the ITS router Flash memory. A MOH file can be in .wav or.au file format; however, the file format must contain 8-bit 8-KHz data in a-law or mu-law data format.
If you want to change to a different file after an audio file has been configured, you must remove the first file using the no moh command before specifying a second file, as shown in the following example:
Router(config-telephony-service)# moh file1Router(config-telephony-service)# no mohRouter(config-telephony-service)# moh file2
If you configure a second file without removing the first file, the MOH mechanism stops working and may require a router reboot to clear the problem.
A related command, the moh command in ephone-dn configuration mode, can be used to establish a MOH audio stream from a live feed. If you configure both commands, MOH falls back to playing music from the audio file if the live music feed is interrupted.
filename Name of the audio file to use for the MOH audio stream. The file must be copied to Flash memory on the ITS router.
Release Modification
12.2(2)XT This command was introduced on the Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
CR-44Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemoh (telephony-service)
Examples The following example enables music on hold and specifies a music file:
Router(config)# telephony-serviceRouter(config-telephony-service)# moh minuet.wav
Related Commands Command Description
moh (ephone-dn) Enables music on hold from a live audio feed.
multicast moh Enables multicast of the music-on-hold audio stream.
telephony-service Enters telephony-service configuration mode.
CR-45Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemulticast moh
multicast mohTo use the music-on-hold (MOH) audio stream as a multicast source in a Cisco IOS Telephony Services (ITS) system, use the multicast moh command in telephony-service configuration mode. To disable multicast use of the MOH stream, use the no form of this command.
multicast moh ip-address port port-number [route ip-address-list]
no multicast moh
Syntax Description
Defaults No multicast is enabled.
Command Modes Telephony-service configuration
Command History
Usage Guidelines This command enables multicast of the audio stream that is designated for MOH in a Cisco IOS Telephony Services (ITS) system. A related command, the moh (ephone-dn) command, creates a MOH audio stream from an external live feed and optionally enables multicast on that stream. These two commands can be used concurrently to provide multicast of a live-feed MOH audio stream to two different multicast addresses.
Another related command, the feed command, enables multicast of an audio stream that is not the MOH audio stream.
Examples The following example enables multicast of the MOH audio stream at multicast address 239.10.16.4 and names two router interfaces over which to send the multicast packets.
Router(config)# telephony-serviceRouter(config-telephony-service)# moh minuet.auRouter(config-telephony-service)# multicast moh 239.10.16.4 port 2000 route 10.10.29.17 10.10.29.33
ip ip-address (Optional) Indicates that the MOH audio stream is to be used as a multicast source and specifies the destination IP address for multicast.
port port-number (Optional) Specifies the media port for multicast. Range is from 2000 to 65535. Port 2000 is recommended because this port is already used for normal RTP media transmissions between IP phones and the ITS router.
route ip-address-list (Optional) Indicates specific router interfaces over which to transmit the IP multicast packets. Up to four IP addresses can be listed. The default is that the MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command.
Release Modification
12.2(15)ZJ This command was introduced.
CR-46Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemulticast moh
Related Commands Command Description
feed Enables multicast of an audio stream.
moh (ephone-dn) Enables music on hold from a live audio feed.
moh (telephony-service)
Enables music on hold from an audio file.
telephony-service Enters telephony-service configuration mode.
CR-47Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemwi sip-server (telephony-service)
mwi sip-server (telephony-service)To configure the IP address and port number for the external Session Initiation Protocol (SIP)-based message-waiting indication (MWI) server, use the mwi sip-server command in telephony-service configuration mode. To disable the MWI server functionality, use the no form of this command.
mwi sip-server ip-address [transport tcp | transport udp] [port port-number] [reg-e164] [unsolicited]
no mwi sip-server ip-address
Syntax Description
Defaults Transport layer protocol: TCPPort number: 5060 (SIP standard port)Registration: with an extension number
Command Modes Telephony-service configuration
Command History
Usage Guidelines Use this command to configure the IP address of an external SIP MWI server. This IP address is used with the mwi sip (ephone-dn) command to subscribe individual ephone-dn extension numbers to the MWI SIP server’s notification list. A SIP MWI client runs TCP by default.
The transport tcp keyword is the default setting. The transport udp keyword allows you to integrate with a SIP MWI client. The optional port keyword is used to specify a port number. The default SIP port number is 5060. The default registration is with an extension number, so the reg-e164 keyword allows you to register with an E.164 ten-digit number.
ip-address IP address of the MWI server.
transport tcp (Optional) Selects TCP as the transport layer protocol. The default is TCP.
transport udp (Optional) Selects UDP as the transport layer protocol.
port port number (Optional) Specifies port number for the MWI server. The default is 5060.
reg-e164 (Optional) Registers an E.164 number with a SIP proxy or registrar.
unsolicited (Optional) Sends SIP NOTIFY for MWI without any need to send a SUBSCRIBE from ITS.
Release Modification
12.2(2)XT This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(15)ZJ The unsolicited keyword was added.
CR-48Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencemwi sip-server (telephony-service)
Examples The following example sets MWI for the SIP server and sets individual ephone-dn extension numbers to the MWI SIP server’s notification list:
Router(config) ephone-dn 1Router(config-ephone-dn) number 5001Router(config-ephone-dn) name John SmithRouter(config-ephone-dn) mwi sipRouter(config-ephone-dn) exitRouter(config) telephony-serviceRouter(config-telephony-service) mwi sip-server 192.168.0.5 transport udp
Related Commands Command Description
mwi (ephone-dn) Configures specific Cisco IP phone directory numbers to receive MWI notification from an external voice-mail system.
mwi expires Sets the expiration timer for registration for either the client or server.
mwi sip (ephone-dn) Subscribes an extension in a Cisco IOS Telephony Services router to receive MWI notification from a SIP MWI server.
show mwi relay clients Displays the registration information for MWI relay clients.
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-49Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service bell (ephone)
night-service bell (ephone)To mark an IP phone to receive night-service bell notification when incoming calls are received on ephone-dns that are marked for night service during night-service time periods, use the night-service bell command in ephone configuration mode. To remove night-service notification from a phone, use the no form of this command.
night-service bell
no night-service bell
Syntax Description This command has no arguments or keywords.
Defaults A phone is not marked for night-service bell notification.
Command Modes Ephone configuration
Command History
Usage Guidelines When an ephone-dn is marked for night-service treatment using the night-service bell (ephone-dn) command, incoming calls that ring during the night-service time period on that ephone-dn send an alert indication to all IP phones that are marked to receive night-service bell notification with this command. The alert notification is in the form of a splash ring (not associated with any of the individual lines on the IP phone) and a visible display of the ephone-dn extension number. The phone user picks up the call by pressing a PickUp or GPickUp soft key of the indicated extension.
Night-service periods are defined using the night-service date and night-service day commands. Night service can be manually disabled or reenabled from a phone with ephone-dns in night service mode if the night-service code command has been set.
Examples The following example designates the IP phone that is being configured as a phone that will receive night-service bell notification when ephone-dns marked for night service receive incoming calls during a night-service period:
Router(config)# ephone 4Router(config-ephone)# night-service bell
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone Enters ephone configuration mode.
night-service bell (ephone-dn)
Marks an ephone-dn to send night-service bell notification to designated IP phones during night-service time periods.
CR-50Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service bell (ephone)
night-service code Defines a code to disable or reenable night service on IP phones.
night-service date Defines a recurring time period associated with a month and date during which night service is active.
night-service day Defines a recurring time period associated with a day of the week during which night service is active.
Command Description
CR-51Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service bell (ephone-dn)
night-service bell (ephone-dn)To mark an ephone-dn for night-service treatment, use the night-service bell command in ephone-dn configuration mode. To remove the night-service treatment from the ephone-dn, use the no form of this command.
night-service bell
no night-service bell
Syntax Description This command has no arguments or keywords.
Defaults An ephone-dn is not marked for night service.
Command Modes Ephone-dn configuration
Command History
Usage Guidelines When an ephone-dn is marked for night-service treatment using this command, incoming calls that ring during the night-service time period on that ephone-dn send an alert indication to all IP phones that are marked to receive night-service bell notification using the night-service bell (ephone) command. The alert notification is in the form of a splash ring (not associated with any of the individual lines on the IP phone) and a visible display of the ephone-dn extension number. The phone user picks up the call by pressing a PickUp or GPickUp soft key of the indicated extension.
Night-service periods are defined using the night-service date and night-service day commands. Night service can be manually disabled or reenabled from a phone with ephone-dns in night-service mode if the night-service code command has been set.
Examples The following example marks this ephone-dn as a line that will ring on IP phones designated to receive night-service bell notification when incoming calls are received on this ephone-dn during night-service periods:
Router(config)# ephone-dn 16Router(config-ephone-dn)# night-service bell
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-dn Enters ephone-dn configuration mode.
night-service bell (ephone)
Marks an IP phone to receive night-service bell notification when incoming calls are received on ephone-dns that are marked for night service during night-service time periods.
CR-52Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service bell (ephone-dn)
night-service code Defines a code to disable or reenable night service on IP phones.
night-service date Defines a recurring time period associated with a month and date during which night service is active.
night-service day Defines a recurring time period associated with a day of the week during which night service is active.
Command Description
CR-53Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service code
night-service codeTo define a code to disable or reenable night service on IP phones, use the night-service code command in telephony-service configuration mode. To remove the code, use the no form of this command.
night-service code digit-string
no night-service code digit-string
Syntax Description
Defaults No code is defined.
Command Modes Telephony-service configuration
Command History
Usage Guidelines When an ephone-dn is marked for night-service treatment using the night-service bell (ephone-dn) command, incoming calls that ring during the night-service time period on that ephone-dn send an alert indication to all IP phones that are marked to receive night-service bell notification using the night-service bell (ephone) command. The alert notification is in the form of a splash ring (not associated with any of the individual lines on the IP phone) and a visible display of the ephone-dn extension number. The phone user picks up the call by pressing a PickUp or GPickUp soft key of the indicated extension.
Night-service periods are defined with the night-service date and night-service day commands. Night service can be manually disabled or reenabled from a phone with ephone-dns in night-service mode if the night-service code command has been set.
Examples The following example defines a night-service code of *2985:
Router(config)# telephony-serviceRouter(config-telephony-service)# night-service code *2985
digit-string Digit code that a user enters at an IP phone to disable or reenable night service on all ephone-dns that are marked for night service on that phone. The code must begin with an asterisk (*). The maximum number of characters is 16, including the asterisk.
Release Modification
12.2(15)ZJ This command was introduced.
CR-54Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service code
Related Commands Command Description
night-service bell (ephone)
Marks an IP phone to receive night-service bell notification when incoming calls are received on ephone-dns that are marked for night service during night-service time periods.
night-service bell (ephone-dn)
Marks an ephone-dn to send night-service bell notification to designated IP phones during night-service time periods.
night-service date Defines a recurring time period associated with a month and date during which night service is active.
night-service day Defines a recurring time period associated with a day of the week during which night service is active.
telephony-service Enters telephony-service configuration mode.
CR-55Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service date
night-service dateTo define a recurring time period associated with a month and date during which night service is active, use the night-service date command in telephony-service configuration mode. To delete the defined time period, use the no form of this command.
night-service date month date start-time stop-time
no night-service date month date start-time stop-time
Syntax Description
Defaults No time period based on month and date is defined for night service.
Command Modes Telephony-service configuration
Command History
Usage Guidelines After you define night-service periods using this command and the night-service day command, use the night-service bell (ephone-dn) and night-service bell (ephone) commands to specify the lines that will ring on other phones and the phones on which they will ring during night-service periods.
Examples The following example defines a night-service time period for the entire day of January 1:
Router(config)# telephony-serviceRouter(config-telephony-service)# night-service date jan 1 00:00 00:00
Related Commands
month Abbreviated month. The following abbreviations for month are valid: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.
date Date of the month. Range is from 1 to 31.
start-time stop-time
Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time must be greater than the start time. The value 24:00 is not valid. If 00:00 is entered as an stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified date.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
night-service bell (ephone)
Marks an IP phone to receive night-service bell notification when incoming calls are received on ephone-dns that are marked for night service during night-service time periods.
night-service bell (ephone-dn)
Marks an ephone-dn for which to send night-service bell notification to designated IP phones during night-service time periods.
CR-56Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service date
night-service code Defines a code to disable or reenable night service on IP phones.
night-service day Defines a recurring time period associated with a day of the week during which night service is active.
telephony-service Enters telephony-service configuration mode.
Command Description
CR-57Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service day
night-service dayTo define a recurring time period associated with a day of the week during which night service is active, use the night-service day command in telephony-service configuration mode. To delete the time period, use the no form of this command.
night-service day day start-time stop-time
no night-service day day start-time stop-time
Syntax Description
Defaults No time period based on day of the week is defined for night service.
Command Modes Telephony-service configuration
Command History
Usage Guidelines After you define night-service periods using this command and the night-service date command, use the night-service bell (ephone-dn) and night-service bell (ephone) commands to specify the lines that will ring on other phones and the phones on which they will ring during night-service periods.
Examples The following example defines a night-service time period from Monday at 7 p.m. to Tuesday at 7 a.m.:
Router(config)# telephony-serviceRouter(config-telephony-service)# night-service day mon 19:00 07:00
day Day of the week abbreviation. The following are valid day abbreviations: sun, mon, tue, wed, thu, fri, sat.
start-time stop-time
Beginning and ending times for night service, in an HH:MM format using a 24-hour clock. If the stop time is a smaller value than the start time, the stop time occurs on the day following the start time. For example, “mon 19:00 07:00” means “from Monday at 7 p.m. until Tuesday at 7 a.m.”
The value 24:00 is not valid. If 00:00 is entered as an stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified day.
Release Modification
12.2(15)ZJ This command was introduced.
CR-58Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenight-service day
Related Commands Command Description
night-service bell (ephone)
Marks an IP phone to receive night-service bell notification when incoming calls are received on ephone-dns that are marked for night service during night-service time periods.
night-service bell (ephone-dn)
Marks an ephone-dn for which to send night-service bell notification to designated IP phones during night-service time periods.
night-service code Defines a code to disable or reenable night service on IP phones.
night-service date Defines a recurring time period associated with a month and date during which night service is active.
telephony-service Enters telephony-service configuration mode.
CR-59Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceno-reg (ephone-hunt)
no-reg (ephone-hunt)To specify that the pilot number for a Cisco IOS Telephony Services (ITS) peer hunt group should not register with an H.323 gatekeeper, use the no-reg command in ephone-hunt configuration mode. To return to the default, use the no form of this command.
no-reg
no no-reg
Syntax Description This command has no arguments or keywords.
Defaults The pilot number registers with the H.323 gatekeeper.
Command Modes Ephone-hunt configuration
Command History
Usage Guidelines This command is valid only for ITS peer hunt groups.
Examples The following example specifies that the pilot number of peer hunt group 2 should not register with the H.323 gatekeeper:
Router(config)# ephone-hunt 2 peerRouter(config-ephone-hunt)# no-reg
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
final Defines the last ephone-dn in an ITS hunt group.
hops Defines the number of times that a call is redirected to the next ephone-dn in a ITS peer hunt-group list before proceeding to the final ephone-dn.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
pilot Defines the ephone-dn that is dialed to reach an ITS hunt group.
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
CR-60Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenumber (ephone-dn)
number (ephone-dn)To configure a telephone or extension number for an ephone-dn in a Cisco IOS Telephony Services (ITS) system, use the number command in ephone-dn configuration mode. To disable a number for the Cisco IP phone, use the no form of this command.
number number [secondary number] [no-reg [both | primary]]
no number number [secondary number] [no-reg [both | primary]]
Syntax Description
Defaults No secondary phone number is associated with the ephone-dn.
Command Modes Ephone-dn configuration
Command History
Usage Guidelines This command defines a valid number for an ephone-dn (extension) that is to be assigned to an IP phone. The secondary keyword allows you to associate a second telephone number with an ephone-dn so that it can be called by dialing either the main or secondary phone number. The secondary number may contain wildcards; for example, 50.. (the number 50 followed by wildcards). The no-reg keyword causes an E.164 number in the dial peer not to register with the gatekeeper. If you do not specify both or primary after the no-reg keyword, only the secondary number is not registered.
number String of up to 16 characters that represents an E.164 telephone number. Normally the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. The string may also contain wildcards.
secondary (Optional) A second telephone number with an ephone-dn.
no-reg (Optional) The E.164 numbers in the dial peer do not register with the gatekeeper. If you do not specify an option (both or primary) after the no-reg keyword, only the secondary number is not registered.
both (Optional) Both numbers are not registered.
primary (Optional) Primary number is not registered.
Release Modification
12.1(5)YD This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(15)ZJ The ability to use alphabetic characters as part of the number string was supported.
CR-61Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencenumber (ephone-dn)
A number normally contains only numeric characters so that it can be dialed from telephone keypads. In certain cases, however, the number is only dialed internally by the ITS router and should never be accessible from telephone keypads. For example, an intercom call is dialed by the ITS router when a phone user presses an intercom button on a phone. The phone user never dials the intercom number directly, so a number containing alphabetic characters can be assigned for intercom use. Intercom calls are automatically answered in speakerphone mode by the receiving phone. The advantage of using alphabetic characters in this case is to prevent unauthorized individuals from dialing an intercom number and being automatically connected to a phone.
This command must be followed by a quick reboot of the phone to which this number is assigned, using the restart command.
Examples The following example sets 5001 as the primary extension number for a Cisco IP phone and 0 as the secondary number. This configuration allows the telephone number 5001 to act as a regular extension number and also to act as the operator line such that callers who dial 0 are routed to the phone line with extension number 5001.
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 5001 secondary 0
The following example sets 5001 as the primary extension number for a Cisco IP phone and “500.” (the number 500 followed by a decimal point) as the secondary number. This configuration allows any calls to extension numbers from the range 5000 to 5009 to be routed to extension 5001 if the actual extension number dialed cannot be found. For example, IP phones may be active in the system with lines that correspond to 5001, 5002, 5004, 5005, and 5009. A call to 5003 or 5006 to 5009 would be unable to locate a phone with extensions 5003 or 5006 to 5009, so the call would be routed to extension 5001.
Router(config-ephone-dn)# number 5001 secondary 500.
The following example defines a pair of intercom ephone-dns that are programmed to call each other. Their numbers can contain alphabetic characters to prevent anyone from dialing them from another phone. Ephone-dn 19 is assigned the number A5511 and is programmed to dial A5522, which belongs to ephone-dn 20. Ephone-dn 20 is programmed to dial A5511. No one else can dial these numbers.
Router(config)# ephone-dn 19Router(config-ephone-dn)# number A5511Router(config-ephone-dn)# name IntercomRouter(config-ephone-dn)# intercom A5522Router(config-ephone-dn)# exitRouter(config)# ephone-dn 20Router(config-ephone-dn)# number A5522Router(config-ephone-dn)# name IntercomRouter(config-ephone-dn)# intercom A5511
Related Commands Command Description
ephone Enters ephone configuration mode.
ephone-dn Enters ephone-dn configuration mode.
huntstop Sets the huntstop attribute for the dial peers associated with the Cisco IP phone lines.
name Configures a username associated with a directory number.
preference Sets preference for the attached dial peer for a directory number.
restart Performs fast reboot of IP phone in a Cisco ITS system.
CR-62Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepickup-group
pickup-groupTo assign an ephone-dn to a Cisco IOS Telephony Services (ITS) call-pickup group, use the pickup-group command in ephone-dn configuration mode. To remove the number from the group, use the no form of this command.
pickup-group number
no pickup-group
Syntax Description
Defaults An ephone-dn does not belong to any pickup group.
Command Modes Ephone-dn configuration
Command History
Usage Guidelines This command allows administrators to assign an individual ephone-dn to a call-pickup group. Phone users can pick up ringing calls within their own pickup group more easily than calls outside their group.
Each ephone-dn can be assigned to a maximum of one pickup group.
Pickup group numbers may be of varying length, but their leading digits must be unique. For example, you cannot define both pickup group 17 and pickup group 177 in the same ITS system, because a pickup in group 17 will always be triggered before the user can enter the final 7 for 177. You can, however, define pickup groups 27 and 177 in the same ITS system.
There is no limit to the number of ephone-dns that can be assigned to a single pickup group, and there is no limit to the number of pickup groups that can be defined in a Cisco ITS system.
Examples The following example assigns an ephone-dn to pickup group 25:
Router(config)# ephone-dn 4Router(config-ephone-dn)# pickup-group 25
Related Commands
number Pickup group number.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-dn Enters ephone-dn configuration mode.
CR-63Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepilot
pilotTo define the ephone-dn that callers dial to reach a Cisco IOS Telephony Services (ITS) hunt group, use the pilot command in ephone-hunt configuration mode. To remove the pilot number from the hunt group, use the no form of this command.
pilot number
no pilot number
Syntax Description
Defaults No pilot number is defined.
Command Modes Ephone-hunt configuration
Command History
Usage Guidelines This command is valid only for Cisco ITS hunt groups.
The dial-plan pattern can be applied to the pilot number.
Examples The following example sets the pilot number to 2345 for peer hunt group number 5:
Router(config)# ephone-hunt 5 peerRouter(config-ephone-hunt)# pilot 2345
Related Commands
number E.164 number with a maximum length of 27 characters.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
final Defines the last ephone-dn in an ITS hunt group.
hops Defines the number of times that a call is redirected to the next ephone-dn in an ITS peer hunt-group list before proceeding to the final ephone-dn.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
CR-64Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepin
pinTo set an individual personal identification number (PIN) for an IP phone in a Cisco IOS Telephony Services (ITS) system, use the pin command in ephone configuration mode. To remove a PIN, use the no form of this command.
pin number
no pin number
Syntax Description
Defaults No PIN is set.
Command Modes Ephone configuration
Command History
Usage Guidelines The pin command is used in conjunction with the login command to define the capability for individual phone users to override call blocking patterns that are associated with defined time periods. Call-blocking patterns that are in effect at all times (7 days a week, 24 hours a day) cannot be overridden using a PIN. Call blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits are defined using the after-hours block pattern command. Next, one or more time periods during which calls to those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in an ITS system are restricted if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt command.
The login command applies only to IP phones that have soft keys, such as the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
Examples The following example sets a PIN for an IP phone:
Router(config)# ephone 1Router(config-ephone)# pin 1000
number An IP phone user’s PIN. The value of the number argument must be a number from four to eight digits in length.
Release Modification
12.2(15)ZJ This command was introduced.
CR-65Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepin
Related Commands Command Description
after-hour exempt Specifies that an IP phone does not have any of its outgoing calls blocked even though call blocking has been defined.
after-hours block pattern
Defines a pattern of digits for blocking outgoing calls from IP phones.
after-hours date Defines a recurring period based on month and date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
ephone Enters the Ethernet phone (ephone) configuration mode.
login Defines when IP phones in a Cisco ITS system are logged out automatically.
show ephone login Displays the login states of all phones.
CR-66Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepreference (ephone-dn)
preference (ephone-dn)To set preference order for the directory number associated with a Cisco IP phone, use the preference command in ephone-dn configuration mode. To reset the preference order to the default, use the no form of this command.
preference preference-order [secondary secondary-order]
no preference
Syntax Description
Defaults preference-order is 0 (highest preference);secondary-order is 9.
Command Modes Ephone-dn configuration
Command History
Usage Guidelines When you create an ephone-dn for an IP phone in a Cisco IOS Telephony Services (ITS) system, you automatically create a virtual voice port and one to four virtual dial peers to be used by that ephone-dn. This command sets a preference value for the primary and secondary numbers that are associated with the ephone-dn that you are creating. The preference values are passed transparently into the dial peer or dial peers created by the ephone-dn. The preference values allow you to control the selection of a desired dial peer when multiple dial peers are matched on the same destination-pattern (target) number value.
preference-order Preference order for the primary number associated with the ephone-dn. Range is from 0 to 10, where 0 is the highest preference and 10 is the lowest preference. Default is 0.
secondary secondary-order
(Optional) Preference order for the secondary number associated with the ephone-dn. Range is from 0 to 10, where 0 is the highest preference and 10 is the lowest preference. Default is 9.
Release Modification
12.1(5)YD This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(15)ZJ The secondary secondary-order keyword-argument pair was introduced.
CR-67Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepreference (ephone-dn)
Examples The following example sets a preference of 2 for the directory number 3000:
ephone-dn 1number 3000preference 2
In the following example, the number 1222 under ephone-dn 4 has a higher preference than the number 1222 under ephone-dn 5.
ephone-dn 4 number 1222 preference 0!!ephone-dn 5 number 1222 preference 1
The following example shows an ephone-dn with two numbers. The primary number has a higher preference than the secondary number.
ephone-dn 6number 2233 secondary 2234preference 0 secondary 1
Related Commands Command Description
ephone Enters ephone configuration mode.
ephone-dn Enters ephone-dn configuration mode.
huntstop Sets the huntstop attribute for the dial-peers associated with the Cisco IP phone lines.
name Configures a username associated with a directory number.
number Configures a valid number for the Cisco IP phone.
preference (dial-peer) Indicates the preferred order of a dial peer within a hunt group.
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-68Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepreference (ephone-hunt)
preference (ephone-hunt)To set preference order for the ephone-dn associated with a Cisco IOS Telephony Services (ITS) ephone-hunt-group pilot number, use the preference command in ephone-hunt configuration mode. To delete this preference order, use the no form of this command.
preference preference-order
no preference preference-order
Syntax Description
Defaults 0 (highest preference)
Command Modes Ephone-hunt configuration
Command History
Usage Guidelines This command sets a preference value that is used for matching dial peers in a Cisco IP phone virtual dial-peer group. The preference value is associated with a pilot number for a Cisco ITS ephone-hunt group. The preference value is passed transparently into the dial peer created by the pilot number. Setting the preference enables the desired dial peer to be selected when multiple dial peers within a hunt group are matched for a dial string.
Examples The following example sets the preference for the pilot number of hunt group 23 to 1:
Router(config)# ephone-hunt 23 sequentialRouter(config-ephone-hunt)# pilot 2355Router(config-ephone-hunt)# preference 1
Related Commands
preference-order Preference order. Range is from 0 to 8, where 0 is the highest preference and 8 is the lowest preference. Default is 0.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
final Defines the last ephone-dn in an ITS hunt group.
hops Defines the number of times that a call is redirected to the next ephone-dn in a ITS peer hunt-group list before proceeding to the final ephone-dn.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
CR-69Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencepreference (ephone-hunt)
pilot Defines the ephone-dn that callers dial to reach an ITS hunt group.
timeout (ephone-hunt) Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.
Command Description
CR-70Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencesecondary-dialtone
secondary-dialtoneTo activate a secondary dial tone when a Cisco IP phone user dials a defined PSTN access prefix, use the secondary-dialtone command in telephony-service configuration mode. To disable the secondary dial tone, use the no form of this command.
secondary-dialtone digit-string
no secondary-dialtone
Syntax Description
Defaults No secondary dial tone is enabled.
Command Modes Telephony-service configuration
Command History
Usage Guidelines The secondary dial tone is turned off when the next number after the digit-string is pressed. For example, if 8 were the digit-string and a person dialed 8 555-0145, the secondary dial tone would be turned off when the 5 button is pressed.
Examples The following example enables a secondary dial tone when a Cisco IP phone users press the 9 button to get an outside line:
Router(config)# telephony-serviceRouter(config-telephony-service)# secondary-dialtone 9
Related Commands
digit-string String of up to 32 numbers that defines the access prefix.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-71Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceshow ephone login
show ephone loginTo display the login states of all local IP phones, use the show ephone login in privileged EXEC mode.
show ephone login
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC
Command History
Usage Guidelines The show ephone login command displays whether an ephone has a personal identification number (PIN) and whether its owner has logged in. All local ephones are displayed by default.
Examples The following is sample output from the show ephone login command. It shows that a PIN is enabled for ephone 1 and that the owner has not logged in.
Router# show ephone login
ephone 1 Pin enabled:TRUE Logged-in:FALSEephone 2 Pin enabled:FALSEephone 3 Pin enabled:FALSEephone 4 Pin enabled:FALSEephone 5 Pin enabled:FALSEephone 6 Pin enabled:FALSEephone 7 Pin enabled:FALSEephone 8 Pin enabled:FALSEephone 9 Pin enabled:FALSE
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
login Defines when IP phones in a Cisco ITS system are logged out automatically.
pin Set an individual PIN for an IP phone in a Cisco IOS Telephony Services (ITS) system.
CR-72Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referenceshow telephony-service directory-entry
show telephony-service directory-entryTo display the entries made using the directory entry command, use the show telephony-service directory-entry command in privileged EXEC mode.
show telephony-service directory-entry
Syntax Description This command has no arguments or keywords.
Command Modes Privileged EXEC
Command History
Usage Guidelines This command lists directory entries that are made using the directory entry command but does not list entries that are made using the name and number commands in ephone-dn configuration mode.
Examples The following is sample output from this command:
Router# show telephony-service directory-entry
directory entry 1 4085550123 name Smith, John
Table CR-1 describes significant fields in this output.
Related Commands
Release Modification
12.2(15)ZJ This command was introduced.
Table CR-1 show telephony-service directory-entry Field Descriptions
Field Description
directory-tag (1 in the example) Unique identifier for this directory entry.
number (4085550123 in the example)
Telephone number or extension for the directory entry.
name Name that appears in the directory associated with the number.
Command Description
directory entry Adds an entry to a local phone directory that can be displayed on IP phones.
show telephony-service all Displays the detailed configuration of all the Cisco IP phones.
show telephony-service ephone-dn
Displays Cisco IP phone destination number output of the Cisco IOS Telephony Services router.
CR-73Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencespeed-dial
speed-dialTo create speed-dial definitions for a Cisco IP phone or analog phone using an Analog Telephone Adaptor (ATA) device, use the speed-dial command in ephone configuration mode. To disable an instance, use the no form of this command.
speed-dial speed-tag digit-string [label label-text]
no speed-dial speed-tag
Syntax Description
Defaults No speed-dial definitions
Command Modes Ephone configuration
Command History
Usage Guidelines The speed-tag argument in this command is a unique identifier for a speed-dial definition on the phone that is being configured. On Cisco IP phones, speed-dial definitions are assigned to available extension buttons that have not been assigned to extensions. Speed-dial definitions are assigned in the order of their identifier numbers.
speed-tag Unique identifier for a speed-dial definition on a phone. Range is from 1 to 34.
digit-string Digits to be dialed when the speed-dial button is pressed on an IP phone, or the digits to be dialed when the code is entered from an analog phone with an ATA device.
For IP phones, if the first character of this string is the plus sign (+), this speed-dial number is locked and cannot be changed at the phone. If the only character in this string is a pound sign (#), a user-programmable speed-dial button with no speed-dial number attached is defined.
label label-text (Optional) String containing identifying text to be displayed next to the speed-dial button, enclosed in quotation marks if a space is present.
Release Modification
12.1(5)YD This command was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1 This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(15)ZJ The number of speed-dial definitions that can be created was increased from 4 to 34. The ability to program speed-dial numbers at the phone and the ability to lock speed-dial numbers were introduced.
CR-74Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencespeed-dial
For example, if you define speed-dial 1, it is assigned to the first phone button that is available after the buttons that are assigned to extensions. If you used two buttons for extensions on a phone, speed-dial 1 is assigned to the third physical button on the phone. When you define speed-dial 2, it is assigned to the fourth physical button on the phone.
For IP phones, speed-dial numbers can be assigned by the administrator using the digit-string argument and can be locked if the digit-string argument begins with a plus sign (+). Locked numbers cannot be changed at the phone. Speed-dial instances without digit-string arguments and speed-dial instances with unlocked digit-string arguments can be changed by users at their IP phones.
If more speed-dial definitions are created than are supported by the IP phone setup, the extra speed-dial configurations are ignored.
Changes made to speed-dial buttons are saved in the router NVRAM configuration after a timer-based delay.
Analog phone users who use Cisco ATA-186 or Cisco ATA-188 devices to connect to ITS have a different method to access speed-dial numbers. Instead of pressing a speed-dial button, Phone users with ATA devices press the asterisk key and the number of a speed-dial identifier to dial a speed-dial number. For instance, a phone user with an ATA-186 would press *1 to dial the number that has been programmed as speed-dial 1. Phones with ATA devices are limited to a maximum of 9 speed-dial numbers that must be programmed by the system administrator. The numbers cannot be programmed from the phone. With phones that use ATA devices, system administrators must be sure to tell phone users when speed-dial numbers have been programmed for their phones.
This command must be followed by a quick reboot of the phone, using the restart command.
Examples The following example sets speed-dial button 2 to dial the head office at extension 5001 and locks the setting so that the phone user cannot change it at the phone:
Router(config)# ephone 23Router(config-ephone)# speed-dial 2 +5001 label “Head Office”
Related Commands Command Description
ephone Enters ephone configuration mode.
restart Performs fast reboot of IP phone in a Cisco ITS system.
CR-75Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencesystem message
system messageTo set a text message for display on idle Cisco IP Phone 7940s and Cisco IP Phone 7960s in a Cisco IOS Telephony Services (ITS) system, use the system message command in telephony-service configuration mode. To disable the system message, use the no form of this command.
system message text-message
no system message
Syntax Description
Defaults “Cisco IOS Telephony Services” is displayed.
Command Modes Telephony-service configuration
Command History
Usage Guidelines The number of characters that can be displayed is not fixed because IP phones typically use a proportional (as opposed to fixed-width) font. There is room for approximately 30 alphanumeric characters.
The display message is refreshed with a new message after any of the following events occurs:
• Busy phone goes back on-hook.
• Idle phone receives a keepalive message.
• Phone is restarted.
Examples The following example sets the message “ABC Company” to display instead of “Cisco IOS Telephony Services” on Cisco IP Phone 7940s and Cisco IP Phone 7960s when they are idle:
Router(config)# telephony-serviceRouter(config-telephony-service)# system message ABC Company
Related Commands
text-message Alphanumeric string of up to approximately 30 characters to display when the phone is idle.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-76Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetelephony-service
telephony-serviceTo enable Cisco IOS Telephony Services (ITS) and enter telephony-service configuration mode, use the telephony-service command in global configuration mode. To disable ITS, use the no form of this command.
telephony-service [setup]
no telephony-service [setup]
Syntax Description
Defaults ITS is disabled.
Command Modes Global configuration
Command History
Usage Guidelines The telephony-service command is the top-level command for all other commands related to Cisco IOS Telephony Services configuration.
The setup keyword starts the ITS setup tool, which presents a question-and-answer dialog to gather information that is used to automatically configure an ITS system. When you do not use the setup keyword, telephony-service configuration submode is opened and you can manually configure the ITS system using command-line interface (CLI) commands.
The setup CLI keyword is not stored in the router NVRAM.
If you attempt to use the setup option for a system that already has a nonempty telephony-service configuration, the command is rejected. To use the setup option after an existing telephony-service configuration has been created, first remove the existing configuration using the no telephony-service command.
Table CR-2 on page CR-78 shows a sample dialog with the ITS setup tool and explains possible responses to the ITS setup tool prompts.
setup (Optional) Uses the ITS setup tool for interactive creation of an ITS configuration.
Release Modification
12.1(5)YD This command was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T This command was integrated into Cisco IOS Release 12.2(8)T and implemented on Cisco 3725 and Cisco 3745 routers.
12.2(8)T1 This command was implemented on Cisco 2600-XM and Cisco 2691 routers.
12.2(11)T This command was implemented on the Cisco 1760.
12.2(15)ZJ The setup keyword was added.
CR-77Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetelephony-service
Table CR-2 ITS Setup Tool DIalog Prompts
ITS Setup Tool Prompt Description
Do you want to setup DHCP service for your IP phones? [yes/no]:
If you respond yes, you see the following prompts:
IP network for telephony-service DHCP Pool:
Subnet mask for DHCP network : TFTP Server IP address (Option 150) :Default Router for DHCP Pool :
• Yes configures the ITS router to act as a DHCP server, automatically providing IP addresses to your IP phones and provisioning the default gateway and TFTP IP addresses to be used by the phones. This method creates a single pool of IP addresses. If you need a pool for non-IP phones or if the ITS router cannot act as the DHCP router, answer no and manually define the DHCP server as described in the appropriate version-specificCisco IOS Telephony Services (ITS) documentation.
• No indicates that you have already configured DHCP or static IP addresses for the IP phones.
Do you want to start telephony-service setup? [yes/no]:
• Yes starts the ITS setup for phones.
• No terminates ITS setup tool.
Enter the IP source address for Cisco IOS Telephony Services:
Enter the Skinny Port for Cisco IOS telephony services : [2000]:
IP address on which the router provides ITS services, usually the default gateway for the IP subnet that you are using for the IP phones, and the port for Skinny Client Control Protocol (SCCP) messages.
How many IP phones do you want to configure : [0]:
Enter the maximum number of IP phones that this ITS system will support. This number can be increased later, to the maximum listed in the appropriate version-specific Cisco IOS Telephony Services (ITS) documentation.
Note The ITS setup tool associates one number with each newly registering phone. If you want additional numbers on a phone, add them manually later.
Do you want dual-line extensions assigned to phones? [yes for dual-line / no for single-line]:
• Yes—Each newly registering IP phones is assigned a single number that is associated with a single phone button. The system generates a dual-line ephone-dn entry for each ephone-dn.
• No—IP phones are linked directly to one or more PSTN trunk lines. Using keyswitch mode requires manual configuration in addition to using the ITS setup tool. The system generates two ephone-dn entries for each ephone-dn, and they are both assigned to a single phone.
CR-78Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetelephony-service
What language do you want on IP phones? 0 English 1 French 2 German 3 Russian 4 Spanish 5 Italian 6 Dutch 7 Norwegian 8 Portuguese 9 Danish 10 Swedish [0]:
Language for IP phone displays, selected from the list. The default is 0, English.
Note Russian is not supported in Cisco IOS Release 12.2(15)ZJ.
Which Call Progress tone set do you want on IP phones : 0 United States 1 France 2 Germany 3 Russia 4 Spain 5 Italy 6 Netherlands 7 Norway 8 Portugal 9 UK 10 Denmark 11 Switzerland 12 Sweden 13 Austria 14 Canada[0]:
Locale for the tone set used to indicate call status or progress, selected from the list. The default is 0, United States.
What is the first extension number you want to configure :[0]:
Lowest number to use for extension numbers. Each additional extension that is created receives a number that is incremented by one. Extension numbers must be compatible with your telephone number plan and with PSTN numbering requirements if you use DID service.
Do you have Direct-Inward-Dial service for all your phones? [yes/no]:
• Yes if you have trunk access to public telephone service by ISDN or VoIP for all extension numbers. The system creates an appropriate dial plan.
• No if you have simple analog phone lines only (for example, FXO interfaces) or if you have trunk access for some lines but not all lines.
If you answer yes to the previous question, you see the following prompt:
Enter the full E.164 number for the first phone:
Complete ten-digit telephone number, including area code, that corresponds to the first extension number.
Table CR-2 ITS Setup Tool DIalog Prompts (continued)
ITS Setup Tool Prompt Description
CR-79Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetelephony-service
Examples The following example enters telephony-service configuration mode for manual setup of an ITS system:
Router(config)# telephony-serviceRouter(config-telephony-service)#
The following example starts the ITS setup tool:
Router(config)# telephony-service setup
Related Commands
Do you want to forward calls to a voice message service? [yes/no]:
• Yes to forward calls to a single voice message service number when an IP phone is busy or does not answer. All phone extensions forward their calls to the same voice message service pilot number.
• No to not forward calls to a single voice message service number. Answer no if you do not have a voice message system or if you want to customize call forwarding behavior for each extension.
If you answer yes to the previous question, you see the following prompt:
Enter the extension or pilot number of the voice message service:
Voice message service pilot number. This step can be ignored during the setup dialog and manually configured later.
Call forward No Answer Timeout: [18]: Timeout, in seconds, after which to forward calls to voice mail if they are not answered. Default is 18.
Do you wish to change any of the above information? [yes/no]:
• Yes starts the dialog over again without implementing any of the answers that you previously gave.
• No starts the automatic configuration process.
Table CR-2 ITS Setup Tool DIalog Prompts (continued)
ITS Setup Tool Prompt Description
Command Description
auto assign Automatically assigns ephone-dn tags to Cisco IP phones as they register.
dialplan-pattern Creates a global prefix that can be used to expand the abbreviated extension numbers into fully qualified E.164 numbers.
ephone Enters ephone configuration mode.
ephone-dn Enters ephone-dn configuration mode.
ip source-address Identifies the IP address and port number that the Cisco IOS Telephony Services router uses for the IP phone service.
keepalive Configures the time interval between keepalive messages that are being sent to the router used by the Cisco IP phones.
load Identifies the Cisco IP phone firmware to be used by the Cisco IP phone.
max-dn Configures the maximum number of ephone-dns supported by the Cisco IOS Telephony Services router.
max-ephones Configures the maximum number of Cisco IP phones supported by the Cisco IOS Telephony Services router.
CR-80Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetelephony-service
reset Resets the Cisco IP phone.
timeouts interdigit Configures the interdigit timeout value for all Cisco IP phones attached to the router.
transfer-pattern Allows transfer of telephone calls to other non-IP phone numbers.
url Provisions URLs for use by the Cisco IP phones connected to the Cisco IOS Telephony Services router.
voicemail Configures the telephone number that is speed-dialed when the message button on a Cisco IP phone is pressed.
Command Description
CR-81Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetimeout (ephone-hunt)
timeout (ephone-hunt)To define the number of seconds after which a call that is not answered is redirected to the next number in a Cisco IOS Telephony Services (ITS) hunt-group list, use the timeout command in ephone-hunt configuration mode. To return to the default number of seconds, use the no form of this command.
timeout seconds
no timeout seconds
Syntax Description
Defaults 180 seconds
Command Modes Ephone-hunt configuration
Command History
Examples The following example defines a no-answer timeout of 10 seconds for hunt group 25:
Router(config)# ephone-hunt 25 sequentialRouter(config-ephone-hunt)# timeout 10
Related Commands
seconds Number of seconds. Range is from 3 to 60000. Default is 180.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
ephone-hunt Defines an ITS hunt group and enters ephone-hunt configuration mode.
final Defines the last ephone-dn in an ITS hunt group.
hops Defines the number of times that a call is redirected to the next ephone-dn in an ITS peer hunt-group list before proceeding to the final ephone-dn.
list Defines the ephone-dns that participate in an ITS hunt group.
max-redirect Changes the current number of allowable redirects in an ITS system.
no-reg (ephone-hunt) Specifies that the pilot number of this ITS hunt group should not register with the H.323 gatekeeper.
pilot Defines the ephone-dn that callers dial to reach an ITS hunt group.
preference (ephone-hunt)
Sets preference order for the ephone-dn associated with an ITS hunt-group pilot number.
CR-82Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetimeouts ringing (telephony-service)
timeouts ringing (telephony-service)To configure the timeout value for ringing in a Cisco IOS Telephony Services (ITS) system, use the timeouts ringing command in telephony-service configuration mode. To reset the timeout value to the default, use the no form of this command.
timeouts ringing seconds
no timeouts ringing
Syntax Description
Defaults 180
Command Modes Telephony-service configuration
Command History
Usage Guidelines This command allows you to set the length of time for which a caller can continue ringing an ITS phone when there is no answer.
Examples The following example allows incoming calls to ring for 600 seconds:
telephony-servicetimeouts ringing 600
Related Commands
seconds Duration, in seconds, for which the ITS system allows ringing to continue if a call is not answered. Range is from 5 to 60000. Default is 180.
Release Modification
12.2(15)ZJ This command was introduced.
Command Description
telephony-service Enables Cisco IOS Telephony Services and enters telephony-service configuration mode.
CR-83Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetype (ephone)
type (ephone)To define a phone type or to define one or two add-on phone modules for a Cisco IP phone, use the type command in ephone configuration mode. To remove a definition, use the no form of this command.
type phone-type [addon 1 module-type [2 module-type]]
no type phone-type [addon 1 module-type [2 module-type]]
Syntax Description
Defaults No default behavior or values
Command Modes Ephone configuration
Command History
phone-type Type of IP phone that is being defined or the type of IP phone to which a module is being added. Valid entries are:
• 7902—Cisco IP Phone 7902G
• 7905—Cisco IP Phone 7905G
• 7910—Cisco IP Phone 7910
• 7912—Cisco IP Phone 7912G
• 7935—Cisco IP Conference Station 7935
• 7940—Cisco IP Phone 7940
• 7960—Cisco IP Phone 7960
• ata—Cisco ATA-186 or Cisco ATA-188
Note The only phones that accept an add-on module are the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
addon 1 module-type (Optional) Tells the router that a module is being added to this IP phone, and the type of module. The valid entry for module-type is:
• 7914—Cisco IP Phone Expansion Module 7914
2 module-type (Optional) Tells the router that a second module is being added to this IP phone, and the type of module. The valid entry for module-type is:
• 7914—Cisco IP Phone Expansion Module 7914
Release Modification
12.2(11)YT This command was introduced.
12.2(15)T This command was integrated into Cisco IOS Release 12.2(15)T.
12.2(15)ZJ Support was added for the Cisco IP Phone 7902G, Cisco IP Phone 7905G, and Cisco IP Phone 7912G.
CR-84Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetype (ephone)
Usage Guidelines Use this command with Cisco IOS Telephony Services (ITS) V2.1 or a later version.
The following guidelines apply to this command:
• This command is required for a Cisco ATA-186 or Cisco ATA-188.
• This command with the addon keyword is required for a Cisco IP Phone 7940 or Cisco IP Phone 7960 with a Cisco IP Phone Expansion Module 7914.
• This command is optional for all other phone types, because their phone types are detected automatically.
The only types of phones that accept add-on modules are the Cisco IP Phone 7940 and the Cisco IP Phone 7960.
This command must be followed by a phone reboot using the reset command.
Examples The following example defines an IP phone with tag 10 as a Cisco IP Phone 7960 with two attached Cisco IP Phone Expansion Module 7914s:
Router(config)# ephone 10Router(config-ephone)# type 7960 addon 1 7914 2 7914
The following example defines the IP phone with tag 4 as a Cisco ATA device:
Router(config)# ephone 4Router(config-ephone)# mac 1234.87655.234Router(config-ephone)# type ata
Related Commands Command Description
ephone Enters ephone configuration mode to register Cisco IP phones.
CR-85Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Chapter Command Referencetype (ephone)
CR-86Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services V
G L O S S A R Y
A
AA Auto-attendant. A software application that provides automated operator assistance based on input of voice or DTMF tones. One use of an AA is to provide call answering using a menu of selections, such as those in the following example: “Press 0 to speak to the operator, press 1 to enter an extension number, or press 2 to enter a person’s name.” In this example, when the application receives valid keypad input, it transfers the call.
AAA Authentication, authorization, and accounting. AAA is a suite of network security services that provides the primary framework through which access control can be set up on a Cisco gateway.
ATA Analog telephone adaptor. A device that allows an analog telephone to connect to an IP phone system such as Cisco ITS.
B
blind transfer Call transfer in which the transferring phone connects the caller to a destination line before ringback begins. For example, an auto-attendant uses blind transfer to redirect calls once it receives an extension number.
buttons The physical keys on an IP phone other than those in the numbered keypad. Phone buttons are of two types: line buttons and function buttons. Line buttons can be used for extensions (ephone-dns) or for speed-dial numbers. Function buttons perform specific actions; examples are Volume, Mute, Services, Directories, and Navigation buttons. See also soft keys.
C
call blocking Preventing Cisco ITS phone users from making certain outbound calls by disallowing the dialing of specified patterns of digits.
caller ID blocking Preventing the sending of caller ID information by users of an ITS system.
call pickup The ability of an ITS phone user to retrieve an incoming call from an extension on a different phone.
Cisco ITS Cisco IOS Telephony Services (ITS). An optional feature in Cisco IOS software that enables Cisco routers to deliver key system or hybrid PBX functionality to enterprise branch offices or small businesses.
CLI Command-line interface. The basic Cisco IOS configuration and management interface.
configuration file See default configuration file.
GL-1ersion 3.0 System Administrator Guide
Glossary
consultative call
transfer
Transfer in which the transferring party either connects the caller to a ringing phone (ringback heard) or speaks with the third party before connecting the caller to the third party.
COR Class of restriction. Functionality that denies certain call attempts according to the incoming and outgoing class of restrictions provisioned on the dial peers. This functionality provides flexibility in network design, allows users to block calls (for example, to 900 numbers), and applies different restrictions to call attempts from different originators. COR specifies which incoming dial peer can use which outgoing dial peer to make a call.
customer
administrator
A class of Cisco ITS user that has provisioning privileges as determined by the system administrator. Typically a customer administrator is responsible for routine phone additions and changes but is not conversant with the Cisco IOS CLI. A customer administrator uses the ITS GUI only and not the ITS router CLI.
D
default
configuration file
An XML file that contains configuration details for phones in an ITS system. There is one shared default XML configuration file for each type of IP phone. When an IP phone comes online or is rebooted, it automatically gets information about itself from the appropriate default configuration file.
DHCP Dynamic Host Configuration Protocol. A mechanism for allocating IP addresses dynamically so that addresses can be reused when hosts no longer need them.
DID Direct Inward Dialing. The ability for callers external to an ITS system to directly dial the extension that they desire without having to dial a central answering point first.
direct station select The ability to use the Transfer soft key and a monitored line button to quickly transfer a call.
DND Do not disturb. A Cisco ITS feature available on certain IP phones that have soft key functionality. When DND is enabled, incoming calls do not ring on the phone, but do provide visual alerting and call information and can be answered if desired.
DTMF Dual tone multifrequency. A type of signaling that combines two distinct frequencies to generate a tone for each digit or character dialed, which is used by customers to signal the network. Sometimes referred to as “touchtone” because a customer generally touches keypad keys to generate the tones.
dual-line ephone-dn An ephone-dn with one voice port and two channels to handle two independent calls. See also ephone-dn.
E
E.164 An 8-byte public network addressing recommendation defined by the ITU-T that is used for standard, public telephone numbering schemes.
GL-2Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Glossary
ephone Ethernet phone. A software construct that usually represents a physical telephone instrument, although it is also used to represent a port that connects to a voice-mail system. The ephone construct provides the ability to configure the physical instrument using Cisco IOS software. Each ephone can have multiple extensions associated with it in a many-to-many relationship, and a single extension can be associated with multiple ephones so that it appears as a shared extension. The maximum number of ephones in an ITS system is the maximum number of physical instruments that can be connected to the system.
ephone-dn Ethernet phone directory number. A software construct that represents the line that connects a voice channel to a phone instrument where a user can receive and make calls. An ephone-dn represents a virtual voice port in the ITS system, so the maximum number of ephone-dns in an ITS system is the maximum number of simultaneous call connections that can occur. Ephone-dns are assigned at least one extension number but may have two. More than one ephone-dn can have the same extension number. An ephone-dn is usually associated with a single button on a phone, but may appear on more than one phone. A single button on a phone may have more than one ephone-dn associated with it. An ephone-dn can be single-line, with one voice channel, or dual-line, with two voice channels. Ephone-dns are the basic building blocks of ITS systems.
extension A term used as a common equivalent for an ephone-dn in the ITS GUI. Also the short form for extension number, which is the internal sequence of digits that is used to call an ephone-dn.
F
feature ring An audible alert with a triple-pulse cadence that differentiates incoming calls on one line from incoming calls on other lines on the phone.
G
GUI Graphical user interface. A user environment that uses pictorial as well as textual representations of the input and the output of applications and the hierarchical or other data structure in which information is stored. Such conventions as buttons, icons, and windows are typical, and many actions are performed using a pointing device (such as a mouse).
H
H.323 An ITU-T standard that describes packet-based video, audio, and data conferencing. H.323 is an umbrella standard that describes the architecture of the conferencing system and refers to a set of other standards (H.225, H.245.0, and Q.931, among others) to describe its actual protocols. H.323 allows dissimilar communication devices to communicate with each other by using a standardized communication protocol. H.323 defines a common set of codecs, call setup and negotiating procedures, and basic data transport methods.
H.450 A component of the H.323 standard that defines signaling and procedures used to provide telephony-like services. H.450 includes other standards such as H.450.2 (call forwarding) and H.450.3 (call transfer).
GL-3Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Glossary
hookflash A short on-hook period usually generated by a telephone-like device during a call to indicate that the telephone is attempting to perform a dial-tone recall from a PBX or telephone switch. Hookflash is often used to initiate call transfers.
HTML Hypertext Markup Language. The markup language used for today’s web applications, providing formatting and basic document structure for presentation via browser applications.
HTTP Hypertext Transfer Protocol. A protocol used by web browsers and web servers to transfer files.
hunt The act of an incoming call being redirected from a called number that is busy or does not answer through a group of designated numbers in a designated order until the call is answered.
hunt group A collection of ephone-dns to which incoming calls are sequentially redirected on busy and no-answer conditions as directed by the system administrator during configuration.
huntstop The ability to specify that calls should not hunt if the number that is being rung is busy or does not answer.
I
idle message The display that appears on an IP phone when it is not in use.
IFS Cisco IOS File System. The file management system for Cisco devices.
intercom A pair of dedicated extensions that are configured to speed-dial each other when they are accessed to provide a private, two-way speech path.
IP phone header bar The black top line of the display on a Cisco IP Phone 7940 or Cisco IP Phone 7960.
ITS See Cisco ITS.
ITS setup tool A question-and-answer interface from the ITS router CLI that gathers information from a system administrator and then automatically provisions phones in an ITS system.
ITU International Telecommunication Union. An international organization within the United Nations System of Organizations in which governments and the private sector coordinate global telecommunication networks and services.
IVR Interactive voice response. A term used to describe systems that provide information through analog or IP telephones in response to user input in the form of spoken words or, more commonly, DTMF signaling. Examples include automated stock quote systems and banks that allow you to check your balance from any telephone.
K
keepalive A message sent by one network device to inform another network device that the virtual circuit between the two is still complete and functioning.
keyswitch,
keyswitch model
In traditional telephony systems, a multibutton phone with several lines. The keyswitch model describes a site where the same few lines appear on all phones and are shared among all phones.
GL-4Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Glossary
L
local speed dial Speed-dial numbers that are common to all phones at an ITS site and that are accessed through the Directories button on a phone. See also personal speed dial.
M
MOH Music on hold. The ability to provide real-time or recorded sound to callers while they are on hold. MOH can be provided from an audio file or from a live feed from an external source.
monitor lamp,
monitor mode
A line button on a phone that is used to display the line status (in-use or free) of an extension as it appears on another phone. The extension cannot be used on this phone to make or receive calls.
MWI Message-waiting indication. A notification from a voice-mail system that a message has been left for the owner of the phone on which the notification was left.
N
night service During the specified hours, the ability to provide notification to designated phones that a particular extension on a different phone is ringing.
NTP Network Time Protocol. A mechanism that allows you to synchronize your ITS router to a single clock on the network, which is known as the clock master.
O
overlay Placement of up to ten ephone-dns on a single phone button.
overlay set The group of ephone-dns that are overlaid onto a single phone button.
P
paging The ability to make a one-way audio announcement to phones in a previously specified paging group.
PBX Private branch exchange. A small, local telephone office, either manually or automatically operated, that serves extensions in a business complex and provides access to the public network.
PBX model Private branch exchange model. A system configuration patterned after a traditional telephony site with a PBX in which most phones have a single, unique extension number.
GL-5Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Glossary
peer ephone hunt
group
A hunt group in which ephone-dns ring in the left-to-right order in which they were listed when the hunt group is defined. The first ephone-dn to ring is the number in the list to the right of the ephone-dn that was the last to ring when the hunt group was last called. Ringing proceeds in a circular manner, left-to-right, for the number of hops specified when the ephone hunt group is defined. See also sequential ephone hunt group.
personal speed dial Speed-dial numbers that are specific to an individual phone and that are accessed through the Directories button on the phone. See also local speed dial.
pickup See call pickup.
pilot number An extension number that is the single number that is called to access a particular service, such as paging or ephone-hunt. The number is for an ephone-dn that is not associated with any phone. Calls to the pilot number are redirected to actual ephone-dns according to configuration instructions.
PIN Personal identification number. A string of digits unique to the phone user that is used to log in to a phone for call blocking override (if enabled by the system administrator) or other functions.
POTS Plain old telephone service. A type of service provided by PSTN. See also PSTN.
POTS dial peer A dial peer connected via a traditional telephony network. A POTS dial peer points to a particular voice port on a voice network device.
preference The order in which a dial peer associated with an ephone-dn is selected if there are other dial peers that also match the dialed string.
provisioning The act of allocating phones, phone features, and phone services to individuals at a Cisco ITS site.
PSTN Public switched telephone network. A general term that refers to the variety of telephone networks and services in place worldwide.
R
RADIUS Remote Authentication Dial-In User Service. A distributed client/server system that secures networks against unauthorized access. In the Cisco implementation, RADIUS clients run on Cisco routers and send authentication requests to a central RADIUS server that contains all user authentication and network service access information.
reset (phone) A full reboot of an IP phone similar to a power-off, power-on cycle. DHCP and TFTP servers are contacted for their latest information. A phone reset takes longer than a phone restart but must be used after changes to phone firmware, user locale, network locale, and URL parameters.
restart (phone) A quick reboot of an IP phone. DHCP and TFTP servers are not contacted for their updates. A phone restart takes less time than a phone reset and should be used after changes to phone buttons, phone lines, and speed-dial numbers.
GL-6Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Glossary
RTP Real-Time Transport Protocol. Commonly used with IP networks. RTP is designed to provide end-to-end network transport functions for applications that send real-time data, such as audio, video, or simulation data, over multicast or unicast network services. RTP provides such services as payload type identification, sequence numbering, time stamping, and delivery monitoring to real-time applications.
RTSP Real Time Streaming Protocol. Enables the controlled delivery of real-time data, such as audio and video. Sources of data can include both live data feeds, such live audio and video, and stored content, such as prerecorded events. RTSP is designed to work with established protocols, such as the Real-Time Transport Protocol (RTP).
S
SCCP Skinny Client Control Protocol (sometimes Simple Client Control Protocol). Cisco-proprietary call control protocol that defines call connection methods and signaling between IP phones and the ITS router.
secondary dial tone An additional transmission of dial tone after a specified digit or digits have been dialed on an outgoing call. Typically the secondary dial tone is used for external calls and is intended to reassure the caller that the dialing of an external number can continue after the dialing of an access digit. The secondary dial tone remains on until a subsequent digit is received from the phone.
sequential ephone
hunt group
A hunt group in which ephone-dns ring in the left-to-right order in which they are listed when the hunt group is defined. The first number to ring is always the first number in the list (the number that is farthest left in the list). See also peer ephone hunt group.
shared ephone-dn An ephone-dn that appears on more than one phone.
silent ring The audible ring and call-waiting beeps are suppressed for incoming calls. Visible cues are the same as for a normal ring, including the flashing ((< icon in the phone display and the flashing red light on the handset.
SIP Session Initiation Protocol. A protocol developed by the IETF MMUSIC Working Group as an alternative to H.323. SIP features are compliant with IETF RFC 2543, published in March 1999. SIP equips platforms to signal the setup of voice and multimedia calls over IP networks.
soft keys Patterns on an IP phone LCD display that represent keys with labels indicating the particular actions that a phone user can take by pressing them. The display of these keys changes according to the current activity of the phone. See also buttons.
speed dial The ability to automatically make a call to a number by using a code or special button rather than dialing the complete number. See also local speed dial and personal speed dial.
T
TAPI Telephony Application Programming Interface. TAPI is a Microsoft Windows application programming interface that allows developers to create customized IP telephony applications.
TCL Tool Command Language. A scripting language used for gateway products both internally and externally to Cisco IOS software code.
GL-7Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Glossary
TDM Time-division multiplexing. A technique in which information from multiple channels can be allocated bandwidth on a single wire based on preassigned time slots. Bandwidth is allocated to each channel regardless of whether the station has data to transmit.
TFTP Trivial File Transfer Protocol. Simplified version of FTP that allows files to be transferred from one device to another over a network.
TSP Telephony Service Provider. A TAPI application that allows integration with Cisco Unity voice mail.
U
UC Unified Communications. The convergence of multiple media types on top of a common IP infrastructure.
V
virtual voice port An addressable endpoint for a call leg in an ITS system. Each ephone-dn has one virtual voice port, which can make one call connection.
VoiceXML Voice Extensible Markup Language. An XML document type definition (DTD) for describing speech dialogs between a caller and an IVR system, with optional TTS and ASR capabilities. It enables Internet-driven voice applications. Specifications for VoiceXML are described in the W3C VoiceXML 2.0 Working Draft.
VoIP Voice over IP. The capability to carry normal telephony-style voice over an IP-based Internet with POTS-like functionality, reliability, and voice quality. VoIP enables a router to carry voice traffic (for example, telephone calls and faxes) over an IP network.
VoIP dial peer A dial peer connected to an IP network.
VSA Vendor-specific attribute. VSAs are used with RADIUS to specify vendor-specific options and to allow vendors to support their own extended attributes that may not be suitable for general use. Cisco VSAs use RADIUS attribute 26, Cisco vendor-ID company code 9, and RADIUS subtype numbers 1 through 21 to specify AAA elements in a user profile.
W
.wav A file extension for an audio file that uses the audio file format developed by Microsoft.
X
XML Extensible Markup language. A standard maintained by the World Wide Web Consortium (W3C) that defines a syntax to let you create markup languages that specify information structures.
GL-8Cisco IOS Telephony Services Version 3.0 System Administrator Guide
Cisco IOS Telephony Services Ver
I N D E X
A
account code entry 14-14
additional directory entries 13-2
after-hour exempt command 11-3, CR-3
after-hours block pattern command 11-2, CR-4
after-hours date command 11-3, CR-6
after-hours day command 11-2, CR-8
applications integration 14-14
archives, downloading Cisco ITS 1-9
audio file for MOH 1-12
auto assign command 3-12, 3-13, CR-10
auto-cut-through command 7-8
auto-line command 8-3, CR-12
automatic line selection 8-2, CR-12
automatic phone setup 3-6
B
blocking caller ID 8-5
blocking calls 11-1
busy monitor lamp 10-3
busy subscriber callback 8-7
button command 3-18, CR-13
call-waiting beep allowed 10-5
feature ring 3-18
monitor mode 10-4
normal ring 3-18
overlay ephone-dn 12-3
silent ring 10-5
C
call back busy subscriber 8-7
call blocking 11-1
call blocking override 11-4
call coverage, secondary 12-1
caller-id block command 8-5
caller ID blocking 8-5
call forward all command 5-4
call forward busy command 5-5
call forwarding 5-1
call forward noan command 5-5
call-forward pattern command 5-3
call notification, on-hold 10-6
call pickup groups 12-13
call transfer 4-1
Cisco-proprietary 4-6
prerequisites 4-2
restrictions 4-2
cautions
usage in text xiv
CiscoIOSTSP.zip file 1-12, 14-15
Cisco ITS (IOS Telephony Services)
basic concepts 1-15
downloading files 1-9
feature history 1-2
installation sequence summary 1-13
license requirements 1-8
prerequisites 1-8
restrictions 1-12
software requirements 1-9
Cisco-proprietary call forwarding 5-4
Cisco-proprietary call transfer 4-6
IN-1sion 3.0 System Administrator Guide
Index
clid strip command CR-17
client identifier command 2-4
clock summer-time command 2-6
clock timezone command 2-6
command syntax conventions xiii
conference calls 8-4
configuration example 3-34
COR (class of restriction) 11-6
cor command 11-7
create cnf-files command 3-4
customer administrator GUI access setup 6-7
using the CLI 6-12
using the GUI 6-11
D
date-format command 3-28
debug commands 16-1
default-router command 2-3, 2-4
description command 8-15
DHCP (Dynamic Host Configuration Protocol) service 2-2
dial-plan pattern 3-22
dialplan-pattern command 3-22
dial tone, secondary 7-1
DID (Direct Inward Dialing) 1-23
directory, local
additional entries 13-2
configuring name order 13-1
disabling 13-3
directory command 13-2
directory entry command 13-3, CR-18
direct station select 10-3
display, phone
header bar 8-14
idle system display message (idle URL) 8-16
idle system text message 8-15
URL provisioning for function buttons 8-18
DND (do not disturb) 11-6
IN-2Cisco IOS Telephony Services Version 3.0 System Administrator Gu
dn-webedit command 6-4
documentation conventions xiii
documents, related 1-25
downgrading ITS phone firmware 2-8
downloading Cisco ITS files 1-9
DTMF integration with legacy voice-mail devices 9-12
DTMF relay 3-19
H.323 networks 3-19
SIP networks 3-20
dtmf-relay command
H.323 networks 3-20
SIP networks 3-21
dual-line ephone-dn 1-18
dual-number ephone-dns 1-20
E
E.164 number registration
ephone-hunt group pilot number 12-12
H.323 gatekeeper (dialplan-pattern) 3-22
H.323 gatekeeper (number) 3-16
SIP 3-23
SIP MWI 9-8, 9-11
ephone-dn command 3-16, CR-19
ephone-dns
assigning to phone (button command) 3-18
configuring 3-5
definition 1-16
dual-line 1-18
dual-number 1-20
hunt groups 12-7
maximum number 1-8
overlay 1-21, 12-2
preference 12-4
shared 1-20
single-line 1-17
two ephone-dns with one number 1-18
types 1-17
ephone-hunt command CR-21
ide
Index
ephone hunt groups 12-7
peer 12-11
sequential 12-9
ephone-hunt peer command 12-12
ephone-hunt sequential command 12-10
ephones
configuring 3-5
definition 1-16
maximum number 1-8
example, configuration 3-34
F
fastdial command 8-13, CR-23
fast transfer 10-3
feature history 1-2
feature ring (button command) 3-18
feed command CR-24
files, downloading Cisco ITS 1-9
final command 12-10, 12-12, CR-26
Flash soft key 14-2
forwarding, call 5-1
function button customized displays 8-18
fxo hook-flash command 14-2, CR-28
G
gatekeeper, H.323
not registering ephone hunt-group pilot number 12-12
number format restrictions 1-23
glossary GL-1
group call pickup 12-13
GUI (graphical user interface) 6-1
customer administrator setup 6-7, 6-11
downloading files for 1-11
files to download 1-11
how to access 6-5
phone user setup 6-13
Cisco IOS
prerequisites 6-2
restrictions 6-2
setting up 6-2
system administrator setup 6-3
H
h450 h450-2 timeout command 4-5
h450 h450-3 timeout command 5-3
header bar phone display 8-14
hold-alert command 10-7
hookflash functionality 14-2
hops command 12-12, CR-29
host command 2-4
HTTP path, setting 6-3
HTTP server, enabling 6-3
hunt groups, ephone 12-7
huntstop 12-5
huntstop (ephone-dn) command 12-6, CR-30
I
idle message phone display 8-16
idle system text message 8-15
input gain command 7-8
installation sequence for Cisco ITS 1-13
intercom 14-3
intercom command 14-5
interdigit timeout 7-2
interface command 2-5
international language and tone support 3-26
intersite calling plan 1-23
ip dhcp pool command 2-3, 2-4
ip helper-address command 2-5
ip http path flash command 6-3, 8-12
ip http server command 6-3, 8-12
IP phone header bar display 8-14
ip source-address command 3-4
IN-3 Telephony Services Version 3.0 System Administrator Guide
Index
ITS (IOS Telephony Services)
See Cisco ITS (IOS Telephony Services)
ITS setup tool 3-6
K
keepalive command 3-3, 3-4
keyswitch model 1-24
L
label command 10-2, CR-33
label support 10-2
language support 3-26
license prerequisites 1-8
line selection, automatic 8-2
list command 12-10, 12-12, CR-34
live-feed music on hold 7-7
load (telephony-service) command CR-36
load command 3-4
local directory
additional entries 13-2
configuring name order 13-1
disabling 13-3
local speed dial 8-11
login (telephony-service) command 11-5, CR-38
M
mac-address command 3-17
mapping numbers 1-23
max-conferences command 8-4
max-dn command 3-3
max-ephones command 3-3
max-redirect command 12-11, 12-13, CR-40
memory prerequisites 1-8
MIBs 1-26
moh (ephone-dn) command 7-10, CR-41
IN-4Cisco IOS Telephony Services Version 3.0 System Administrator Gu
MOH (music on hold) 7-4
audio file to download 1-12
from a live feed 7-7
from an audio file 7-5
multicast 7-6, 7-10
moh (telephony-service) command 7-6, CR-44
monitoring an ITS system 15-1
monitor lamp 10-3
multicast moh command 7-6, CR-46
MWI (message waiting indication) 9-5
mwi sip-server (telephony-service) command CR-48
N
name command 3-16
network command 2-3
network-locale command 3-27
network prerequisites 1-9
night service 10-8
night-service bell (ephone) command 10-11, CR-50
night-service bell (ephone-dn) command 10-11, CR-52
night-service code command 10-10, CR-54
night-service date command 10-10, CR-56
night-service day command 10-10, CR-58
no-reg (ephone-hunt) command 12-12, CR-60
normal ring (button command) 3-18
notes, usage in text xiv
notify telephone-event command 3-21
NTP (Network Time Protocol) 2-5
ntp server command 2-6
number (ephone-dn) command CR-61
number command 3-16
number plan 1-22
O
on-hold call notification 10-6
on-hook dialing 8-3
ide
Index
operation command 7-8
option 150 ip command 2-3, 2-4
overlay ephone-dns 1-21, 12-2
P
paging 14-6
for a single group 14-8
for multiple groups 14-11
paging command 14-9, 14-12
paging-dn command 14-9
PBX model 1-23
peer ephone hunt groups 12-11
personal speed dial 8-13
phone display
header bar 8-14
idle system display message 8-16
idle system text message 8-15
URL provisioning for function buttons 8-18
phone number plan 1-22
phones
See ephone-dns and ephones
phone setup 3-1
automatic with ITS setup tool 3-6
manual using router CLI 3-14
partially automated 3-12
phone user GUI access setup 6-13
using CLI 6-14
using GUI 6-13
pickup-group command 12-16, CR-63
pickup groups 12-13
pilot command 12-10, 12-12, CR-64
pin command 11-5, CR-65
preference (ephone-dn) command 12-5, CR-67
preference (ephone-hunt) command 12-10, 12-12, CR-69
preference order of ephone-dns 12-4
prerequisites 1-8
Cisco IOS
R
rebooting phones 3-29
register support, SIP 3-23
registrar command 3-24
related documents 1-25
relay, DTMF 3-19
resetting phones
description 3-29
reset command 3-29
restarting phones
description 3-29
restart all command 3-31
restart command 3-31
restrictions for Cisco ITS 1-12
retry register command 3-24
RFCs 1-26
ring, silent 10-5
ringing timeout 7-2
S
secondary dial tone 7-1
secondary-dialtone command 7-2, CR-71
sequential ephone hunt groups 12-9
service dhcp command 2-5
service local-directory command 13-4
setting up an ITS system 2-1
summary 1-13
shared ephone-dns 1-20
shared lines 1-22
show commands for monitoring an ITS system 15-1
show ephone callback command 8-7
show ephone command 3-33
show ephone-dn command 3-33
show ephone login command CR-72
show running-config command 3-32
show sip-ua register status command 3-24
show sip-ua statistics command 3-24
IN-5 Telephony Services Version 3.0 System Administrator Guide
Index
show sip-ua status command 3-21
show sip-ua timers command 3-24
show telephony-service directory-entry command CR-73
show telephony-service tftp-bindings command 3-33
signal immediate command 7-8
silent ring 10-5
single-line ephone-dn 1-17
SIP (Session Initiation Protocol)
MWI server 9-8, 9-11
register support 3-23
unsolicited NOTIFY for MWI 9-8, 9-11
software prerequisites 1-9
speed dial 8-7
buttons on phones 8-7
local 8-11
personal 8-13
speeddial.xml file 8-11
speed-dial command 8-9, CR-74
standards 1-25
station select 10-3
system administrator GUI access setup 6-3
system display message 8-16
system message command 8-16, CR-76
system text message 8-15
T
TAPI (Telephony Application Programming Interface) 14-14
telephony-service command 3-7, CR-77
tftp-server flash command 3-3
three-party G.711 conference calls 8-4
time-format command 3-28
timeout
interdigit 7-2
ringing 7-2
timeout (ephone-hunt) command 12-10, 12-12, CR-82
timeouts interdigit command 7-3
timeouts ringing (telephony-service) command 7-4, CR-83
IN-6Cisco IOS Telephony Services Version 3.0 System Administrator Gu
timers register command 3-24
time-webedit command 6-5
toll bar 11-1
override 11-4
tone support, locale-specific 3-26
transfer, call 4-1
transfer-mode command 4-4
transfer-pattern command 4-4, 4-6
transfer-system command 4-3
translate command 3-25
translation rules 3-25
troubleshooting 16-1
TSP (Telephony Service Provider) 14-14
downloading files 1-12
interface 14-14
prerequisites 14-15
setting up 14-15
TSPI (Telephony Service Provider Interface) 14-14
type (ephone) command CR-84
U
unsolicited SIP NOTIFY for MWI 9-8, 9-11
upgrading from ITS V2.1 to ITS V3.0 2-6
url command 8-19
url idle command 8-17
URL provisioning for customized function buttons 8-18
user GUI access setup 6-13
user-locale command 3-27
username command 6-15
V
voice mail 9-1
ide
Index
W
web admin customer command 6-13
web admin system command 6-4
web customize load command 6-8
X
XML files
downloading xml.template 1-11
idle message use of XML file 8-17
speeddial.xml for system speed dial 8-11
XML configuration file for ITS GUI 6-8
Cisco IOS
IN-7Telephony Services Version 3.0 System Administrator Guide
Index
IN-8Cisco IOS Telephony Services Version 3.0 System Administrator Gu
ide
