Inter-CUCM SIP Trunk Service Transparency for
MWI, KPML, and COLP Feature Module
Document Release History
Publication Date
Comments
August 23, 2010
Initial release of document.
Feature History
Release
Modification
9.8(1)
The Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and
COLP feature was introduced on the Cisco PGW 2200 Softswitch
software.
This document describes the Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP
feature. This feature is described in the following sections:
•
Feature Description, page 2
•
Supported Standards, MIBs, and RFCs, page 4
•
Provisioning Tasks, page 4
•
Provisioning Examples, page 5
•
Software Changes for This Feature, page 7
•
Obtaining Documentation and Submitting a Service Request, page 8
•
Glossary, page 8
Americas Headquarters:
Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Feature Description
Feature Description
The Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP feature enables the
Cisco PGW 2200 Softswitch to handle out of dialog and in dialog SUBSCRIBE and NOTIFY messages,
in addition to the existing support for INVITE message. With this feature, Cisco PGW 2200 Softswitch
can transparently transit the following information in Back to Back User Agent (B2BUA) mode:
•
Message Waiting Indication (MWI) Status via Unsolicited NOTIFY
•
In-Dialog Key Press Stimulus package (KPML) requests
•
Connected Line Presentation (COLP)
The details of these messages are described in the following sections.
Message Waiting Indication
This feature enables the Cisco PGW 2200 Softswitch to interwork with Cisco Unity, which sends
voicemail MWI by unsolicited NOTIFY. With this feature, Cisco PGW 2200 Softswitch with Cisco
Unity via Cisco Unified Call Manager (CUCM) can relay unsolicited MWI information and the
responses in MWI flows. These responses include:
Note
•
200 Ok
•
202 Accepted
•
403 Forbidden
•
404 Not Found
•
480 Temporarily Unavailable
•
489 Bad Event
•
503 Service Unavailable
The Cisco PGW 2200 Softswitch does not parse the message contents, and allows the message-summary
event that is sent by CUCM.
The Cisco PGW 2200 Softswitch performs the following actions to support the MWI status relaying:
•
Sends unsolicited NOTIFY based on configured routing mechanism that is using either the
configured dial plan or domain based routing.
•
Does not maintain any dialog for unsolicited NOTIFY, and deletes the context as soon as the
Cisco PGW 2200 Softswitch receives the final response.
•
Waits only for Timer E to get a final response, and then clears the context information.
SIP Key Press Stimulus Package
The Cisco PGW 2200 Softswitch supports SIP messaging for Dual Tone Multi-Frequency (DTMF). It
takes place between a Signaling Connection Control Part (SCCP) phone hosted by a CUCM and a SIP
gateway via a SIP trunk. DTMF support is implemented by the bidirectional subscriptions for DTMF
notification between the CUCM and the SIP gateway. NOTIFY messages are exchanged when a digit is
pressed from the called and calling party phones. After the call is released, the CUCM and the SIP
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
2
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Feature Description
gateway terminate both local and remote KPML subscriptions. The CUCM sends a 489–Bad Event
message to the Cisco PGW 2200 Softswitch, or receives the same message from the
Cisco PGW 2200 Softswitch.
The Cisco PGW 2200 Softswitch relays KPML payload (in XML form) in SIP messages
SUBSCRIBE/NOTIFY in B2BUA mode. These KPML requests are passed in-dialog. The
Cisco PGW 2200 Softswitch is also able to relay the responses possible in KPML flows, such as
•
200 Ok
•
480 Temporarily Unavailable
•
404 Not Found
•
503 Service Unavailable
•
403 Forbidden
•
481 Subscription does not exist
•
489 Bad Event, and
•
202 Accepted
Cisco PGW 2200 Softswitch does not parse the message contents and allows KPML event.
Connected Line Presentation
Connected Line Presentation (COLP) is a service that provides caller with the identity to which he
connected. For example, if someone dials 01234 567890, and the call is diverted to another number.
COLP provides the identity of the person that is actually connected to. The identity is typically the
telephone number of the connected party.
This feature enables the Cisco PGW 2200 Softswitch to send PAID and Remote-Party-ID headers of
UPDATE in B2BUA mode. The Cisco PGW 2200 Softswitch relays display name and user part of the
URI in PAID and Remote-Party-ID headers in SIP messages UPDATE,180 Ringing, and 200 OK.
Benefits
This feature provides the following benefit:
•
Enables transparent relaying of MWI, KPML, and COLP.
Prerequisites
The Cisco PGW 2200 Softswitch must be running software Release 9.8(1). Prerequisites for this release
can be found in Release Notes for the Cisco PGW 2200 Softswitch Release 9.8(1) at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/release/note/rn981.html
Restrictions or Limitations
The Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP feature has the following
limitations:
•
Cisco PGW 2200 Softswitch complies only with the call flows described in CUCM Release 8.0 Sip
Trunk Message Guides.
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
3
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Provisioning Tasks
•
Cisco PGW 2200 Softswitch does not support out of dialog REGISTER, MESSAGE, and
PUBLISH.
•
Each out of dialog SUBSCRIBE/NOTIFY will be considered as a call, which is complied with the
Call Admission Control mechanism. There is no change in billing interface.
•
Cisco PGW 2200 Softswitch checkpoints in-dialog SUBSCRIBE/NOTIFY requests, so KPML
sessions should persist across failover. Out of dialog SUBSCRIBE/NOTIFY will not be
checkpointed. However, if the correct routing mechanism is configured, out of dialog
SUBSCRIBE/NOTIFY is still transparently passed to the other side. Because the dialog is not
maintained, and the Cisco PGW 2200 Softswitch works only on configured routing mechanism.
Related Features and Technology
The following feature is related to this feature:
•
MLPP Support for ISUP and SIP Interworking and SIP to SIP Transparency
Related Documents
This document contains information that is strictly related to this feature. The documents that contain
additional information related to the Cisco PGW 2200 Softswitch are at:
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html
Supported Standards, MIBs, and RFCs
This section identifies the new or modified standards, MIBs, and RFCs that are supported by this feature.
Standards
No new or modified standards are supported by this feature.
MIBs
No new or modified MIBs are supported by this feature.
For more information on the MIBs used in the Cisco PGW 2200 Softswitch, see
Cisco PGW 2200 Softswitch MIBs at:
http://www.cisco.com/iam/PGW_MIBS/index.html
RFCs
No new or modified RFCs are supported by this feature.
Provisioning Tasks
This section describes provisioning tasks for this feature.
To use this feature, you need to perform the following main tasks:
•
Enable the Support of MWI
•
Enable the Support of KPML
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
4
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Provisioning Examples
For the complete provisioning examples, see the “Provisioning Examples” section on page 5.
Enable the Support of MWI
The MWI support feature uses default SIP trunk provisioning. There is no new property added for it.
Enable the Support of KPML
A new SIP profile property, supportKPML, was introduced on this feature. It specifies whether the
Cisco PGW 2200 Softswitch relays the KPML information received in the SIP message from ingress
trunk.
Use the following commands to provision the supportKPML property:
mml> prov-add:profile:name="sip-prof1",type="SIPPROFILE",custgrpid="1111",
mgcdomain="10.78.170.30"
mml> prov-ed:profile:name="sip-prof1",supportKPML="1",subscribenotifysupport="1",
trustlevel="0",unsolicitednotifymethod="1"
Provisioning Examples
This section provides provisioning examples for this feature. Additional provisioning examples for the
Cisco PGW 2200 Softswitch can be found in Cisco PGW 2200 Softswitch Release 9.8 Provisioning
Guide. Additional dial plan examples for the Cisco PGW 2200 Softswitch can be found in
Cisco PGW 2200 Softswitch Release 9.8 Dial Plan Guide.
Provisioning Example of MWI Support
This section provides a provisioning example for the MWI support feature.
________________________________________
; Start a New Provisioning Session
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-sta::srcver="new",dstver="mwi-prov"
________________________________________
; Add a new dialplan named "1111"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:dialplan:custgrpid="1111", OVERDEC="NO"
________________________________________
; Add a SIP Signaling Path
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:SIPPATH:NAME="sip-path",DESC="SIPsigpath",MDO="IETF_SIP",ORIGLABEL="",
TERMLABEL=""
prov-add:SIPLNK:NAME="sip-link1",DESC="SIPlink",SVC="sip-path",IPADDR="IP_Addr1",
PORT=5060,PRI=1
prov-add:trnkgrp:name="100",clli="sipin-path",svc="sip-path",type="SIP_IN",selseq="LIDL",
qable="N",default=1
prov-add:PROFILE:NAME="sip-prof1",TYPE="sipprofile",custgrpid="1111",mgcdomain="10.0.3.7"
prov-add:trnkgrpprof:name="100",profile="sip-prof1"
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
5
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Provisioning Examples
________________________________________
; Add SIP Trunk Groups
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:trnkgrp:name="235",clli="sip-path",svc="sip-path",type="IP_SIP",selseq="LIDL",
qable="N"
prov-add:trnkgrpprof:name="235",profile="sip-prof1"
prov-add:siprttrnkgrp:name="235",url="10.0.2.182",srvrr=0,sipproxyport=5060,version="2.0",
cutthrough=1,extsupport=1,domainbasedrtgsupport=0
prov-add:rttrnk:weightedTG="OFF",name="rg235",trnkgrpnum=235
prov-add:rtlist:name="rlst235",rtname="rg235",distrib="OFF"
________________________________________
; Dial plan routing to SIP side
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:resultset:custgrpid="1111",name="rset235"
numan-add:resulttable:custgrpid="1111",name="rtab235",resulttype="ROUTE",dw1="rlst235",
setname="rset235"
numan-add:bdigtree:custgrpid="1111",callside="originating",digitstring="235",
setname="rset235"
________________________________________
; Save the Provisioning Session
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-dply
Provisioning Example of KPML Support
This section provides a provisioning example for the KPML support feature.
________________________________________
; Start a New Provisioning Session
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-sta::srcver="new",dstver="kpml-prov"
________________________________________
; Add a new dialplan named "1111"
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:dialplan:custgrpid="1111", OVERDEC="NO"
________________________________________
; Add a SIP Signaling Path
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:SIPPATH:NAME="sip-path",DESC="SIPsigpath",MDO="IETF_SIP",ORIGLABEL="",
TERMLABEL=""
prov-add:SIPLNK:NAME="sip-link1",DESC="SIPlink",SVC="sip-path",IPADDR="IP_Addr1",
PORT=5060,PRI=1
prov-add:trnkgrp:name="100",clli="sipin-path",svc="sip-path",type="SIP_IN",selseq="LIDL",
qable="N",default=1
prov-add:PROFILE:NAME="sip-prof1",TYPE="sipprofile",custgrpid="1111",mgcdomain="10.0.3.7",
subscribenotifysupport="1",supportkpml="1",trustlevel="0",unsolicitednotifymethod="1"
prov-add:trnkgrpprof:name="100",profile="sip-prof1"
________________________________________
; Add SIP Trunk Groups
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-add:trnkgrp:name="235",clli="sip-path",svc="sip-path",type="IP_SIP",selseq="LIDL",
qable="N"
prov-add:trnkgrpprof:name="235",profile="sip-prof1"
prov-add:siprttrnkgrp:name="235",url="10.0.2.182",srvrr=0,sipproxyport=5060,version="2.0",
cutthrough=1,extsupport=1,domainbasedrtgsupport=0
prov-add:rttrnk:weightedTG="OFF",name="rg235",trnkgrpnum=235
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
6
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Software Changes for This Feature
prov-add:rtlist:name="rlst235",rtname="rg235",distrib="OFF"
________________________________________
; Dial plan routing to SIP side
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
numan-add:resultset:custgrpid="1111",name="rset235"
numan-add:resulttable:custgrpid="1111",name="rtab235",resulttype="ROUTE",dw1="rlst235",
setname="rset235"
numan-add:bdigtree:custgrpid="1111",callside="originating",digitstring="235",
setname="rset235"
________________________________________
; Save the Provisioning Session
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
prov-dply
Software Changes for This Feature
The following section contains software changes related to this feature:
•
Properties, page 7
Properties
This section describes the new property for this feature. For more information on the other properties,
see Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
New Properties
Table 1 describes the new property for this feature.
Table 1
New Property for the Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and
COLP Feature
Property
Description
supportKPML
SIP profile property. Indicates whether the Cisco PGW 2200 Softswitch relays or
ignores the KPML information received in SIP message on the ingress SIP Trunk.
Also, indicates whether KPML information received from ingress trunk shall be
relayed or ignored on the egress SIP trunk.
Valid values:
•
0—KPML information is relayed
•
1—KPML information is ignored
Default value: 0.
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
7
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
Obtaining Documentation and Submitting a Service Request
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed
and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free
service and Cisco currently supports RSS Version 2.0.
Glossary
Table 2
Expansions
Acronym
Expansion
B2BUA
Back to Back User Agent
COLP
Connected Line Presentation
CUCM
Cisco Unified Call Manager
DTMF
Dual Tone Multi-Frequency
ISUP
ISDN User Part
KPML
SIP Key Press Stimulus package
MML
Man-Machine Language
MWI
Message Waiting Indication
PGW
PSTN Gateway
SCCP
Signaling Connection Control Part
SIP
Session Initiation Protocol
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.
© 2010 Cisco Systems, Inc. All rights reserved.
Inter-CUCM SIP Trunk Service Transparency for MWI, KPML, and COLP Feature Module
8