Configuring SIP and TEL URL Support
Configuring SIP and TEL URL Support
The Configuring SIP and TEL URL Support feature enables Cisco gateways to direct incoming calls to
a voice application based on the Uniform Resource Locator (URL) and Tcl Interactive Voice Response
(IVR) 2.0 and VoiceXML applications to place outbound calls to a SIP or TEL URL. This feature
expands call-control capabilities by allowing voice applications to use URL destinations and by
implementing dialing plans using SIP or TEL URLs, rather than telephone numbers.
Note In this document, the terms uniform resource identifier (URI) and URL are used interchangeably.
Contents
• Prerequisites for Configuring SIP and TEL URL Support, page 2
• Restrictions for Configuring SIP and TEL URL Support, page 2
• Information About SIP and TEL URL Support, page 2
• How to Configure SIP and TEL URL Support, page 3
• Configuration Examples for SIP and TEL URL Support, page 21
• Where to Go Next, page 30
• Additional References, page 31
• Feature Information for Configuring SIP and TEL URL Support, page 31
• To enable voice applications to read and pass SIP headers, see the Cisco IOS SIP Configuration
Guide.
• To specify SIP and TEL URLs in a Tcl IVR 2.0 script or VoiceXML document, see the Tcl IVR API
Version 2.0 Programmer’s Guide or Cisco VoiceXML Programmer’s Guide.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice class uri tag sip
4. pattern uri-pattern
5. host hostname-pattern or host {ipv4:ipv4-address | ipv6:ipv6-address | dns:domain-name |
hostname-pattern}
6. user-id username-pattern
7. phone context context-pattern
8. end
DETAILED STEPS
Example:
Router# configure terminal
Step 3 voice class uri tag sip Enter voice class configuration mode for a SIP URI.
Example:
Router(config)# voice class uri ab200 sip
Step 4 pattern uri-pattern (Optional) Specifies a regular expression pattern for
matching the entire TEL URI.
Example: Note When you configure the pattern command, you
Router(config-voice-uri-class)# pattern ^408 cannot configure the phone number or phone
context command, because the pattern command
matches the entire URI.
Step 5 host hostname-pattern (Optional) Specifies a regular expression pattern for
or matching the hostname field in the SIP URI.
host {ipv4:ipv4-address | ipv6:ipv6-address | • Only one instance of the command can be configured at
dns:domain-name}
any given time.
Specifies the host command by assigning an IPv4 address,
Example: IPv6 address, or Domain Name Server (DNS) name. You
Router(config-voice-uri-class)# host server1
can specify up to ten instances of this command.
or
Note You can use either the host hostname or host
Router(config-voice-uri-class)# host
ipv4:10.0.0.0 {ipv4:ipv4-address | ipv6:ipv6-address |
dns:domain-name} command.
Step 6 user-id username-pattern (Optional) Specifies a regular expression pattern for
matching the username field in the SIP URI.
Example:
Router(config-voice-uri-class)# user-id elmo
Step 7 phone context context-pattern (Optional) Specifies that only calls with a matching
phone-context field in the URI are selected.
Example: Note You must use the phone context command with
Router(config-voice-uri-class)# phone context either the host or user-id command or both. Using
408 this command alone does not result in any matches
on the voice class.
Step 8 end Exits voice class URI configuration mode and enters
privileged EXEC mode.
Example:
Router(config-voice-uri-class)# end
What to Do Next
• To use the URI voice class to handle incoming calls, continue with the “Configuring an Inbound Dial
Peer to Match on a URI” section on page 7.
• To use the URI voice class to handle outbound calls, continue with the “Configuring an Outbound
Dial Peer for URI Destinations” section on page 15.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice class uri tag tel
4. pattern uri-pattern
5. phone number phone-number-pattern
6. phone context context-pattern
7. end
DETAILED STEPS
Example:
Router# configure terminal
Step 3 voice class uri tag tel Enters voice class URI configuration mode for a TEL URI.
Example:
Router(config)# voice class uri ab200 tel
Step 4 pattern uri-pattern (Optional) Specifies a regular expression pattern for
matching the entire TEL URI.
Example: Note If you use the pattern command you cannot use the
Router(config-voice-uri-class)# pattern ^408 phone number or phone context command in the
following steps because the pattern command
matches the entire URI.
Step 5 phone number phone-number-pattern (Optional) Specifies a regular expression pattern for
matching the phone number field in the TEL URI.
Example:
Router(config-voice-uri-class)# phone number
^8555
Step 6 phone context context-pattern (Optional) Specifies that only calls with a matching
phone-context field are selected.
Example: Note You must use the phone context command with the
Router(config-voice-uri-class)# phone context phone number command. Using this command
555 alone does not result in any matches on the voice
class.
Step 7 end Exits voice class configuration mode and enters privileged
EXEC mode.
Example:
Router(config-voice-uri-class)# end
Prerequisites
• Enable SIP header passing. For information, see the Cisco IOS SIP Configuration Guide, Release
15.1
• Write a Tcl IVR 2.0 script or VoiceXML document that accepts a SIP or TEL URI. For information,
see the Tcl IVR API Version 2.0 Programmer’s Guide or Cisco VoiceXML Programmer’s Guide.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. service name
5. incoming uri {called | calling} tag
6. end
DETAILED STEPS.
Example:
Router# configure terminal
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode for a VoIP dial peer.
Example:
Router(config)# dial-peer voice 2 voip
Step 4 service name Associates an application with this VoIP dial peer.
Note When you configure the pattern command, you
Example: cannot configure the phone number or phone
Router(config-dial-peer)# service vapp1 context command, because the pattern command
matches the entire URI.
Step 5 incoming uri {called | calling} tag Specifies the URI voice class that matches calls to this dial
peer based on the destination URI or source URI in the
H.225 message.
Example:
Router(config-dial-peer)# incoming uri called Note This URI voice class must already be configured by
ab400 using the voice class uri command.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice class uri tag sip
4. host hostname-pattern or host {ipv4:ipv4-address | ipv6:ipv6-address | dns:dns-address |
hostname-pattern}
5. exit
DETAILED STEPS
Example:
Router# configure terminal
Step 3 voice class uri tag sip‘ Creates a voice class for matching dial peers to a SIP and
enters voice URI class configuration mode.
Example:
Router(config)# voice class uri ab200 sip
Step 4 host hostname-pattern (Optional) Specifies a regular expression pattern for
or matching the hostname field in the SIP URI.
host {ipv4:ipv4-address | ipv6:ipv6-address | • This command can have a single instance only.
dns:domain-name}
Specifies the host command by assigning the IPv4 address,
IPv6 address, or DNS name.
Example:
Router(config-voice-uri-class)# host server1 • You can specify up to ten instances of this command.
or Note You can use either the host hostname or host
Router(config-voice-uri-class)# host {ipv4:ipv4-address | ipv6:ipv6-address |
ipv4:10.0.0.0 dns:domain-name} command.
Step 5 exit Enters global configuration mode.
Example:
Router(config-voice-uri-class)# exit
Step 6 dial-peer voice tag voip Enters dial peer voice configuration mode.
Example:
Router(config)# dial-peer voice 6000 voip
Step 7 session protocol sipv2 Configures SIP as the session protocol type.
Example:
Router(config-dial-peer)# session protocol
sipv2
Step 8 incoming uri {from | request | to | via} tag Specifies the voice class used to match a VoIP dial peer to
the URI of an incoming call.
Example:
Router(config-dial-peer)# incoming uri via
ab200
Step 9 end Exits dial peer voice configuration mode and enters
privileged EXEC mode.
Example:
Router(config-dial-peer)# end
SUMMARY STEPS
DETAILED STEPS
Step 3 show dialplan incall uri sip {from | request | to | via} uri
Use the show dialplan incall uri to display the dial peer that is matched for a specific URI in an
incoming voice call. The following sample output shows the dial peer that is matched for an incoming
call, based on the selected URI:
Router# show dialplan incall uri sip via sip:9.13.38.83
Inbound VoIP dialpeer matching based on SIP URI's
VoiceOverIpPeer100
peer type = voice, system default peer = FALSE, information type = voice,
description = `',
Prerequisites
Write a Tcl IVR 2.0 script or VoiceXML document that implements call transfer to a SIP or TEL URI.
For information, see the TCL IVR API Version 2.0 Programming Guide or Cisco VoiceXML
Programmer’s Guide.
Restrictions
• Outbound calls to a SIP URL cannot be placed to a public switched telephone network (PSTN) leg
because dial-peer matching does not support this. Outbound calls to a TEL URL can be placed to a
PSTN call leg. The telephone number is pulled from the URL and used as the destination number.
• Underscores are not supported in the From header or in the callinfo originationNum field of a SIP
URI in a Tcl script or VoiceXML document.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. session target ipv4:ip-address
5. session protocol sipv2
6. destination uri tag
7. end
DETAILED STEPS
Example:
Router# configure terminal
Step 3 dial-peer voice tag voip Enters dial peer configuration mode for a VoIP dial peer.
Example:
Router(config)# dial-peer voice 2 voip
Step 4 session target ipv4:ip-address (Optional) Specifies the IP address of the terminating
gateway
Example: Note The session target command is required when
Router(config-dial-peer)# session target placing a call to a TEL URI; it is optional for a SIP
ipv4:10.10.1.1 URI. If you do not configure a session target for a
SIP URI, the call is sent to the host address in the
SIP URI that is passed from the application
initiating the outbound call.
Step 5 session protocol sipv2 (Optional) Specifies the session protocol if you are using
SIP for calls between the local and remote gateways.
Example: Note If you are using H.323 do not configure the session
Router(config-dial-peer)# session protocol protocol command.
sipv2
Step 6 destination uri tag Specifies the URI class that links voice calls to this dial
peer.
Example: Note Before configuring the destination uri command,
Router(config-dial-peer)# destination uri 700 you should configure the URI voice class by using
the voice class uri command.
Step 7 end Exits dial peer voice configuration mode and enters
privileged EXEC mode.
Example:
Router(config-dial-peer)# end
SUMMARY STEPS
1. show running-config
DETAILED STEPS
To display a list of all voice classes, use the show voice class uri summary command.
Router# show voice class uri summary
__________________________________________
Class Name Schema
------------------------------------------
100 sip
300 tel
500 sip
__________________________________________
VoiceOverIpPeer599
peer type = voice, information type = voice,
description = `',
tag = 599, destination-pattern = `',
Note For a description of the fields shown in this output, see the show dialplan uri command in the
Cisco IOS Voice Command Reference.
Troubleshooting Tips
• Do not use underscores in the From header or in the callinfo originationNum field of a SIP URI in
a Tcl script or VoiceXML document. Using underscores in these fields, as shown in the following
examples, causes call transfer to fail:
set callInfo(originationNum) “sip:[email protected]”
• Use Tcl puts commands or VoiceXML log commands in your script to help with debugging. To
display the output from these commands, use the debug voip ivr script command for Tcl IVR 2.0
scripts, or the debug vxml puts command for VoiceXML documents.
For information on using the Tcl puts command, see the TCL IVR API Version 2.0 Programming
Guide. For information about the VoiceXML log command, see the Cisco VoiceXML Programmer’s
Guide.
SUMMARY STEPS
1. debug dialpeer
2. debug voice uri
3. debug voice ccapi error
DETAILED STEPS
A message showing Result=-1 indicates that a dial peer was not matched. Because this output does not
display another dial peer match statement, you know that the gateway failed to find a match.
Step 2 debug voice uri
Use the debug voice uri command to verify whether there is a voice class that matches the URI in the
Tcl script or VoiceXML document.
In the following example, the gateway failed to match the URI in the script to the only configured
voice class, 805:
Router# debug voice uri
Any output from this command means that the call transfer did not complete, although the reason for the
error might not be obvious from the messages.
Note For information about reading and passing SIP headers, see the Cisco IOS SIP Configuration Guide.
Example: URIs with Header Passing Using SIP Protocol and H.323 Protocol
In the following example, when a SIP call comes into the originating gateway, the application
sip_headers_tcl asks the caller to enter an account number. After the account number is collected, it is
assigned to a header named AccountInfo. The AccountInfo is passed to the leg setup along with other
standard and user-defined headers in the destination URL.
The outgoing call matches on dial peer 766, which is configured with the destination uri command to
match on voice class 766. Voice class 766 is configured with the voice class uri command to match
destination SIP URI sip:[email protected]. The gateway places a call to
sip:[email protected].
When the call setup request is received by the gateway, the headers that are passed from the application
are included in the SIP INVITE message.
In the following example, when an H.323 call comes into the originating gateway, the application
tel_headers_vxml asks the caller to enter an account number. After the account number is collected, it is
assigned to a header named AccountInfo. The AccountInfo is passed to the leg setup along with other
user-defined headers in the destination URL.
The outgoing call matches on dial peer 767, which is configured with the destination uri command to
match on voice class 767. Voice class 767 is configured with the voice class uri command to match
telephone number 555-0100 and a phone context of 408. The voice class can also match against a URL
pattern. This example uses the phone number and phone context as a matching criteria. The gateway
places a call to a TEL URL with the header of
tel:555-0100;phone-context=408;tsp=example.com;Subject=HelloTelVXML;[email protected];
From=nobody; Priority=urgent'+';AccountInfo='+acctInfo.
When the call setup request is received by the gateway, the destination URL with headers and parameters
is passed in the setup message as part of the destination address.
!
version x.x
service timestamps debug datetime msec localtime
service timestamps log datetime msec localtime
no service password-encryption
service internal
!
hostname 10.7.102.32
!
no logging buffered
enable password lab
!
username 1111
username 2222 password 0 2222
!
!
resource-pool disable
!
aaa new-model
!
!
aaa authentication login h323 local group radius
aaa authorization exec h323 group radius
aaa accounting connection h323 start-stop group radius
aaa session-id common
ip subnet-zero
ip ftp username dump
ip ftp password dump123
ip host px1-sun 10.0.1.0
ip host rtsp-ws 10.1.1.0
ip host dev 10.3.0.1
!
voice-port 3:D
!
mgcp modem passthrough voip mode ca
no mgcp timer receive-rtcp
!
mgcp profile default
!
dial-peer cor custom
!
!
dial-peer voice 1 pots
service sip_headers_tcl
incoming called-number 52948
port 0:D
!
dial-peer voice 2 pots
application tel_headers_vxml
incoming called-number 52950
port 0:D
!
dial-peer voice 767 voip
session target ipv4:10.0.0.1
destination uri 767
codec g711ulaw
!
dial-peer voice 766 voip
session protocol sipv2
session target ipv4:10.0.0.1
destination uri 766
codec g711ulaw
!
dial-peer voice 7671234 voip
service get_headers_vxml out-bound
destination-pattern .......
session protocol sipv2
session target ipv4:10.0.0.1
codec g711ulaw
!
sip-ua
sip-server ipv4:10.0.1.1
!
!
line con 0
exec-timeout 0 0
line aux 0
line vty 0 4
!
exception core-file special3
exception dump 10.7.100.1
end
Example: URIs with Header Passing Using SIP Protocol and H.323 Protocol
In the following example, when the call arrives at the terminating gateway and dial peer 766 is matched,
the gateway stores all headers received in the incoming INVITE message so these can be accessed by
the application.
The inbound dial peer can be configured to match the request-URI, or the “To” or “From” header in the
incoming INVITE message. This example uses the request-URI for matching. The incoming call
matches on dial peer 766, which is configured with the incoming uri request command to match on
voice class 766. Voice class 766 is configured to match the incoming SIP request-URI
sip:[email protected].
When the call is handed to the application configured in the inbound dial peer, get_headers_tcl, this Tcl
application can read any header that is part of the incoming INVITE message.
In the following example, when the call arrives at the terminating gateway and dial peer 767 is matched,
the gateway stores the incoming URI so it can be accessed by the application.
The inbound dial peer can be configured to match the entire TEL URL pattern, the E.164 number portion,
or the phone context of the TEL URL. This example uses the phone number and phone context for
matching. The incoming call matches on dial peer 767, which is configured with the incoming uri called
command to match on voice class 767. Voice class 767 is configured to match the incoming called URL
with the header of
tel:555-0100;phone-context=408;tsp=example.com;Subject=HelloTelVXML;[email protected];
From=nobody;Priority=urgent'+';AccountInfo='+acctInfo.
When the call is handed to the application configured in the inbound dial peer, get_headers_vxml, this
VoiceXML application can read any header which is part of the incoming called URI received in the
setup indication.
!
version x.x
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
service internal
!
hostname as5300-09
!
enable secret 5 $1$KRsb$cFAQFOylLr9j5Fof.eLgx1
enable password lab
!
!
!
resource-pool disable
clock timezone PDT -8
clock calendar-valid
!
ip subnet-zero
no ip domain lookup
ip domain name fieldlabs.example.com
ip host dcl1server 10.7.108.2
ip host px1-sun 10.14.99.1
ip host dirt 192.168.254.254
ip host jurai 192.168.254.254
ip host dclserver 10.7.108.2
ip host dcl2server 10.7.112.2
ip host ts 10.7.100.1
!
!
isdn switch-type primary-5ess
isdn voice-call-failure 0
!
!
voice service voip
sip
header-passing
!
!
voice class uri 766 sip
pattern [email protected]*
!
voice class uri 767 tel
phone number 767....
phone context 408
!
!
!
!
!
no voice hpi capture buffer
no voice hpi capture destination
!
!
ivr record memory system 100000
ivr record memory session 100000
ivr record memory system 100000
ivr record memory session 100000
fax interface-type modem
mta receive maximum-recipients 0
!
controller T1 0
framing esf
clock source line primary
linecode b8zs
pri-group timeslots 1-24
!
controller T1 1
framing sf
clock source line secondary 1
linecode ami
!
controller T1 2
framing sf
linecode ami
!
controller T1 3
framing sf
linecode ami
!
!
!
interface Ethernet0
ip address 209.165.200.225 255.255.255.224
ip helper-address 192.168.254.254
no ip route-cache
no ip mroute-cache
no cdp enable
!
interface Serial0:23
no ip address
dialer-group 1
isdn switch-type primary-5ess
isdn incoming-voice modem
fair-queue 64 256 0
no cdp enable
!
interface FastEthernet0
ip address 209.165.201.28 255.255.255.224
no ip route-cache
no ip mroute-cache
duplex half
speed 10
no cdp enable
!
ip default-gateway 10.7.0.1
ip classless
ip route 209.168.201.1 255.255.255.224 10.165.196.1
ip route 209.168.201.5 255.255.255.224 10.165.0.1
no ip http server
ip pim bidir-enable
!
!
no cdp run
!
!
call rsvp-sync
!
application
service get_headers_tcl tftp://dev/demo/TCL/scripts/get_headers.tcl
paramspace english language en
paramspace english index 1
paramspace english location tftp://dirt/cchiu/AUDIO/en/
!
service voice get_headers_vxml tftp://dev/demo/VXML/scripts/get_headers.vxml
paramspace english language en
paramspace english index 1
paramspace english location tftp://dirt/cchiu/AUDIO/en/
!
!
voice-port 0:D
!
mgcp ip qos dscp cs5 media
mgcp ip qos dscp cs3 signaling
!
mgcp profile default
!
dial-peer cor custom
!
!
!
dial-peer voice 1 pots
service test
incoming called-number 52950
port 0:D
!
dial-peer voice 767 voip
service get_headers_vxml
session target ipv4:10.0.0.1
incoming uri called 767
codec g711ulaw
!
dial-peer voice 766 voip
service get_headers_tcl
session protocol sipv2
session target ipv4:10.0.0.0
incoming uri request 766
codec g711ulaw
!
dial-peer voice 2 pots
destination-pattern 767....
port 0:D
prefix 9767
!
sip-ua
!
!
line con 0
exec-timeout 0 0
logging synchronous
line aux 0
line vty 0 4
password lab
login
!
scheduler interval 1000
end
Where to Go Next
• To configure properties for audio files, see “Configuring Audio File Properties for Tcl and
VoiceXML Applications”.
• To configure voice recording using a VoiceXML application, see “Configuring VoiceXML Voice
Store and Forward”.
• To configure properties for speech recognition or speech synthesis, see “Configuring ASR and TTS
Properties”.
• To configure a VoiceXML fax detection application, see “Configuring Fax Detection for
VoiceXML”.
• To configure telephony call-redirect features for voice applications, see “Configuring Telephony
Call-Redirect Features”.
• To configure session interaction for a Tcl IVR 2.0 application, see “Configuring Tcl IVR 2.0 Session
Interaction”.
• To monitor and troubleshoot voice applications, see “Monitoring and Troubleshooting Voice
Applications”.
Additional References
Related Documents
Related Topic Document Title
Cisco IOS commands Cisco IOS Master Commands List, All Releases
Cisco IOS Voice commands Cisco IOS Voice Command Reference
Overview of Cisco Tcl IVR and VoiceXML Cisco IOS Tcl IVR and VoiceXML Application Guide
Applications
MIBs
MIB MIBs Link
• CISCO-VOICE-DIAL-CONTROL-MIB To locate and download MIBs for selected platforms, Cisco software
releases, and feature sets, use Cisco MIB Locator found at the
• CISCO-VOICE-DNIS-MIB
following URL:
http://www.cisco.com/go/mibs
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/cisco/web/support/index.html
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.
Note Table 11-1 lists only the software release that introduced support for a given feature in a given software
release train. Unless noted otherwise, subsequent releases of that software release train also support that
feature.
Table 11-1 Feature Information for Configuring SIP and TEL URL Support
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 and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any
examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only.
Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.