Cisco Unified Survivable Remote Site Telephony 8.5New Features

Last Updated: November 05, 2010

This document describes the following new and enhanced features in Cisco Unified Survivable Remote Site Telephony 8.5 (Cisco Unified SRST):

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for Cisco Unified SRST 8.5" section.

Use Cisco Feature Navigator to find information about platform support and Cisco IOS, Catalyst OS, and Cisco IOS XE software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

E.164 Enhancements

Cisco Unified SRST 8.5 allows you to present a phone number in + E.164 telephone numbering format. E.164 is an International Telecommunication Union (ITU-T) recommendation that defines the international public telecommunication numbering plan used in the PSTN and other data networks. E.164 defines the format of telephone numbers. A leading + E.164 telephone number can have a maximum of 15 digits and is usually written with a `+' prefix defining the international access code. To dial such numbers from a normal fixed line phone, the appropriate international call prefix must be used.

The leading +E.164 number is unique number specified to a phone or a device. Callers from around the world dial the leading + E.164 phone number to reach a phone or a device without the need to know local or international prefix. The leading + E.164 feature also reduces the overall telephony configuration process by eliminating the need to further translate the telephone numbers.

Phone Registration with Leading + E164 Number

In Cisco Unified SRST, phones register using the leading `+' dialing plan in two ways. Phones can either register with the extension number or with leading + E.164 number.

When phones are registered with extension number, the phones will have a dial peer association with the extension number. The dialplan-pattern command is enhanced to allow you to configure leading + phone numbers on the dialplan pattern. Once dialplan-pattern is configured, there could be an E.164 number dialpeer associated with the same phone.

For example, phones registered with extension number 1111 can also be reached by dialing +13332221111. This phone registration method is beneficial in two ways, that is, locally, phones are able to reach each other by just dialing the extension numbers and, remotely, phones can dial abbreviated numbers which are translated as an E.164 number at the outgoing dial-peer.

When phones are registered with a leading + E.164 number, there is only one leading + E.164 number associated with the phone. The demote option in the dialplan-pattern command allows the phone to have two dialpeers associated with the same phone. For more information on configuring the dialplan-patterns, see, How to Configure Dialing Plans.

Enhancement to Voice Hunt Group Restriction

In Cisco Unified CME 8.5 and later versions, when call forward no answer (CFNA) command is configured in a voice hunt group, you are not required to enter a timeout value for voice hunt group member and the call forward no answer timer is ignored. In earlier version of Cisco Unified SRST, if call forward no answer was configured for a voice hunt group member, you were required to set the value of timeout command. The timeout value was required to be less than the timeout value of the call-forward no answer command.

Forced Authorization Code

Forced Authorization Code Overview

Cisco Unified SRST 8.5 allow you to manage call access and call accounting through the Forced Authorization Code (FAC) feature. The FAC feature regulates the type of call a certain caller may place and forces the caller to enter a valid authorization code on the phone before the call is placed. FAC allows you to track callers dialing non-toll-free numbers, long distance numbers, and also for accounting and billing purposes.

In Cisco Unified SRST and Cisco Voice Gateways, devices and endpoints are logically partitioned into different logical partitioning class of restriction (LPCOR) groups. For example, IP phones, Analog phones, PSTN trunks, and IP (h323/SIP) trunks as shown in Figure 1, are partitioned into five LPCOR groups under the voice lpcor custom mode, such as:

•voice lpcor custom

– group 10 Manager

– group 11 LocalUser

– group 12 RemoteUser

– group 13 PSTNTrunk

– group 14 IPTrunk

Figure 1 Forced Authorization Code Network Overview

For each group, the LPCOR group policy of a routing endpoint is enhanced to define incoming calls from individual LPCOR groups that are restricted by FAC. A LPCOR group call to a destination is accepted only when a valid FAC is entered. FAC service for a routing endpoint is enabled through the service fac defined in a LPCOR group policy. For more information, see Enabling Forced Authorization Code (FAC) on LPCOR Groups.

The following are the group policy rules applicable to the PSTNTrunk LPCOR group:

–FAC is required by PSTNTrunk if a call is initiated from either LocalUser or RemoteUser group.

–Any calls from Manager group are allowed to terminate to PSTNTrunk without restriction.

–Any incoming calls from either IPTrunk or PSTNTrunk group are rejected and terminated to PSTNTrunk group.

FAC is required for an incoming call based on the LPCOR policy defined for the call destination. Once the authentication is finished, the success or failure status and the collected FAC digits are saved to the call detail records (CDRs).

Calls are handled by a new built-in application authorization package which first plays a user-prompt for the caller to enter a username (in digits) then, the application plays a passwd-prompt for the caller to collect the password (in digits). The collected username and password digits are then used for FAC, see Defining Parameters for Authorization Package.

When FAC authentication is successful, the outgoing call setup is continued to the same destination. If FAC authentication fails, the call is then forwarded to the next destination. FAC operations are invoked to the call if FAC service is enabled in the next destination and no valid FAC status is saved for the call.

Any calls failing because of FAC blocking are disconnected with a LPCOR Q.850 disconnect cause code. Once the FAC is invoked for a call, the collected authorization digits and the authentication status information is collected by call active or call history records. You can retrieve the FAC information through the show call active voice and show call history voice commands.

Forced Authorization Code Specification

The authorization code used for call authentication must follow these specifications:

•The authorization code must be in numeric (0 - 9) format.

•A digit collection operation must be completed if either one of the following conditions occur:

–maximum number of digits are collected

–digit input times out

–a terminating digit is entered

Once digit collection is completed, the authentication is done by either the external Radius server or Cisco Unified SRST or Cisco Voice Gateways by using AAA Login Authentication setup. For more information on AAA login authentication methods, see Configuring Login Authentication Using AAA.

FAC data is stored through the CDR and new AAA fac-digits and fac-status attributes and are supported in a CDR STOP record. This CDR STOP record is formatted for file accounting, RADIUS or Syslog accounting purpose.

Overlap Dialing Support for SCCP IP Phones

In earlier version of Cisco Unified SRST, overlap dialing was not supported over PRI/BRI trunks for calls originating from SCCP IP phones. The dialing always converted to enbloc dialing based on the dial-peer configuration and the dial-peer mapping application. Once the dialpeer matching takes place, no further dialing was possible and no overlap digit were sent over ISDN trunk, even though overlap dialing was supported over ISDN trunks.

SCCP IP phones currently support overlap dialing, but digits are converted to enbloc digits when it reaches the system. Overlap dialing is supported on SIP IP phones using the KeyPad Markup Language (KPML) method.

In Cisco IOS, with the overlap dialing support, the dialed digits from the SIP or SCCP IP phones is passed across to the PRI/BRI trunks as overlap digits and not as enbloc digits. thus, enabling overlap dialing on the PRI/BRI trunks as well.

Target Audience

This document assumes that you have knowledge of a high-level programming language, such as C++, Java, or an equivalent language. You must also have knowledge or experience in the following areas:

•TCP/IP Protocol

•Hypertext Transport Protocol

•Socket programming

•XML

In addition, users of this programming guide must have a firm grasp of XML Schema, which is used to define the AXL requests, responses, and errors. For more information on XML Schema, please see the XML Schema Part 0: Primer Second Edition.

Prerequisites

•For Cisco Unified CME: XML API must be configured in Cisco Unified CME. For configuration information, see the "Configuring the XML API" section of the Cisco Unified CME Administrator Guide.

Information About the XML API

The XML API support in Cisco Unified CME and Cisco Unified SRST provides a mechanism for inserting, retrieving, updating, and removing data from the Cisco router using eXtensible Markup Language (XML).

Request methods are XML structures that are passed to the XML server in Cisco Unified CME and Cisco Unified SRST using HTTP POST. The XML server receives the XML structures and executes the request. If the request completes successfully, then the appropriate XML response is returned.

Table 2 lists the request and response methods for the XML API along with the purpose and printers for each method.

Table 2

Description

Request

Parameter

Response

System

Execute configuration commands

ISexecCLI

command

ISexecCLIResult

Save router configuration to nvram

ISSaveConfig

—

ISSaveConfigResult

SCCP

Get system status for Cisco Unified CME or Cisco Unified SRST.

ISgetGlobal

—

ISGlobal

Get status of an IP phone

ISgetDevice

Any combination of the following:

ISDevIDISDevNameISKeyword:

–all

–allTag

–available

ISDevices

Get configuration of phone template

ISgetDeviceTemplate

Any combination of the following:

ISDevTemplateIDISKeyword:

–all

–allTag

–available

ISDeviceTemplates

Get configuration Get configuration of an extension

ISgetExtension

Any combination of the following:

ISExtIDISExtNumberISKeyword:

–all

–allTag

–available

ISExtensions

Get configuration of an extension template

ISgetExtensionTemplate

Any combination of the following:

ISExtTemplateIDISKeyword:

–all

–allTag

–available

ISExtensionTemplates

Get user information

ISgetUser

ISuserID

ISuser

Get user profile information

ISgetuserProfile

Any combination of the following:

ISUserProfileIDISuserIDISKeyword:

–all

–allTag

–available

ISUserProfiles

Get configuration for utility directory

ISgetUtilityDirectory

ISgetUtilityDirectory

—

ISUtilityDirectory

SIP

Get system status for a Cisco Unified CME running SIP

ISgetVoiceRegGlobal

—

ISSipGlobal

Get status of an IP phone

ISgetSipDevice

Any combination of the following:

ISPoolIDISPoolNameISKeyword:

–all

–allTag

–available

ISSipDevices

Get configuration of an extension

ISgetSipExtension

Any combination of the following:

ISVoiceRegDNIDISVoiceRegNumberISKeyword:

–all

–allTag

–available

ISSipExtensions

Get status of a session server

ISgetSessionServer

Any combination of the following:

ISSessionServerIDISSessionServerNameISKeyword:

–all

–allTag

–available

ISSessionServers

Get status of voice hunt groups

ISgetVoiceHuntGroup

ISVoiceHuntGroupIDISKeyword:

–all

–allTag

–available

ISVoiceHuntGroups

Get configuration for Presence

ISgetPresenceGlobal

—

ISPresenceGlobal

XML API Methods: Request and Response

Examples

This section contains the following examples for the following XML API methods:

ISexecCLI

Use ISexecCLI to execute a list of Cisco IOS commands on the Cisco router. The request must include the CLI parameter with the Cisco IOS command string for each command to be executed.

Request: Example

<SOAP-ENV:Envelope>

<SOAP-ENV:Body>

<axl>

<request xsi:type="ISexecCLI">

<ISexecCLI>

<CLI>ephone 4</CLI>

<CLI>mac-address 000D.BC80.EB51</CLI>

<CLI>type 7960</CLI>

<CLI>button 1:1</CLI>

</ISexecCLI>

</request>

</axl>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Response: Example

The value of "0" for ISexecCLIResponse in the following example shows the response when the request is completed successfully.

<SOAP-ENV:Envelope >

<SOAP-ENV:Body>

<axl >

<response xsi:type="ISexecCLIResponse" >

<ISexecCLIResponse>0</ISexecCLIResponse>

<ISexecCLIError></ISexecCLIError>

</response>

</axl>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

The following example shows the response when the request fails. The value of ISexecCLIResponse identifies which line number in the request failed. Any subsequent commands in the list of commands are not executed. All preceding commands in the list were executed.

ISSaveConfig

Use ISSaveConfig to save the running configuration on a router to the startup configuration on the same router.

Request: Example

<request>

<ISSaveConfig />

</request>

Response: Example

The following example shows that the ISSaveConfig request was successfully completed.

<response xsi:type=" ISSaveConfig">

<ISSaveConfigResult>success</ISSaveConfigResult>

</request>

The following example shows the response when the request fails.

<response xsi:type=" ISSaveConfig">

<ISSaveConfigResult>fail</ISSaveConfigResult>

</request>

The following example shows that response when the request is delayed, typically because there is another terminal session connected to Cisco Unified CME. The running configuration will be saved later by a background process after all other terminal sessions are disconnected.

<response xsi:type=" ISSaveConfig">

<ISSaveConfigResult>delay</ISSaveConfigResult>

</request>

ISgetGlobal

Use ISgetGlobal to retrieve system configuration and status information for the Cisco Unified SRST system.

ISgetDevice

Use ISgetDevice to retrieve configuration and status information for IP phones.

Use any combination of the following parameters in the request message to specific one or more SCCP phones:

•ISDevID with the ephone tag number of SCCP phone to be queried.

•ISDevName with the MAC address of SCCP phone to be queried.

•ISKeyword with one of the following options:

–all—All configured SCCP phones

–allTag— Ephone tag numbers for all SCCP phones configured

–available— Next available ephone tag number to be configured

Request: Example

<request xsi:type="ISgetDevice">

<ISgetDevice>

<ISDevID>1</ISDevID>

<ISDevName>SEP0012DA8AC43D</ISDevName>

<ISDevName>allKeyphone</ISDevName>

</ISgetDevice>

</request>

Response: Example

<response>

<ISDevices>

<ISDevice>

<ISDevID>1</ISDevID>

<ISDevName>SEP0016C7C7AF9D</ISDevName>

<ISDevType>Others</ISDevType>

<ISconfigDevType>7911</ISconfigDevType>

<ISDevUsername>test</ISDevUsername>

<ISDevLineButtons>

<ISDevLineButton>

<ISDevLineButtonID>1</ISDevLineButtonID>

<ISDevLineButtonMode>MONITOR_RING</ISDevLineButtonMode>

</ISDevLineButton>

</ISDevLineButtons>

<after-hours_exempt>false</after-hours_exempt>

<after-hours_login>

<http>false</http>

</after-hours_login>

<block-blind-xf-fallback>false</block-blind-xf-fallback>

<capf-ip-in-cnf>false</capf-ip-in-cnf>

<codec>

<codec_name>g711ulaw</codec_name>

<dspfarm-assist>false</dspfarm-assist>

</codec>

<adhoc_conference>

<add-mode>

<creator>true</creator>

</add-mode>

<admin>true</admin>

<drop-mode>

<creator>false</creator>

<local>false</local>

</drop-mode>

</adhoc_conference>

<fastdial_list>

<fastdial_item>

<fastdial>1</fastdial>

<fastdial_number>1234</fastdial_number>

<fastdial_name>home LINE</fastdial_name>

</fastdial_item>

</fastdial_list>

<feature-button_list>

<feature-button_item>

<feature-button>1</feature-button>

<feature_type>Dnd</feature_type>

</feature-button_item>

<feature-button_item>

<feature-button>2</feature-button>

<feature_type>Flash</feature_type>

</feature-button_item>

</feature-button_list>

<keep-conference>

<hangup>true</hangup>

<drop-last>false</drop-last>

<endcall>true</endcall>

<local-only>true</local-only>

</keep-conference>

<keypad-normalize>false</keypad-normalize>

<keyphone>false</keyphone>

<mtp>true</mtp>

<multicast-moh>true</multicast-moh>

<night-service_bell>true</night-service_bell>

<privacy />

<privacy-button>false</privacy-button>

<transfer-park>

<blocked>false</blocked>

</transfer-park>

<transfer-pattern>

<blocked>false</blocked>

</transfer-pattern>

<busy-trigger-per-button>0</busy-trigger-per-button>

<emergency-resp_location>0</emergency-resp_location>

<max-calls-per-button>0</max-calls-per-button>

<nte-end-digit-delay>0</nte-end-digit-delay>

<keepalive>

<timeout>30</timeout>

<aux_timeout>30</aux_timeout>

</keepalive>

<lpcor>

<type>none</type>

</lpcor>

<exclude-services>

<em_service>true</em_service>

<directory_service>false</directory_service>

<myphoneapp_service>false</myphoneapp_service>

</exclude-services>

<park>

<reservation-group>park</reservation-group>

</park>

<paging-dn>

<dn>0</dn>

<mode>multicast</mode>

</paging-dn>

<speed-dial_list>

<speed-dial_item>

<index>1</index>

<phone_number>1234</phone_number>

<label>home</label>

</speed-dial_item>

</speed-dial_list>

<ssh>

<userid>ngm</userid>

<password>ngm</password>

</ssh>

<phone_type>

<name>7911</name>

<addon_list>

<addon_item>

<addon>1</addon>

<addon_type>7914</addon_type>

</addon_item>

</addon_list>

</phone_type>

<auto-line>

<mode>normal</mode>

<auto_select_line>0</auto_select_line>

</auto-line>

<blf-speed-dial_list>

<blf-speed-dial_item>

<index>1</index>

<phone_number>1234</phone_number>

<label>blfsd</label>

</blf-speed-dial_item>

<device>true</device>

</blf-speed-dial_list>

<bulk-speed-dial_list>

<bulk-speed-dial_item>

<list>1</list>

<url />

</bulk-speed-dial_item>

</bulk-speed-dial_list>

<capf-auth-str>7777</capf-auth-str>

<description>ephoneOne</description>

<device-security-mode>none</device-security-mode>

<dnd>

<feature-ring>true</feature-ring>

</dnd>

<ephone-template>1</ephone-template>

<headset>

<auto-answer>

<line_list>

<line>1</line>

</line_list>

</auto-answer>

</headset>

<logout-profile>0</logout-profile>

<display_all_missed_calls>true</display_all_missed_calls>

<mwi-line>1</mwi-line>

<offhook-guard-timer>0</offhook-guard-timer>

<phone-ui>

<snr>true</snr>

<speeddial-fastdial>true</speeddial-fastdial>

</phone-ui>

<pin>1234</pin>

<presence>

<call-list>true</call-list>

</presence>

<provision-tag>1</provision-tag>

<username>test</username>

<password>test</password>

<video_enable>true</video_enable>

<vm-device-id>SEP0016C7C7AF9D</vm-device-id>

<ISDevAddr>

<Xipv4Address>0.0.0.0</Xipv4Address>

</ISDevAddr>

<ISPhoneLineList>

<ExtMapStatus>

<LineId>1</LineId>

<ExtId>176</ExtId>

<ExtNumber>6176</ExtNumber>

<ExtStatus>false</ExtStatus>

<LineState>idle</LineState>

</ExtMapStatus>

</ISPhoneLineList>

<ISKeyPhone>false</ISKeyPhone>

<SNRui>true</SNRui>

<ISLogoutProfileID>0</ISLogoutProfileID>

<ISUserProfileID>0</ISUserProfileID>

<ISTapiClientAddr>

<Xipv4Address />

</ISTapiClientAddr>

<ISDevStatus>unregistered</ISDevStatus>

<ISDevLastStatus>deceased</ISDevLastStatus>

<ISDevChangeTime>4040</ISDevChangeTime>

<ISDevKeepAlives>0</ISDevKeepAlives>

<ISDevTapiCStatus />

<ISTapiCLastStatus />

<ISTapiCChangeTime />

<ISTapiCKeepAlive />

<ISDevDND>no</ISDevDND>

</ISDevice>

</ISDevices>

</response>

ISgetDeviceTemplate

Use ISgetDeviceTemplate to retrieve configuration and status information for IP phone templates. Use any combination of the following parameters in the request message to specify one or more phone templates:

–available— Next available extension template ID number to be configured

Request: Example

<request>

<ISExtensionTemplates>

<ISExtensionTemplateID>1</ISExtensionTemplateID>

</ISgetExtensionTemplate>

</request>

Response: Example

<response>

<ISExtensionTemplates>

<ISExtensionTemplate>

<ISExtTemplateID>1</ISExtTemplateID>

<allow>

<watch>false</watch>

</allow>

<call-forward>

<all>

<number>1234</number>

</all>

<busy>

<number>3456</number>

<option>primary</option>

<dialplan-pattern>false</dialplan-pattern>

</busy>

<max-length>

<number>4</number>

</max-length>

<night-service-activated>

<number>7777</number>

</night-service-activated>

<noan>

<number>9999</number>

<timeout>80</timeout>

<dialplan-pattern>false</dialplan-pattern>

<option>secondary</option>

</noan>

</call-forward>

<call-waiting>

<cw_beep>

<accept>true</accept>

<generate>true</generate>

</cw_beep>

<cw_ring>true</cw_ring>

</call-waiting>

<caller-id_blocked>true</caller-id_blocked>

<corlist>

<incoming />

<outgoing />

</corlist>

<cti>

<notify>false</notify>

<watch>false</watch>

</cti>

<description>ephoneDnTemplate</description>

<hold-alert>

<timeout>15</timeout>

<mode>idle</mode>

<ring-silent-dn>true</ring-silent-dn>

</hold-alert>

<huntstop>

<channel>8</channel>

</huntstop>

<moh-group>0</moh-group>

<mwi>

<type>sip</type>

<mode>on-off</mode>

</mwi>

<mwi-type>both</mwi-type>

<pickup-group>1</pickup-group>

<transfer-recall_timeout>400</transfer-recall_timeout>

<translate>

<called>1</called>

<calling>0</calling>

</translate>

<translation-profile>

<incoming>1</incoming>

<outgoing>1</outgoing>

</translation-profile>

</ISExtensionTemplate>

</ISExtensionTemplates>

</response>

ISgetUser

Use ISgetUser to retrieve information for a particular user in Cisco Unified CME. The request must include the ISuserID parameter with a user name that is configured in Cisco Unified CME. If the request contains a valid ISuserID, the response includes the user-name tag number (ISuserTag) and type for this user.

The value for ISuserType corresponds to how a username is configured in Cisco Unified CME, as follows:

•0—INVALID_CME_USER

•1—EPHONE_USER

•2—LOGOUT_PROFILE_USER

•3—USER_PROFILE_USER

If the request contains an invalid ISuserID, the value for ISuserTag and ISuserType will both be "0."

Request: Example

<request>

<ISgetUser>

<ISuserID>a</ISuserID>

</ISgetUser>

</request>

Response: Example

<response>

<ISuser>

<ISuserID>a</ISuserID>

<ISuserType>3</ISuserType>

<ISuserTag>1</ISuserTag>

</ISuser>

</response>

ISgetUserProfile

Use the ISgetUserProfile to retrieve the status and configuration information for a specific user profile. Use any combination of the following:

•ISUserProfileID with the user profile ID of a specific user.

•ISuserID with user ID of a specific user.

•ISKeyword with one of the following options:

–all—Displays details of all configured user profiles.

–allTag— Displays a list of all configured user profile IDs.

–available— Next available user profile.

Request: Example

<request>

<ISgetUserProfile>

<ISUserProfileID>1</ISUserProfileID>

</ISgetUserProfile>

</request>

Response: Example

<response>

<ISUserProfiles>

<ISUserProfile>

<ISUserProfileID>1</ISUserProfileID>

<ISuserID>a</ISuserID>

<ISpassword>a</ISpassword>

<ISuserPin>12</ISuserPin>

<ISPrivacyButton>no</ISPrivacyButton>

<ISuserMaxIdleTime>0</ISuserMaxIdleTime>

<SpeedDials>

<SpeedDial>

<SpeedDialIndex>1</SpeedDialIndex>

<SpeedDialNumber>901</SpeedDialNumber>

<SpeedDialLabel />

<SpeedDialBLF>no</SpeedDialBLF>

</SpeedDial>

<SpeedDial>

<SpeedDialIndex>2</SpeedDialIndex>

<SpeedDialNumber>902</SpeedDialNumber>

<SpeedDialLabel />

<SpeedDialBLF>no</SpeedDialBLF>

</SpeedDial>

<SpeedDial>

<SpeedDialIndex>3</SpeedDialIndex>

<SpeedDialNumber>2002</SpeedDialNumber>

<SpeedDialLabel>2002Label</SpeedDialLabel>

<SpeedDialBLF>no</SpeedDialBLF>

</SpeedDial>

<SpeedDial>

<SpeedDialIndex>5</SpeedDialIndex>

<SpeedDialNumber>2004</SpeedDialNumber>

<SpeedDialLabel>2004</SpeedDialLabel>

<SpeedDialBLF>yes</SpeedDialBLF>

</SpeedDial>

</SpeedDials>

<UserNumbers>

<UserNumber>

<ISExtNumber>2003</ISExtNumber>

<ISExtMode>NORMAL</ISExtMode>

<ISExtOverlayGroup>0</ISExtOverlayGroup>

<ISExtCombo>no</ISExtCombo>

</UserNumber>

<UserNumber>

<ISExtNumber>201</ISExtNumber>

<ISExtMode>NORMAL</ISExtMode>

<ISExtOverlayGroup>0</ISExtOverlayGroup>

<ISExtCombo>no</ISExtCombo>

</UserNumber>

<UserNumber>

<ISExtNumber>202</ISExtNumber>

<ISExtMode>NORMAL</ISExtMode>

<ISExtOverlayGroup>0</ISExtOverlayGroup>

<ISExtCombo>no</ISExtCombo>

</UserNumber>

</UserNumbers>

<ISuserCurrentPhone>

<CurrentPhoneType>Unknown</CurrentPhoneType>

<CurrentPhoneID>0</CurrentPhoneID>

</ISuserCurrentPhone>

</ISUserProfile>

</ISUserProfiles>

</response>

ISgetUtilityDirectory

Use the ISgetUtilityDirectory to retrieve status and configuration information for directory information.

Request: Example

<request>

<ISgetUtilityDirectory>

</ISgetUtilityDirectory>

</request>

Response: Example

<response>

<ISUtilityDirectory>

<ISDirectoryEntry>

<ISDirectoryTag>1</ISDirectoryTag>

<ISDirectoryNumber>12345</ISDirectoryNumber>

<firstName>first</firstName>

<lastName>last</lastName>

</ISDirectoryEntry>

<ISDirectoryEntry>

<ISDirectoryTag>2</ISDirectoryTag>

<ISDirectoryNumber>67890</ISDirectoryNumber>

<firstName>first2</firstName>

<lastName>last 2</lastName>

</ISDirectoryEntry>

</ISUtilityDirectory>

</response

ISgetVoiceRegGlobal

Use the ISgetVoiceRegGlobal to retrieve status and configuration information of global parameters for SIP,

Request: Example

<request>

<ISgetVoiceRegGlobal>

</ISgetVoiceRegGlobal>

</request>

Response: Example

<response>

<ISSipGlobal>

<ISAddress>10.10.10.1</ISAddress>

<ISMode>cme</ISMode>

<ISVersion>7.1</ISVersion>

<ISAuthModes>

<ISAuthMode>ood_refer</ISAuthMode>

<ISAuthMode>presence</ISAuthMode>

</ISAuthModes>

<ISPortNumber>5060</ISPortNumber>

<ISMaxPool>10</ISMaxPool>

<ISMaxDN>100</ISMaxDN>

<ISMaxRedirect>5</ISMaxRedirect>

</ISSipGlobal>

</response>

ISgetSipDevice

For SIP phones, use any combination of the following parameters in the request message to specify one or more SIP phones:

•ISPoolID with the voice register pool tag number of SIP phone to be queried.

•ISPoolName with the voice register pool name of the SIP phone to be queried.

ISgetSipExtension

Use ISgetSipExtension to retrieve configuration and status information for extension numbers. Use any combination of the following parameters in the request message to specify one or more extensions:

•ISVoiceRegDNID with the extension ID number to be queried

•ISVoiceRegNumber with the extension number to be queried.

•ISKeyword with one of the following options:

–all—Displays details of all configured extension numbers.

–allTag— Displays a list of all configured extension numbers.

–available— Next available extension ID number to be configured.

Request: Example

<request>

<ISgetSipExtension>

<ISVoiceRegDNID>1</ISVoiceRegDNID>

</ISgetSipExtension>

</request>

Response: Example

<response>

<ISSipExtensions>

<ISSipExtension>

<ISVoiceRegDNID>1</ISVoiceRegDNID>

<ISExtNumber>901</ISExtNumber>

<ISSessionServerIDs>

<ISSessionServerID>1</ISSessionServerID>

<ISSessionServerID>2</ISSessionServerID>

</ISSessionServerIDs>

<ISAllowWatch>true</ISAllowWatch>

<firstName>Henry</firstName>

<lastName>Mann</lastName>

<ISSipDevList>

<ISPoolID>1</ISPoolID>

<ISPoolID>2</ISPoolID>

</ISSipDevList>

</ISSipExtension>

</ISSipExtensions>

</response>

ISgetSessionServer

Use ISgetSessionServer to retrieve configuration information for session servers in Cisco Unified CME. Use any combination of the following parameters in the request message to specify one or more session servers:

•ISSessionServerID with the session server tag number.

•ISSessionserverName with session server name.

•ISKeyword with one of the following keywords:

–all—All configured session servers

–allTag—Session server tag numbers for all configured session servers

–available—Next available session server tag number to be configured

Request: Example

<request>

<ISgetSessionServer>

<ISSessionServerID>1</ISSessionServerID>

</ISgetSessionServer>

</request>

Response: Example

<response>

<ISSessionServers>

<ISSessionServer>

<ISSessionServerID>1</ISSessionServerID>

<ISSessionRegisterID>SS1</ISSessionRegisterID>

<ISSessionKeepAlives>60</ISSessionKeepAlives>

</ISSessionServer>

</ISSessionServers>

</response>

ISgetVoiceHuntGroup

Use the ISgetVoiceHuntGroupID to retrieve status and configuration information for voice hunt groups. Use any combination of the following parameters in the request message to specify one or more voice hunt groups:

Restrictions

•Authenticated FAC data is saved to a call-leg from which the authorization code is collected. When a call-forward or blind transfer call scenario triggers a new call due to the SIP notify feature, the same caller is required to enter the authorization code again for FAC authentication.

Warning A FAC pin code must be unique and not the same as an extension number. Cisco Unified SRST and Cisco Voice Gateways will not validate whether a collected FAC pin code matches an extension number.

SUMMARY STEPS

1. enables

2. configureterminal

3. voice lpcor enable

4. voice lpcor custom

5. group numberlpcor-group

6. exit

7. voice lpcor policy lpcor-group

8. accept lpcor-group fac

9. service fac

10. end

DETAILED STEPS

Command or Action

Purpose

Step 1

enable

Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configureterminal

Example:

Router# configure terminal

Enters global configuration mode.

Step 3

voice lpcor enable

Example:

Router(config)# voice lpcor enable

Enables LPCOR functionality on the Cisco Unified CME router.

Step 4

voice lpcor custom

Example:

Router(config)# voice lpcor custom

Defines the name and number of LPCOR resource groups on the Cisco Unified CME router.

Step 5

group numberlpcor-group

Example:

Router(cfg-lpcor-custom)#group 10 Manager

Router(cfg-lpcor-custom)#group 11 LocalUser

Router(cfg-lpcor-custom)#group 12 RemoteUser

Routercfg-lpcor-custom)#group 13 PSTNTrunk

Router(cfg-lpcor-custom)#group 14 IPTrunk

Adds a LPCOR resource group to the custom resource list.

•number—Group number of the LPCOR entry. Range: 1 to 64.

•lpcor-group—String that identifies the LPCOR resource group.

Step 6

exit

Example:

Router(conf-voi-serv)# exit

Exits voice-service configuration mode.

Step 7

voice lpcor policylpcor-group

Example:

Router(cfg-lpcor-custom)#group 10 Manager

Router(cfg-lpcor-custom)#group 11 LocalUser

Router(cfg-lpcor-custom)#group 12 RemoteUser

Router(cfg-lpcor-custom)#group 13 PSTNTrunk

Router(cfg-lpcor-custom)#group 14 IPTrunk

Creates a LPCOR policy for a resource group.

•lpcor-group—Name of the resource group that you defined in Step 5.

Step 8

accept lpcor-group fac

Example:

Router(cfg-lpcor-policy)# accept PSTNTrunk fac

Router(cfg-lpcor-policy)# accept Manager fac

Allows a LPCOR policy to accept calls associated with the specified resource group.

•Default: Calls from other groups are rejected; calls from the same resource group are accepted.

•fac—Valid forced authorization code that the caller needs to enter before the call is routed to its destination.

•Repeat this command for each resource group whose calls you want this policy to accept.

Step 9

servicefac

Example:

Router(cfg-lpcor-policy)#service fac

Enables force authorization code service for a LPCOR group.

•Default: No form of the service fac command is the default setting of a LPCOR group policy.

Step 10

end

Example:

Router(config-ephone)# end

Returns to privileged EXEC mode.

Examples

Router# show voice lpcor policy

voice lpcor policy PSTNTrunk (group 13):

service fac is enabled

( accept ) Manager (group 10)

( reject ) LocalUser (group 11)

( reject ) RemoteUser (group 12)

( accept ) PSTNTrunk (group 13)

( reject ) IPTrunk (group 14)

Defining Parameters for Authorization Package

To define required parameters for user name and password, follow these steps:

SUMMARY STEPS

1. enable

2. configureterminal

3. application

4. package auth

5. param user-promptfilename

6. param passwd-promptfilename

7. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable

Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configureterminal

Example:

Router# configure terminal

Enters global configuration mode.

Step 3

application

Example:

Router(config)#application

Router(config-app)#

Enters the application configuration mode.

Step 4

package auth

Example:

Router(config-app)#package auth

Enters package authorization configuration mode.

Step 5

param passwd

Example:

Router(config-app)#package param passwd 12345

Character string that defines a predefined password for authorization.

Note Password digits collection is optional if password digits are predefined in the param passwd comamnd

RFCs

No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.

—

Technical Assistance

Description

Link

The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies.

To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds.

Access to most tools on the Cisco Support website requires a Cisco.com user ID and password.

The following example shows overlap-signal configured in call-manager-fallback mode:

Router# show run | sec call-manager

call-manager-fallback

max-conferences 12 gain -6

transfer-system full-consult

overlap-signal

dialplan-pattern (call-manager-fallback)

To create a global prefix that can be used to expand the extension numbers of inbound and outbound calls into fully qualified E.164 numbers, use the dialplan-pattern command in call-manager-fallback configuration mode. To disable the dialplan-pattern command settings, use the no form of this command.

Syntax Description

Dial-plan string tag used before a ten-digit telephone number. The tag number is from 1 to 10.

pattern

Dial-plan pattern, such as the area code, the prefix, and the first one or two digits of the extension number, plus wildcard markers or dots (.) for the remainder of the extension number digits.

extension-length

Sets the number of extension digits that will appear as a caller ID.

extension-length

The number of extension digits. The extension length must match the setting for IP phones in Cisco Unified CallManager mode. The range is from 1 to 32.

extension-pattern

(Optional) Sets an extension number's leading digit pattern when it is different from the E.164 telephone number's leading digits defined in the pattern variable.

extension-pattern

(Optional) The extension number's leading digit pattern. Consists of one or more digits and wildcard markers or dots (.). For example, 5.. would include extensions 500 to 599; 5... would include extensions 5000 to 5999. The extension pattern must match the setting for IP phones in Cisco Unified CallManager mode.

no-reg

(Optional) Prevents the E.164 numbers in the dial peer from registering with the gatekeeper.

demote

(Optional) Demotes the registered phone if it matches the pattern, extension-length, and extension pattern.

Command Default

No default behavior or values.

Command Modes

Call-manager-fallback configuration

Command History

Cisco IOS Release

Cisco Product

Modification

12.1(5)YD

Cisco SRST 1.0

This command was introduced on the Cisco 2600 series and Cisco 3600 series multiservice routers and on the Cisco IAD2420 series.

12.2(2)XT

Cisco SRST 2.0

This command was implemented on the Cisco 1750 and Cisco 1751 multiservice routers.

12.2(8)T

Cisco SRST 2.0

This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745 routers.

12.2(8)T1

Cisco SRST 2.0

This command was implemented on the Cisco 2600-XM and Cisco 2691 routers.

12.2(11)T

Cisco SRST 2.01

This command was integrated into Cisco IOS Release 12.2(11)T and implemented on the Cisco 1760 routers.

12.2(11)YT

Cisco SRST 2.1

The extension-pattern keyword was added.

15.1(3)T

Cisco Unified SRST 8.5

This command was modified. The demote keyword was added to the dialplan pattern command and the dialplan patterntag value was increased to 1-10.

Usage Guidelines

The dialplan-pattern command builds additional dial peers. For example, if a hidden POTS dial peer is created, such as the following:

Router(config)# dial-peer voice 20001 pots

Router(config-dial-peer)# destination-pattern 1001

Router(config-dial-peer)# voice-port 50/0/2

and a dial-plan pattern is created, such as 40855510.., then an additional dial peer will be created that allows calls to both the 1001 and 4085551001 numbers. For example:

Router(config)# dial-peer voice 20002 pots

Router(config-dial-peer)# destination-pattern 4085551001

Router(config-dial-peer)# voice-port 50/0/2

Both dial peers can be seen with the show dial-peer voice command.

The dialplan-pattern command also creates a global prefix that can be used by inbound calls (calls to an IP phone in a Cisco Unified SRST system) and outbound calls (calls made from an IP phone in a Cisco Unified SRST system) to expand their extension numbers to fully qualified E.164 numbers.

For inbound calls (calls to an IP phone in a Cisco Unified SRST system) where the calling party number matches the dial-plan pattern, the call is considered a local call and has a distinctive ring that identifies the call as internal. Any calling party number that does not match the dial-plan pattern is considered an external call and has a distinctive ring that is different from the internal ringing.

For outbound calls, the dialplan-pattern command converts the calling party's extension number to an E.164 calling party number. Outbound calls that do not use an E.164 number and go through a PRI connection to the PSTN may be rejected by the PRI link as the calling party identifier.

If there are multiple patterns, called-party numbers are checked in numeric order, starting with pattern 1, until a match is found or until the last pattern has been checked.The valid dial-plan pattern with the lowest tag is used as a prefix to all local Cisco IP phones.

When extension-pattern extension-pattern keyword and argument are used, the leading digits of an extension pattern are stripped and replaced with the corresponding leading digits of the dial plan. For example, the following command maps all extension numbers 4xx to the PSTN number 40855501xx, so that extension 412 corresponds to 4085550112.

The number of extension-pattern argument characters must match the number set for the extension-length argument. For example, if the extension-length is 3, the extension-pattern can be 8.., 1.., 51., and so forth.

A dial-plan pattern is required to register the Cisco IP phone lines with a gatekeeper. The no-reg keyword provides the option of not registering specific numbers to the gatekeeper so that those numbers can be used for other telephony services.

When the demote keyword is used, the dialplan-pattern command tries to demote the registered phone if it matches the pattern, extension-length, and extension-pattern.

Examples

The following example shows how to create dial-plan pattern 1 for extension numbers 5000 to 5099 with a prefix of 408555. If an inbound calling party number (4085555044) matches dial-plan pattern 1, the recipient phone will display an extension (5044) as the caller ID and use an internal ringing tone. If an outbound calling party extension number (5044) matches dial-plan pattern 1, the calling party extension will be converted to an E.164 number (4085555044). The E.164 calling party number will appear as the caller ID.

In the following example, the dialplan-pattern command creates dial-plan pattern 1 for extensions 800 to 899 with the telephone prefix starting with 4085559. As each number in the extension pattern is declared with the number command, two POTs dial peers are created. In the example, they are 801 (an internal office number) and 4085559001 (an external number).

The following example shows a configuration for two Cisco Unified SRST systems. Each is configured with the same dialplan-pattern commands, but one system uses 50.. and the other uses 60.. for extension numbers. Calls from the "50.." system to the "60.." system, and vice versa, are treated as internal calls. Calls that go across an H.323 network and calls that go to a PSTN through an ISDN interface on one of the configured Cisco Unified SRST routers are represented as E.164.

Related Commands

package

To enter application-parameter configuration mode to load and configure a package, use the package command in application configuration mode. There is no no form of this command.

package package-name location

no package package-name

Syntax Description

package-name

Name that identifies the package.

location

Directory and filename of the package in URL format. For example, flash memory (flash:filename), a TFTP (tftp://../filename) or an HTTP server (http://../filename) are valid locations.

Defaults

No default behavior or values

Command Modes

Application configuration

Command History

Release

Modification

12.3(14)T

This command was introduced.

Usage Guidelines

Use this command to enter application parameter configuration mode to load and configure a package. A package is a linkable set of C or Tcl functions that provide functionality invoked by applications or other packages. They are not standalone. For example, a debit card application may use multiple language translation packages, such as English and French. These language translation packages can also be used by other applications without having to modify the package for each application using it.

The packages available on your system depend on the scripts, applications, and packages that you have installed. Your software comes with a set of built-in packages, and additional packages can be loaded using the Tcl package command. You can then use the package command in application configuration mode to access the parameters contained in those packages.

Examples

The following example shows that a French language translation package is loaded:

Related Commands

Defines the name of a voice application and specify the location of the Tcl or VoiceXMLdocument to load for this application.

package appcommon

Configures parameters in the built-in common voice application package.

package callsetup

Configures parameters in the built-in call setup package.

package language

Loads an external Tcl language module for use with an IVR application.

package session_xwork

Configure parameters in the built-in session_xwork package.

param

To load and configure parameters in a package or a service (application) on the gateway, use the param command in application configuration mode. To reset a parameter to its default value, use the no form of this command.

Usage Guidelines

Use this command in application parameter configuration mode to configure parameters in a package or service. A package is a linkable set of C or Tcl functions that provide functionality invoked by applications or other packages. A service is a standalone application.

The parameters available for configuration differ depending on the package or service that is loaded on the gateway. The param register Tcl command in a service or package registers a parameter and provides a description and default values which allow the parameter to be configured using the CLI. The param register command is executed when the service or package is loaded or defined, along with commands such as package provide, which register the capability of the configured module and its associated scripts. You must configure and load the Tcl scripts for your service or package and load the package in order to configure its parameters. See the Tcl IVR API Version 2.0 Programming Guide for more information.

When a package or service is defined on the gateway, the parameters in that package or service become available for configuration when you use this command. Additional arguments and keywords are available for different parameters. To see a list of available parameters, enter param ?.

To avoid problems with applications or packages using the same parameter names, the parameter namespace, or parameterspace concept is introduced. When a service or a package is defined on the gateway, its parameter namespace is automatically defined. This is known as the service or package's local parameterspace, or "myparameterspace." When you use this command to configure a service or package's parameters, the parameters available for configuration are those contained in the local parameterspace. If you want to use parameter definitions found in different parameterspace, you can use the paramspace parameter-namespace command to map the package's parameters to a different parameterspace. This allows that package to use the parameter definitions found in the new parameterspace, in addition to its local parameterspace.

Use this command in Cisco Unified Communication Manager Express 8.5 and later versions to define the username and password parameters to authenticate packages for Forced Authorization Code (FAC)

When a predefined password is entered using the param passwd keyword, callers are not requested to enter a password. You must define a filename for user-promptto play an audio prompt requesting the caller to enter a valid username (in digits) for authorization. Similarly, you must define a filename for passwd-prompt to play an audio prompt requesting the caller to enter a valid password (in digits) for authorization.

Examples

The following example shows how to configure a parameter in the httpios package:

application

package httpios

param paramA value4

Related Commands

Command

Description

call application voice

Defines the name of a voice application and specify the location of the Tcl or VoiceXMLdocument to load for this application.

param account-id-method

Configures an application to use a particular method to assign the account identifier.

param convert-discpi-after-connect

Enables or disables conversion of a DISCONNECT message with Progress Indicator set to PROG_INBAND (PI=8) to a regular DISCONNECT message when the call is in the active state.

param event-log

Enables or disables logging for linkable Tcl functions (packages).

param language

Configures the language parameter in a service or package on the gateway.

param mode

Configures the call transfer mode for a package.

param pin-len

Defines the number of characters in the personal identification number (PIN) for an application.

param redirect-number

Defines the telephone number to which a call is redirected—for example, the operator telephone number of the service provider—for an application.

param reroutemode

Configures the call transfer reroutemode (call forwarding) for a package.

param retry-count

Defines the number of times a caller is permitted to reenter the PIN for a designated application and passes that information to the application.

param security

Configures security for linkable Tcl functions (packages).

paramspace

Enables an application to use parameters from the local parameter space of another application.

param uid-length

Defines the number of characters in the UID for a package.

param warning-time

Defines the number of seconds of warning that a user receives before the allowed calling time expires.

Feature Information for Cisco Unified SRST 8.5

Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.

Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

Note Table 3 lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS software release train also support that feature.

Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned 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. (1005R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.