Professional Documents
Culture Documents
Version 2.4
Abstract
This document contains instructions for installing and configuring SIP functionality on your 2.4 CIC or
EIC Server. Please note: This is a work in progress. IC 2.4 functionality will replace existing
IC 2.3 functionality.
This document applies to one or more Interactive Intelligence and/or Vonexus products. Vonexus is a
wholly owned subsidiary of Interactive Intelligence.
Copyright and Trademark Information
©1994 – 2005 Interactive Intelligence Inc./ Vonexus Inc. All rights reserved. Vonexus is a wholly-owned subsidiary
of Interactive Intelligence Inc. Interactive Intelligence®, Interaction Center Platform®, Communité®, Enterprise
Interaction Center®, Interactive Intelligence Customer Interaction Center®, e-FAQ®, e-FAQ Knowledge Manager,
Interaction Dialer®, Interaction Director®, Interaction Marquee, Interaction Recorder®, Interaction SIP Proxy,
Interaction Supervisor, Interaction Tracker, Mobilité®, Vocalité®, Interaction Administrator®, Interaction
Attendant®, Interaction Client®, Interaction Designer®, Interaction Fax Viewer, Interaction FAQ, Interaction
Melder, Interaction Screen Recorder, Interaction Scripter®, Interaction Server, Wireless Interaction Client,
InteractiveLease®, and the “Spirograph” logo design® are all trademarks or registered trademarks of Interactive
Intelligence Inc.
veryPDF is Copyright © 2000-2005 by veryPDF, Inc. Other brand and/or product names referenced in this
document are the trademarks or registered trademarks of their respective companies.
Interactive Intelligence Inc.
7601 Interactive Way
Indianapolis, Indiana 46278
Telephone/Fax (317) 872-3000
www.ININ.com
Vonexus
7601 Interactive Way
Indianapolis, Indiana 46278
Telephone/Fax (888) 817-5904
www.vonexus.com
DISCLAIMER
INTERACTIVE INTELLIGENCE (INTERACTIVE) HAS NO RESPONSIBILITY UNDER WARRANTY, INDEMNIFICATION OR
OTHERWISE, FOR MODIFICATION OR CUSTOMIZATION OF ANY INTERACTIVE SOFTWARE BY INTERACTIVE,
CUSTOMER OR ANY THIRD PARTY EVEN IF SUCH CUSTOMIZATION AND/OR MODIFICATION IS DONE USING
INTERACTIVE TOOLS, TRAINING OR METHODS DOCUMENTED BY INTERACTIVE.
Change Date
4 Known Issues
Description Double digit detected on last digit of an internal call. Also, the last digit dialed might be taken as
the first digit when in the auto attendant.
Workaround None
Affected IC 2.4 GA
Fixed TBA
Hotfixes None
Product General
Description Some SIP devices do not support delayed media which is used, by default, for outbound calls
from the Interaction Center.
Symptom Calls initiated from an IC client fail to connect, are immediately disconnected or have one-way
Workaround Change the default behavior from delayed media to normal media on the Interaction Center by
checking the Disable Delayed Media checkbox on the SIP line, SIP station, and/or the global SIP
station containers.
Affected IC 2.4 GA
Issue Microsoft RTC DLL will not receive the first 8-12 seconds of audio.
Product Microsoft RTC DLL, which is used by the audio-enable Interaction Client (i.e. the Interaction Client
using the /mssipaudio flag)
Description When using the IC client as a soft phone, the first 8 to 12 seconds of audio (directed to the
Microsoft RTC DLL) is ignored by the Microsoft RTC. This occurs when the call is setup or an
advanced feature is performed on it, such as a record or hold operation. The IC client soft phone
uses Microsoft’s RTC library, which has a delay when moving audio streams.
Symptom 8 to 12 seconds of audio (to the Microsoft RTC DLL) is missing when a call is setup or an
advanced feature is performed, such as a record or hold operation.
Workaround Change the Audio Flow configuration from Dynamic to Always In on the SIP station and/or SIP
global station containers.
Fixed
Issue Microsoft RTC DLL causes audio delay on long phone calls.
Product Microsoft RTC DLL, which is used by the audio-enable Interaction Client (i.e. the Interaction Client
using the /mssipaudio flag)
Description When using the IC client as a soft phone, audio (to the Microsoft RTC DLL) can be delayed by 2 to
3 seconds on long phone calls.
Symptom As the call progresses, the clock drift on the RTP packets drifts, and the TRC RTP stack delays
audio to the USB device.
Workaround Change the Voice Activation Detection (VAD) checkbox to checked (ON). in the SIP station and/or
SIP global station containers. Note that using VAD could cause audio problems (first spoken
word could be truncated.
Fixed
Issue Microsoft RTC DLL changes port number on every audio change.
Product Microsoft RTC DLL, which is used by the audio-enable Interaction Client (i.e. the Interaction Client
using the /mssipaudio flag)
Description When using the IC client as a soft phone, audio (to the Microsoft RTC DLL) changes ports when
Symptom Interactive Intelligence SIP loop detect will disconnect the call.
Workaround Change the Audio Flow configuration from Dynamic to Always In on the SIP station and/or SIP
global station containers.
Issue Cisco ATA 18x device ddoes not respond to SIP OPTIONS messages.
Description Cisco ATA 18x devices does not respond to SIP OPTIONS messages.
Workaround Uncheck the Use Session Timers checkbox in the SIP station and/or SIP global station container.
Affected IC 2.3
Fixed
Issue IC Client soft phone users hear buzz when answering calls
Description IC client soft phone users that use an ActionTec device may experience a buzz heard by the
remote caller when the phone plugged into the ActionTec goes off-hook.
Symptom Remote caller hears buzz when ActionTec user goes off-hook.
Workaround None
5 Glossary of Terms
Term Description
Managed SIP phone that is configured as a SIP station in the Interaction Center. A SIP station is configured
phone in the Stations page of Interaction Administrator
6 Introduction
With SIP (Session Initiation Protocol) being the emerging standard now used for call routing, state
functions and control within IP Networks, Interactive Intelligence now offers interoperability with SIP-
based solutions. As an open software solution, the Interactive Intelligence product line was designed
as a flexible and affordable alternative to traditional telecom solutions. With support for SIP,
Interactive Intelligence is excited to leverage it’s proven Interaction Center Platform to contact
centers, enterprises, e-businesses and service providers that wish to take advantage of the benefits a
converged network provides.
Although SIP-based soft-switches provide an excellent answer for next generation call transport over
packet networks, they still lack the compelling applications that will drive the level of acceptance that
their unique offerings strive to achieve. For example, capabilities as simple as voice mail and music
on-hold are not available. Interaction Center Platform answers this shortcoming by not only adding
these, but many more.
• SIP Topology and Call Flows Application Note. High level view of the topologies and flows of a
SIP enabled network.
• SIP 3rd Party Component Application Note. How to configure different proxies, gateways, and
phones.
6.2 Standards
RFC 2327 Session Description Protocol Description of the session within the SIP messages
RFC 2617 Basic and Digest Access Only Digest Access Authentication is supported. Basic
Authentication Access has been deprecated by RFC3261 (SIP) and is
not supported.
RFC 3265 SIP Specific Event Notification This document describes an extension to SIP. The
purpose of this extension is to provide an extensible
framework by which SIP nodes can request notification
from remote nodes indicating that certain events have
occurred. (SUBSCRIBE/NOTIFY)
RFC 3515 SIP REFER Method This document describes the REFER method that’s
most commonly used for call transfer operations.
RFC 3389 RTP Payload for Comfort Noise (CN) This document describes a Real-time Transport
Protocol (RTP) payload format for transporting comfort
noise (CN). The CN payload type is primarily for use
with audio codecs that do not support comfort noise as
part of the codec itself such as ITU-T
Recommendations G.711 and G.726.
RFC 3428 SIP Extension for Instant Messaging This document describes the MESSAGE method, an
extension to the SIP that allows the transfer of Instant
Messages. Interaction Center only supports
generating MESSAGE requests.
RFC 3581 An Extension to SIP for Symmetric This document describes symmetric response routing.
Response Routing When used with UDP, responses to requests are
returned to the source address the request came from,
and to the port written into the topmost Via header
field value of the request. This helps UDP packets
traverse firewalls.
RFC 3842 A Message Summary and Message This document describes a SIP event package to carry
Waiting Indication Event Package for SIP message waiting status and message summaries from
a messaging system. MWI using SUBSCRIBE/NOTIFY.
RFC 3891 SIP Replaces Header This document describes the Replaces header that can
be used to direct a called party to replace an existing
session with this one. It’s commonly used with REFER
for consult transfers.
RFC 3911 SIP JOIN Header This document describes the JOIN header. Interaction
Center accepts JOIN requests as a mechanism to setup
conferences from SIP phones.
draft-ietf-sip-service-examples-03 Hold
6.2.4 Why has RFC 2543 been replaced with RFC 3261?
RFC 2543 has been deprecated and has been replaced by RFC3261. The new RFC clarifies and
resolves issues and mistakes made in RFC 2543. In addition to clarification, the text is much easier to
read and introduces a model for stateful transactions. On the technical side there have been a number
of changes including:
• TLS and S/MIME have been introduced and PGP removed
• Loose routing has been added to record routing which greatly increase the utility of record
routing
• Server location can be done with NAPTR records
• The syntax has been converted to ABNF and so can be checked automatically by standard tools
Due to these changes and others, the new RFC document is also “Standards Track” (The same rung on
the IETF standards ladder as RFC 2543.) It is proposed that once the new RFC has had time to be
implemented and tested, work will be carried out to advance SIP to “Proposed Standard” via a new
RFC.
RFC3261 is completely backward compatible with RFC2543.
The following table shows the significant IP address and port numbers used by the Interaction Center
application.
SIP over UDP IP Address of the system’s NIC Default is 5060. This is configurable on the
(Network Interface Card) SIP Line container in Interaction
Administrator.
SIP over TCP IP Address of the system’s NIC Default is 5060. This is configurable on the
(Network Interface Card) SIP Line container in Interaction
Administrator.
RTP For the hardware platforms, the IP AudioCodes the first RTP session will use port
Address of the IP telephony board.. 4000 (configurable, see section 17.9
“Configuring the AudioCodes Boards with
For software platforms (HMP), the IP Interaction Administrator”). The second RTP
Address of the system’s NIC (Network session will start at an even port interval
Interface Card) number 10 higher than 4000. For example, if
the starting port was 4000, then the first IP
resource will consume 4000 (for RTP), 4001
(for RTCP) and 4002 (for T.38 fax). The next
RTCP For the hardware platforms, the IP This will always be one higher than the port
Address of the IP telephony board. number used for its RTP session.
For software platforms (HMP), the IP
Address of the system’s NIC (Network
Interface Card)
Q. What differences are there between a SIP version of the Interaction Center and a
TAPI version?
TAPI vs. SIP comparison TAPI Interaction Interaction Center with SIP
Center capabilities
Can the Interaction Center system be No. Yes. SIP was added to the same
mixed with traditional connections via telephony servces component
telephony boards, such as analog that handles all our existing
phones and ISDN trunks? protocols and boards.
Hardware – do all the gateways, Yes. We have a single No. Multi vendor solutions are
routers, and phones have to be from vendor dependency on used. We have certified phones
Cisco? Cisco. This typically leads from Polycom and gateways from
to higher cost equipment. AudioCodes. Our system can
work with any certified SIP
compliant gateway or phone.
Application Yes.
Q. What features do you lose using a SIP IP phone compared to an analog phone?
A. None. In fact, you gain features by using a SIP phone. SIP phones can send SIP compliant
messages hold, transfer, and conference calls. The following table shows some of the
advantages of a SIP phone over a traditional analog phone.
Must be locally connected to the Can sit anywhere on the LAN or WAN.
server or to a channel bank.
Flash is used to hold or bring up a Some IP phones have buttons to do hold, transfer,
voice menu to do features like conference,…
conference and transfer.
Q. What features do you lose using a SIP gateway compared to bringing analog or
digital trunks directly into the Interaction Center?
A. None. The Interaction Center server will “talk” SIP to the gateway, and the gateway then
connects to WANs (frame relay,...) or the PSTN (T1, E1, ISDN, Analog). Even features like
recording, call monitoring, call analysis are available over SIP.
Q. What type of integration do you do with SIP phones? What happens when I hit the
hold button on the phone?
A. The integration is very complete. The second you hit the hold button on the phone, the call
transitions to the held state, the call will show “On Hold” on the Interaction Client, and the
remote user will hear hold music.
Q. I want the Call Center Agents for my company to be able to use an IP phone with a
headset, is there any special configuration I need to perform?
A. If a call center agent is using an IP phone with a headset and using the Interaction Client, the
“Persistent” checkbox needs to be selected for the agent’s Station in Interaction Administrator.
See section 20 “Defining Global Configurations for SIP Stations” about configuring Persistent
connections.
Vo IP Audio (RTP)
IP Cards
Gateway/Routers
Telepho ny Bus
WAN
7.2.1 When is a SIP proxy needed for the SIP phones I’m using?
Q. The network has both a primary and a backup Interaction Center. Is a SIP proxy
required?
A. A proxy may be required, depending on the capabilities of the SIP phones. Check the phone’s
“Backup Proxy” capability in the SIP 3rd Party Component Feature Matrix spreadsheet. If
“Backup Proxy” is “Yes” then the phone doesn’t require a SIP proxy. If “Backup Proxy” is “No”,
then a SIP proxy will be needed if the user is dialing from the phone. Note: If the user is
dialing from the Interaction Client, no SIP proxy is needed. Why? Because when the IC
Client makes a call, it sends a proprietary request to the Interaction Center server, which will
place a call to the phone. The phone does not make any routing decisions.
Q. I have a phone in a remote site with a remote gateway. I want emergency calls
and/or local calls to go immediately out the gateway. Is a SIP proxy required?
A. A proxy may be required, depending on the capabilities of the SIP phones. Check the phone’s
“Dial Plan Routing” capability in the SIP 3rd Party Component Feature Matrix spreadsheet. If
“Dial Plan Routing” is “Yes”, then no proxy is needed to do this routing. If “Dial Plan Routing”
is “No”, then a SIP proxy will be needed if the user is dialing from the phone. Note: If the
user is dialing from the Interaction Client, no SIP proxy is needed, but the Interaction Center’s
dial plan needs to be configured to route the calls to the local gateway.
Q. The network has both a primary Interaction Center and a local gateway to be used
when the primary Interaction Center is unreachable (no backup Interaction Center is
used)? Is a SIP proxy required?
A. A proxy may be required, depending on the capabilities of the SIP phones. Check the phone’s
“Backup Proxy” capability in the SIP 3rd Party Component Feature Matrix spreadsheet. If
“Backup Proxy” is “Yes” then the phone doesn’t require a SIP proxy. If “Backup Proxy” is “No”,
then a SIP proxy will be needed if the user is dialing from the phone.
7.2.3 When is a SIP proxy needed for the gateways I’m using?
The same rules apply for the gateways as for the phones.
Interaction Center
SIP
PSTN / WAN LAN
3
SIP
4 PSTN / WAN LAN
Are Telephony Tradition ISDN (or Tradition ISDN (or Optional. With Optional. With
boards needed? T1, E1, Analog) T1, E1, Analog) the hardware the hardware
telephony boards telephony boards platform platform
are used to are used to (telephony (telephony
connect to the connect to the boards), IP boards boards), IP boards
PSTN. gateway. are used to do the are used to do the
do the RTP and do the RTP and
transcoding. transcoding.
With the software With the software
platform (Intel platform (Intel
HMP), HMP),
For switchover Yes. The Yes. The No. All No. All
(primary and traditional traditional connections to the connections to the
backup IC connections (such connections (such IC server are done IC server are done
servers), is a data as ISDN) go as ISDN) go via SIP. With SIP, via SIP. With SIP,
probe needed to through the data through the data the switchover the switchover
route the digital probe, which probe, which routing is done routing is done
lines? routes the routes the over the LAN. over the LAN.
connections to the connections to the
appropriate appropriate
server. server.
N+1 Configuration The calls are The calls are The calls are The calls are
(multiple IC distributed, by the distributed, by the distributed, by the distributed, by the
servers) PSTN, across the gateways, across gateways, across PSTN, across the
IC servers, by the IC servers, by the IC servers, IC servers, simply
sending the call to sending the call to simply by sending by sending the SIP
different ISDN different ISDN the SIP messages messages to
trunks. trunks. to different IP different IP
addresses. addresses.
1
2 SIP Co mpliant Soft
Analog Phones
Phones with or
without Interaction
IP WAN
Client
1 2 3
IP Phones SIP Phone Media Gateways Analog Phones
Is SIP used to Yes. Yes. The IC server communicates No. Tradition T1/E1
communicate to the with the Phone Media Gateway with boards for channel banks,
phones SIP. The Phone Media Gateway or analog station boards
then communicates with the phone are used to connect to
the same way a traditional channel analog stations.
bank does.
Are resources used No. IP resources are No. IP resources are only used when Yes. The phone uses a
when phone is idle? only used when there is a voice connection. physical resource even
there is a voice when it is idle.
connection.
Does the phone No. The SIP hard or No. The Phone Media Gateway is Yes. The phone has a
have to be directly SIP soft phones are simply an IP device anywhere on the physical connection to the
connected to IC simply IP devices network (LAN or WAN). IC server.
server? anywhere on the
network (LAN or
WAN).
Phone Types Many vendors make Standard analog phones (2500 sets) Standard analog phones
supported SIP hard and SIP and PBX digital phones can be (2500 sets).
soft phones. connected to a wide variety of Phone
Media Gateways.
Not shown: Every remote site requires backup central site connectivity.
Outbound: The phone at the remote site can not reach the Cisco CallManagers at the central
site. It will then send the outbound call request to SRST capable router running at its remote
site. The SRST capable router will route the call according to its configuration, typically
using the router’s own connection to the PSTN.
Inbound: An inbound call is received by the a gateway at the remote site and the gateway can
not reach the Cisco CallManagers at the central site. It will then send the call to a SRST
capable router running at its remote site. The SRST capable router will route the call
according to its configuration, typically to a phone at the remote site.
Central Site
with Remote Site
Interactive WAN
Intelligence’s LAN
Interaction
Centers
PSTN
SIP capable SRST
SIP Proxy (optional)
Cisco Router
Not shown: Every remote site requires backup central site connectivity.
Outbound: The phone at the remote site can not reach the Interaction Center Server at the
central site. It will then send the outbound call request to SRST capable router running at its
remote site. The SRST capable router will route the call according to its configuration,
typically using the router’s own connection to the PSTN.
Inbound: An inbound call is received by the a gateway at the remote site and the gateway can
not reach the Interaction Center Server at the central site. The gateway (a SRST capable
router) will route the call according to its configuration, typically to a phone at the remote site.
Again, using SIP provides the flexibility of equipment and vendors. Even Cisco’s routers support SIP.
PSTN
SIP Router SIP Proxy (optional)
Not shown: Every remote site requires backup central site connectivity.
Outbound: The phone at the remote site can not reach the Interaction Centers at the central
site. It will then send the SIP outbound call request to a SIP capable router running at its
remote site. The SIP capable router will route the call according to its configuration,
typically using the router’s own connection to the PSTN. Note that if the phone is not
capable of making routing decisions based on unreachable systems, then either a router (which
could do all the SIP routing decisions with its dial plan) or a SIP proxy is needed at the remote
site.
Inbound: An inbound call is received by the gateway at the remote site and the gateway can
not reach the Interaction Centers at the central site. It will then send the call to a SIP capable
router running at its remote site. The SIP capable router will route the call according to its
configuration, typically to a phone at the remote site. Note that if the router is not capable of
routing decisions based off of unreachable systems, then a SIP proxy is needed at the remote
site.
Central Site
with Remote Site
Interactive
Intelligence’s WAN
Interaction LAN
Centers
PSTN
SIP Router SIP Proxy (optional)
Not shown: Every remote site requires backup central site connectivity.
The phone at the remote site dials 911. It will then send the SIP outbound call request to a SIP
capable router running at its remote site, rather than to the Interaction Centers at Central
Site. The SIP capable router will route the call directly to the PSTN. Note that if the phone is
not capable of making routing decisions based on unreachable systems, then either a router
(which could do all the SIP routing decisions with its dial plan) or a SIP proxy is needed at the
remote site.
When the audio is routed directly between the endpoints, no resources (besides a extremely small
amount of CPU and an extremely small amount of network traffic) are used by the IC server for the
SIP messages.
Conference button on phone: There are conference resources on some phone devices, and when the
conference button on the phone is used, the conference mixing is done on the phone itself (no
9.3 IP Resources
Each audio session (i.e. RTP session) will use an IP resource.
Examples
9.7 For complete details, see section 19.11 “Line Configuration: Access Page
Line Configuration
Granted Access | Denied Address Granted Access: By default, all IP addresses will be allowed
access to the IC server except those listed in the list below.
Denied Access: By default, all IP addresses will be denied
access to the IC server except those listed in the list below.
Access | IP Address Put the IP addresses in the list. It’s possible to enter a single IP
address or a range of IP address.
See the “IC Regionalization and Dial Plan” tech note for details of regionalization.
Host CPU Used Host CPU used 0 – no RTP Host CPU used 0 – no RTP
(external audio) for SIP comes to IC for SIP comes to IC
messaging server messaging server
processing processing
Host CPU Used Host CPU used 0 – all RTP Host CPU used Host CPU used
(internal audio) for SIP processing is for SIP for RTP
messaging done on boards messaging
processing processing
# IP resources used 0 – SIP stack 1 for every call 0 – SIP stack 1 for every call
(internal audio) does not use IP leg does not use IP leg
resources resources
Devices
• External Device A (IP phone, IP gateway,…)
• Interaction Center
IC to A Internal or OK IC will use the find the first codec in the codec list configured
External for Device A in IA that matches a codec in A’s advertised
codecs and return that codec in the OK.
Once the call’s destination is discovered (ACD agent becomes available, extension dialed, user’s name
dialed,…), IC will send the call to Device B.
Direction AudioPath SIP Message Details
IC to B Internal INVITE The INVITE contains the codec list configured for
Device A in IA and IC’s IP address and port number.
IC to A External Re-INVITE First, find which of B’s codecs are going to be used in a
calculation. The intersection of B’s advertised codecs
and B’s configured codecs will be used. We will call
this codec list L.
Send the intersection of L and A’s configured codecs.
B’s IP address and port number will also be sent.
Rules
• Devices must be SIP (i.e a SIP gateway and an IP phone; or two IP phones). An ISDN trunk
coming into the IC server will always be internal audio.
• To insure G.729 is used by remote phone, you must make that the only codec configured.
Otherwise, another codec could be used.
10.2 Echo
Cisco’s whitepaper Echo Analysis for Voice Over IP gives a very good overview for solving echo issues
in pure VoIP or hybrid VoIP environments.
RTPQoS:IPLinkResource.cpp(584):CIPResourceMgr::LogAudioCodesQoSData(): 1100092694
ACB0C18 remote report: tx packets 17293, tx octets 2766880, rx lost packets 0,
jitter (hi) 16, jitter (lo) 0, jitter (avg) 10
The data in the report consists of the following fields:
Data Definition
tx packets The total number of RTP data packets transmitted by the sender since starting
transmission.
tx octets The total number of payload octets (i.e., not including header or padding) transmitted
in RTP data packets by the sender since starting transmission
jitter (avg) An estimate (in milliseconds) of the statistical variance of the RTP data packet inter-
arrival time, measured in timestamp units and expressed as an unsigned integer. The
inter-arrival jitter J is defined to be the mean deviation (smoothed absolute value) of
the difference D in packet spacing at the receiver compared to the sender for a pair of
packets.
N/A implies this data is not available (not available with Intel/Dialogic products).
The inter-arrival jitter field provides a measure of network congestion. Packets lost tracks persistent
congestion while the jitter measure tracks transient congestion. The jitter measure may indicate
congestion before it leads to packet loss. Since the interarrival jitter field is only a snapshot of the
jitter at the time of a report, it may be necessary to analyze a number of reports within a single
network.
The packets and octets count provide a good indication of the network bandwidth requirements for the
session. They can be used to determine if the network is properly sized for the amount of voice traffic
it receives.
11 Security
Interactive Intelligence recommends using SIP access over a WAN by utilizing a VPN; opening port
5060 (the default port used for SIP) in corporate firewalls is NOT recommended since that port will
doubtless become a target of hackers as SIP becomes more ubiquitous.
Line side and station side authentication is supported. See the authentication configuration
descriptions in the line configuration (section 19.7, “Line Configuration: Authentication Page”) and in
the station configuration (section 21.7 ”Station Configuration: Authentication Page”).
(SIP). Interactive Intelligence continues to test its SIP product lines for against unauthorized
privileged access and denial of service attacks.
11.1.2 IC features
12.2 VPN
Setting up a station on the WAN connected over VPN is identical to configuring a station on the LAN.
Note that when a remote station VPNs into the network, it is given a local IP address. Since this IP
address can change on every instance of connecting over VPN, the contact address in the station
• or station logic: The call will ring the station, no voice mail.
User and station extensions must unique extensions (i.e. user extensions are different than phone
extensions). This allows users to “roam”, which means a user can be associated with any phone (by
logging in or starting a client) and his calls will follow him.
14 Inbound Logic
14.1 Diversion
A diversion header in a SIP message looks similar to this:
Diversion: <sip:5858652@siptest.wcom.com>;reason=no-answer
Notes
• If the CC_Diversion header is received, the Interaction Center treats it as equivalent to the
Diversion header
• If multiple diversion headers are received (or multiple entries in a single diversion header), the
top most header (or first entry) is the last diverted user.
The Interaction Center will set the following values:
Eic_RedirectionTn This is the number that is receiving the redirected call.
Set from the SIP message URI address.
For sip address scheme (addresses that start with “sip:”),
type and port number are added if not present in the header
(sip:user@host:port).
In the above example, Eic_RedirectionTn would be
sip:voicemail@204.180.46.185
Eic_LocalName Set from the SIP message “To” header display name
Eic_RedirectingTn This is the number that is redirecting (or diverting the call).
This attribute is set if the Diversion header is present.
Eic_UserToUserData The value in the call attribute Eic_UserToUserData will be put in the
ININAttr header in the SIP message during outbound call logic and
blind transfer logic.
Eic_UserToUserData syntax:
[name=value[;name=value]*]
Note: name and value can not contain any double quotes.
Note: name must start with uu_.
• Eic_LocalTn is compared against the IP Message Button server parameter (section 22.5
“Configuring Message Waiting Indicators (MWI)”), or
• Eic_RedirectionTn is compared against the IP Voicemail Direct server parameter (section
22.3 “Configuring Voice Mail for Non-Managed Phones”).
7. Do IP VoiceMail Direct logic (see section 22.3 “Configuring Voice Mail for Non-Managed
Phones”). This is done in SystemIncomingSIP.ihd (called from System_IncomingCall.ihd).
8. Check if the user portion (user) is an exact match for special dialing, such as “*” dialing or no
number dialing (encountered when just the “#” is entered). This is done in
System_InitiateCallRequest.ihd.
9. If none of the above match, the call will be treated like a new inbound call and be sent as
configured, probably to a main IVR.
15 Outbound Logic
When a call is made from using the Interaction Client, an audio path must be made between the SIP
phone and the Interaction Center server. The Interaction Center server will make a call to the SIP
Also, when making a call or blind transfer, call attributes can be set on the tools for MakeCall and
BlindTransfer. The following attributes can be used to pass information on the SIP call.
Eic_UserToUserData The value in the call attribute Eic_UserToUserData will be put in the
ININAttr header in the SIP message during outbound call logic and blind
transfer logic.
Eic_UserToUserData syntax:
[name=value[;name=value]*]
Note: name and value can not contain any double quotes.
Note: name must start with uu_.
Aculab AudioCodes Yes (this is the preferred hardware configuration). See section 17 for
Hardware IP boards AudioCodes IP board configuration details.
Intel/Dialogic AudioCodes Yes, with caveats. Dialogic plus AudioCodes configuration has been
PCI Hardware IP boards validated for IC 2.2 for the addition of one (1) AudioCodes card in
selected Dialogic configurations. Two or more AudioCodes cards in a
Dialogic system have not been tested and is not supported at this
time.
Please refer to the Validated Server Matrix spreadsheet for existing
installs and for new installs
While no significant issues have been found with the combination of
Dialogic and AudioCodes cards, we are unable to give blanket approval
to older existing servers due to the higher CPU loads required for
AudioCodes SIP processing. There may be older PCI servers in the
customer base that will not perform with AudioCodes cards.
Hardware 2 flavors of Audiocodes H.100 PCI boards are No telephony boards required. This
supported. Older, retired H.100 Non-Universal is a complete software solution.
PCI Boards and the newer Universal boards
(supported in 2.3 and above). Note that many
servers do not have PCI slots that allow for
Non-Universal boards. Mixture of these boards
in a single server is supported.
Price Check with your hardware vendor. Check with Interactive Intelligence.
Density 30, 60, and 120 simultaneous RTP sessions. HMP 1.1/1.3: See the HMP chapter
for the latest densities (section 18
Benefit: The actual number of usable “Installing and Configuring Intel
resources ports provided may exceed the rated HMP Software Solution”)
capacity of the Audiocodes boards. Currently,
the Audiocodes 30 port board reports in as a 40
port board. All 40 sessions are usable on the
30 port board, but this is not guaranteed in
future AudioCodes firmware.
Number of New numbers will be coming out shortly with NA. This is a total software
boards per the new worst case scenario numbers. These solution without boards.
Server numbers are what should be used when
installing a system.
Note that 600 ports was tested with a light call
rate (3 calls/second, 180 calls/minute). Also,
all calls were not being recorded and tracing
was set to default.
Aculab Servers: 600 AudioCodes IP ports can
be in a single server (five 120 port boards).
Also, there is an Aculab limitations of 300
simultaneous audio operations (plays and
records) on a single Aculab system. Note,
since the Audiocodes boards are non-universal,
there are only a few servers that can accept
many non-universal boards.
NICs Multiple NICs are supported. HMP 1.1: Dual NICs are not
supported.
HMP 1.3: The one, specific NIC (on
a dual NIC system) that will be
used is configurable via the DCM.
Play and Record No. Must use an additional resource board. I3 Yes.
does not use the AudioCodes voice resources
and the board is priced accordingly. Voice Note: 2.3.1 includes HMP
resources from Aculab or Intel/Dialogic cards transaction record (in earlier
are used for audio. releases without transaction
record, conference resources were
Note: Aculab Prosody boards (each with up to 4 used to do supervisory records).
DSPs and 4 T1s) are supported. Each of the 4
DSPs can be used for either 60 voice resources,
8 faxes, 24 conference resources with echo
cancellation, or 64 conference resources
without echo cancellation.
Note: Intel/Dialogic 240 voice resource board
(DMV2400A-PCI) is a high density voice board.
It can be configured for 240 voice resources, or
120 conference resources, or 60 of each (60 is
not a typo – when configured for both
conferencing and voice, you lose density).
Usable T1/E1 The versions of these AudioCodes boards do No. This is a total SIP solution.
Interfaces not have network interfaces. SIP gateways must be used if
T1/E1 interfaces are required.
Coders G.711, G.723, G.729, GSM, G.726. HMP 1.3: G.711, G.723, G.729,
G.726.
Note G.726 is new in HMP 1.3.
Echo 30ms of echo cancellation on the voice going HMP 1.1/1.3: No.
Cancellation from the TDM bus to the IP network.
Coming in later release.
4.2 Firmware will increase it to 64 or 128ms.
RTP Starts at 4000 (configurable) and steps up by Starts at 49152 (configurable, see
10 for the next session. section 18.6 “Configuring RTP
Dynamic Port Range”) and steps up
Sync RTP is used. by 2 for the next session.
Sync RTP is used.
Modems Clear channel (which is not reliable). See Clear channel (which is not
section 27 “Modem Configuration”. reliable). See section 27 “Modem
Configuration”.
Call analysis Yes, with limitations. See section 25 “Call Yes, with limitations. See section
Analysis” 25 “Call Analysis”
Vendor IC 2.x uses Audiocodes release 4.2 (with latest IC 2.x uses HMP 1.1
Software hot fix)
IC 2.3.x uses HMP 1.1
IC 2.3.x uses Audiocodes release 4.2
IC 2.4 uses HMP 1.3
IC 2.4 uses Audiocodes release 4.6
17.2 Servers
The Interactive Intelligence we site maintains a list of servers for certified for use with AudioCodes
boards.
If the install fails to install the drivers or you wish to manually install them, try this manual steps:
Follow the following steps to activate the AudioCodes IPM-260 PCI drivers using the Hardware Wizard.
1. Press the Next button when the Found new Hardware Wizard dialog appears.
3. Clear all of the Optional search locations: and then press the Next button.
4. After a few seconds the wizard should report that it was able to locate a driver for this device
at C:\WINNT\inf\ipm260.inf or c:\WINNT\inf\ipm206_UN.inf for the universal board. Select
After the PCI driver was successfully installed, the next step to using the boards is to configure them
with Interaction Administrator.
IMPORTANT
• If using switchover, configure the boards in BOTH systems on a single system. Switchover
replicates that configuration across both systems. The boards that are configured in IA but are not
found in the server are not activated. So, for example, if you have a single AudioCodes card in
each server then you MUST configure them both in IA. Switchover will replicate that configuration
to the secondary server. When TsServer starts on the primary, it’ll only detect one of the two
boards in the server and only activate it. If a switchover occurs, TsServer will start on the
secondary server, detect only one board (the other one) and activate it.
• The Interaction Center must be restarted for these changes to take place.
Parameter Description
Firmware Path Indicates the location of the IPM-260 firmware file. Typically, this should be
“D:\I3\IC\Server\Firmware\AudioCodes\ramIPM-260.hex”. It should
contain the complete path, including the firmware file name.
H.100 Bus Law Type This parameter changes the encoding scheme of the TDM bus. The default
type is mu-law. Valid values are a-law and mu-law.
Starting Media Port Starting port for AudioCodes RTP sessions. The default value is 4000. If this
port conflicts with other resources or applications then set this parameter to
change the starting port. This value must be divisible by 10. AudioCodes
port assignments increment in pairs of three from the starting port and
consecutively to the number of IP resources * 10.
For example, if the starting port was 4000, then the first IP resource will
consume 4000 (for RTP), 4001 (for RTCP) and 4002 (for T.38 fax). The next
IP resource will consume 4010, 4011, 4012 and so on. If this was a 120 port
card, the last IP resource will consume 5190 (for RTP), 5191 (for RTCP) and
5192 (for T.38 fax).
Minimum Jitter Buffer In milliseconds. Minimum jitter buffer delay that will be used by the
Delay dynamic jitter buffer algorithm on AudioCodes boards. The algorithm will
never reduce the jitter buffer below this value.
Values: 0..150 (milliseconds), 40 is the default
Considerations: Consider what minimal delay would be safe over a low jitter
network and set the AudioCodes Minimum Jitter Buffer Delay to that minimal
value.
The optimization factor should be governed by the application’s relative
sensitivity to packet errors and delay. Set a high optimization factor if the
application is sensitive to packet loss and a low optimization factor if it is
preferred to pay for low delay with a higher error rate.
Jitter Opt Factor Jitter buffer optimization factor is a unit-less value that determines the
operational response of the dynamic jitter buffer algorithm on AudioCodes
boards. If set to the maximum value, the jitter buffer delay tracks the
network latencies to their maximum and stays there, thus minimizing packet
loss but maximizing delay. When the lowest value is used, the jitter buffer
increases delay only to compensate for clock drifts, and soon decays to it
minimal setting again, thus minimizing delay but maximizing packet loss.
Values: 0..12 (7 is the default)
Parameter Description
MAC Address 12-digit MAC address of the board or 0 (zero). The MAC address should be
entered as shown on the sticker attached to the physical card.
Master Whether the board is the clock master for the bus or clock slave,
respectively. If your system contains any Dialogic or Aculab boards then this
value will always be unchecked (slave).
H.100 Termination Whether the board should terminate the H.100 bus. If the board is situated
on is the first or last board on the bus then hardware termination should be
checked. Otherwise, if the card is between Dialogic or Aculab cards then
H.100 termination should be unchecked.
Default Gateway IP address of the default gateway machine. Enter it in dotted decimal
format, for example, 10.12.1.1. If you do not have a default gateway, use
the IP address of the host NIC (i.e. the IP address of the Interaction Center).
Port Duplex AudioCodes defaults to 100Mbps half-duplex if the switch port is not set to
auto-negotiate. If the negotiation fails (which happens if the switch port is
not configured for auto-negotiate), the AudioCodes board will drop down to
its default setting of 100Mbps half-duplex. If AudioCodes is running at half-
duplex and the switch port is at full-duplex, packets will be dropped and
audio will be choppy.
18.2 Servers
The Interactive Intelligence we site maintains a list of servers for certified for use with AudioCodes
boards.
18.3 Densities
These limits apply to HMP 1.1. There are no hard limitations for HMP 1.3, but the general rule is that
1.3 numbers are double the number of 1.3.
R RTP G.711 Resources R<= 120 The number of RTP resources for any given
(i.e. G.711 IP configuration should be greater than or equal
Resources) AND to the number of voice, conferencing, or fax
R>= max (V,C,F) resources (whichever requires the highest
number of resources).
V Voice Resources V<= 120 These are used for play, record,…. In 2.3.1,
transaction record is available.
AND
V<= R
S Speech Integration S<= 120 This is the number of voice resources (above
Resources row) that will have CSP (continuous speech
AND processing) capabilities. CSP is used to
S<= V provide an echo cancelled stream of audio
for ASR (i.e. speech rec). You will need a
CSP resource for every session that is doing
ASR (in other words, any call where the
AsrBeginSession tool step has been executed
but has not executed the AsrEndSession tool
step.
• Install Intel HMP Release 1.3 and the necessary Intel Service Packs and PTRs, which can
downloaded from http://www.inin.com/support/dialogic/software/index.asp?
18.5.3 IP addresses
The IP address is configurable via the DCM. Select HMP Software on the system tree view in the DCM
window, select configure device, and the “Default IP Address” Tab.
The old, retired method used in HMP 1.1 was:
The IP address is configured when you install HMP. If you change your IP address, you must
reinstall HMP or go into the registry and change it. It can be found at
HKEY_LOCAL_MACHINE/Software/SBLabs/dm3ssp.
18.5.4 Timers
HMP requires a high resolution timers for real time processing of 10, 20, and 30 millisecond frames.
There are two timers that can be used:
• Microsoft Windows Multimedia Timer (mmtimer). This is a software timer. This timer is on
higher speed machines (1GHz and beyond).
• Advanced Programmable Interrupt Controller (APIC). This is a hardware timer (via an on-chip
controller on the Pentium family processors). This is more accurate than the mmtimer.
Starting with new Intel releases (HMP 1.1 SU 20 and beyond), the Intel HMP install program will
disable the APIC timer if necessary (and will use the mmtimer) and put up the follow dialog:
Problem 1 The local APIC’s operation may not be reliable when used in conjunction with some
chipsets if Advanced Power Management (ACPI) is installed.
Solution Run dialogic/bin/readfadt.js to see if there is a conflict with the APIC timer and other tasks, such
as Advanced Power Management. If there is a conflict, then you have 3 options:
Option 1 Stop the dlgcapidrv service, thus causing the mmtimer to be used.
How: Bring up the DCM dialog (keeping the Intel/Dialogic service stopped). With the DCM dialog
up and Intel/Dialogic service stopped, use a command prompt to run the command “net stop
dlgcapicdrv”. Start the Intel/Dialogic service with the DCM
Note: Option 1 needs to be done EVERYTIME you start the Intel/Dialogic service.
Option 2: Disable the dlgcapidrv service, thus causing the mmtimer to be used.
How: Change the value of
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\DlgcApicDrv\Start from 2 to 4 (this
will cause the dlgcapicdrv service to be disabled). Unfortunately, it doesn’t show up in SCM, so
you have to do it through the registry.
Note: Option 2 only needs to be done once.
Note: You must restart Windows for this registry setting to take affect.
Option 3 Disable the Advanced Configuration and Power Interface (ACPI), thus resolving the conflict so the
Advanced Programmable Interrupt Controller (APIC) can be used.
How: Using Microsoft KB article #Q237556
(http://support.microsoft.com/default.aspx?scid=KB;en-us;q237556), change the computer type
to “Standard PC”.
If the UDP/RTP port rang used by the HMP system conflicts with other RTP services such as firewall
configuration, the steps below can be followed to set a different range:
Description IC assumes that all IP resources are enhanced RTP resources even though some are basic.
Symptom Assume you have 20 G.711 resources and 5 of them are enhanced (can do G.723 and G.729). If
G.729 is selected in IA, the IC server will assume that it can do 20 G.729 sessions. However,
when trying to start the 6th G.729 session, an HMP API will fail and the call will be disconnected.
This is the error message:
Module: IPLinkResource.cpp
Method: CIntelHMPIPResource::QueryDialogicError()
Details: Dialogic IP media library error
Additional Info: ipm_StartMedia() failed for device ipmB1C1 with error Invalid parameter
Workaround Do not use more G.723 or G.729 sessions than what you have on the HMP license.
Or
If using the example of 20 G.711 resources with 5 of them enhanced), create 2 SIP lines:
- 1 line for G.729 only with a maximum of 5 calls
- 1 line for G.711 only with a maximum number of calls of 15
Affected IC 2.3
Fixed IC 2.3.2
Hotfixes
Issue HMP service does not start automatically when set to automatic with the Services
applet (works when you set to automatically from the DCM).
Description
Symptom None
Workaround This is a problem with all Dialogic releases. Always set the service mode from the DCM OR go to
HKEY_LOCAL_MACHINE\SYSTEM \ CurrentControlSet\
Description On Windows 2000: HMP 1.1 supports a single processor (without hyper-threading) or dual
processors (without hyper-threading).
On Windows 2003: HMP 1.1 supports a single processor (without hyper-threading), a single
processor (with hyper-threading), dual processors (without hyper-threading). or dual processors
(with hyper-threading).
Symptom None
Issue HMP performance on Windows 2003 is much better than on Windows 2000.
Description Please note that servers running Windows 2003 with HMP far outperformed servers running
Windows 2000. As a result, we are strongly recommending Windows 2003 for servers running
HMP.
Also note that HMP 2.0 will only run on Windows 2003 (Windows 2000 will not be supported with
HMP 2.0)
Symptom None
Issue If a firewall provides an odd port number (via PAT) for RTP, HMP will still transmit on
the even port
Description
Symptom None
Workaround This may well be a Cisco PIX issue – it is unclear from the RTP RFC. Investigating….
Line Configuration
Active Same as in today’s Line objects. Note that a SIP line is subject
to being licensed. Only active lines are counted.
Default: On
Phone Number Same as in today’s Line objects. A required field. This number is
used in the “From” header in outbound SIP calls. This value is
not used if a handler changes the origination address in the
Extended Place Call tool.
Domain Name Domain name used to formulate SIP-URLs for IC users and
phone numbers. This domain name will be automatically
appended to all REGISTER requests sent by the Interaction
Center.
Combined When the toggle is checked, the label for the inbound label is set
to “Combined” and the outbound prompts and label are hidden.
Note: this value cannot be set to 0.
Disable T.38 Faxing Unchecked (Off) means that T.38 will be used for faxes over
SIP.
Default: Off.
Auto Disconnect when Silence is Same as in today’s Line objects. Linked to Silence Time.
Detected
Default: Off
Line Configuration
Audio Path Always-In: The audio will flow through the IC server.
Dynamic: The audio will NOT flow through the IC server
whenever possible. The audio will flow though the IC server
only if the IC server determines that it needs access to the
audio. The IC server needs access to the audio for recording,
monitoring, conferencing, and when the two devices don’t have
a common codec.
DTMF Type The type of DTMF signaling. If the connection is to a station, the
DTMF type in the station is used. Possible values:
Inband – DTMF tones are in the actual audio stream.
RFC2833 (default) – DTMF tones are sent and received via tone
information contained in RTP packets. If RFC2833 is selected for
DTMF Type, the Interaction Center server will attempt to
negotiate an audio session with the remote endpoint using
RFC2833 for DTMF, but if the remote side doesn’t support
RFC2833 then it will revert to Inband mode.
RFC2833 Only – will force all sessions to be negotiated using
RFC2833 for DTMF. If the remote side doesn’t support RFC2833
then the session will fail.
Vendor Specific
Intel/Dialogic software (HMP) supports RFC2833.
AudioCodes hardware boards supports RFC2833.
DTMF Payload The value used for the DTMF RTP payload type. This should be
set to the same value you have configured the other SIP devices
in your network. Many devices do not negotiate the DTMF
payload correctly, so it is very important that each device sets
this parameter to the same value.
Values:
101 (default)
96-127
Vendor Specific
100, 102-105 should not be used for AudioCodes.
This value is also in the station and the global station
configuration.
RTP QOS Byte (hex) QOS byte that will be set in all RTP packets.
Vendor Specific
For HMP platforms, a Windows 2000 registry setting must
also be set.
Voice Activate Detection (VAD) Checked (On) means use VAD on any connection that is NOT to
a station. If the connection is to a station, the VAD configured in
the station is used.
Default: Off
Vendor Specific
Intel/Dialogic software (HMP) does not support VAD.
Echo Cancellation Checked (On) means that echo cancellation will be used.
Default: On.
Vendor Specific
Intel/Dialogic software (HMP) does not support echo
cancellation.
AudioCodes hardware boards support 32ms of echo cancellation
on the voice going from the TDM bus to the IP network.
Line Configuration
Address To Use Select the Network Connection (from a drop down list) that you
want to use for all the outbound SIP communication.
Receive Port Port number for which the IC SIP engine will be servicing
requests.
Valid: 1024 to 65535
Default: 5060 for UDP and TCP
Default: 5061 for TLS
Connect Timer (valid for only TCP) TCP: TCP connection time out (in milliseconds). Maximum
amount of time to wait for a TCP connection to be established
before timing out.
Valid: 500 to 20000 (milliseconds)
Default: 3500
T1 Timer (valid for only UDP) UDP: Timer value in milliseconds that represents the initial
incremental delay between packet retransmission.
Valid: 500 to T2 (milliseconds)
Default: 500
T2 Timer (valid for only UDP) UDP: Timer value in milliseconds that represents the maximum
incremental delay between packet retransmissions.
Valid: 4000 plus (milliseconds)
Default: 4000
Maximum Packet Retry (valid for UDP: Maximum Packet Retry for requests
only UDP)
Valid: 0 to 10
Default: 10
Maximum Invite Retry (valid for UDP: Maximum packet retry for INVITE and ACK requests
only UDP) Valid: 0 to 6
Default: 6
Line Configuration
Use SIP Session Timer If checked, then, for each active call using the line, IC will send
a SIP OPTIONS message to the remote party’s device to verify
Sip Session Timeout the device and the call on that device is still active. The
OPTIONS message is sent at an interval [in seconds] equal to
the SIP Session Timeout parameter. If the remote party’s
device does not respond to the OPTIONS message then the
Interaction Center will disconnect the call.
Disconnect on Broken RTP Whether to detect the lack of RTP traffic as a reason to
disconnect the call.
The configuration for the number of seconds to wait before
disconnection is described in section 22 “SIP Telephony
Parameters in Interaction Administrator”.
If no RTP, RTCP, and no comport noise packet (used with VAD)
is received in the configured time, the call will be automatically
disconnected.
Note: If a remote device does, for the time configured, is using
VAD (and not sending RTP) AND does not send comfort noise
packet to initiate the silence, AND does not send RTCP, then this
will be misinterpreted as no RTP and the call will be dropped.
Vendor Specific
Intel/Dialogic software (HMP) does not support this parameter.
AudioCodes hardware boards support this parameter.
Disable Delayed Media When making an outbound call, the media information (using
SDP, Session Description Protocol) can be passed in either the
SIP INVITE message or the SIP ACK message. The remote
party can send its SDP in a SIP 183 response or the SIP OK
message.
Normal Media: The SDP is in the SIP INVITE. An IP resource is
allocated before the INVITE is sent.
Delayed Media: The SDP is in the SIP ACK. An IP resource is
allocated only after the remote party answers the call.
Advantages to Normal Media: Normal Media allows Early Media
(when the remote party sends SDP before the call is answered in
a 183 response) to occur. Early Media is done by gateways to
cut through the audio before the call is completed.
Advantages to Delayed Media: When doing a phone group ring,
IP resources do not have to be allocated to ring a group of
phones. Also, when interfacing with a device that changes RTP
packet codec type on the fly (something that is not supported by
the Interaction Center server), Delayed Media will allow the
Interaction Center to pick only one codec and send that one
codec in the ACK – thus informing the remote party to only use
that codec.
Terminate Analyses On Connect Checked (On) means, if call analyses is used, to terminate the
call analysis procedure when a SIP connection indication from
the network is received.
Example1: The Interaction Center makes it’s PSTN call via SIP
calls through a SIP/ISDN gateway. This particular SIP/ISDN
gateway only sends a SIP connect message back to the
Interaction Center after the remote party answers the call. If
call analysis is used, you would want to keep checked Terminate
Analyses On Connect, so that call analysis will terminate when
the SIP connect message is received.
Example2: The Interaction Center makes it’s PSTN call via SIP
calls through a SIP/analog gateway. This particular SIP/Analog
gateway always sends a SIP connect message back to the
Interaction Center prematurely, before the remote party
answers the call. If call analysis is used, you would want to
uncheck Terminate Analyses On Connect, so that call analysis
will continue after the SIP connect message is received.
If the connection is to a station, the Terminate Analyses On
Connect configured in the station is used.
Default: On
Line Authentication Use this dialog to enter authentication information for a specific
SIP line. Authentication credentials on the SIP line only apply
to outbound calls from the Interaction Center. SIP line
authentication is only used when a proxy “challenges” an
outbound call.
A SIP line is typically used to send a call to an external party
through a SIP gateway or proxy. If the gateway or proxy
challenges the call with a 401 or 407 response code, then the
User Name and Password on this tab are used to authenticate
the call. The digest access algorithm is used as defined in RFC
2617 HTTP Authentication: Basic and Digest Access
Authentication.
See the “IC Regionalization and Dial Plan” tech note for details of compression.
Note 1: Receive: When G.729AB is used, G.729, G.729A, G.729B, and G.729AB can be received. Transmit: If
the VAD checkbox is selected (in station and line config in IA), G.729AB will be sent. If the VAD checkbox is not
selected, G.729A will be sent. The noannexB value in the received SDP is not honored.
Note 2: HMP does not support 4 frames/packet with G.723 and does not support 1 frame/packet with G.729.
Note 3: Data Rate: The data rates shown below do not include packet header overhead. For example, G.711
actually uses 80K-100Kbps. The data rates below are all for half duplex (which is what most conversation are).
However, if VAD is not used, silence is transmitted, thus using double the bandwidth indicated.
Note 4: Packet and Frame size: nice summary on the topic of packet size and frequency from the
www.erlang.com website: "The frequency at which the voice packets are transmitted have a significant bearing on
the bandwidth required. The selection of the packet duration (and therefore the packet frequency) is a
compromise between bandwidth and quality. Lower durations require more bandwidth. However, if the duration is
increased, the delay of the system increases, and it becomes more susceptible to packet loss; 20ms is a typical
figure." So, the more of the voice you put in a single packet (say 60ms versus 20ms) then the more of the voice
you lose if that packet is lost.
List of Proxy Addresses Note: A SIP proxy server is not required, but does provide some
features that might be needed in certain network topologies. A
SIP proxy can do network and also do gateway selection.
Priority list of outbound proxies available to IC product. If an
outbound proxy is configured then all SIP messages will be
indiscriminately sent to it for transmission. All messages will be
sent to the first proxy in the list. The remaining proxy entries
will only be used if the first entry is deemed not operational.
Each entry in the list should be an IP address in the IP4 dotted-
notation or a fully qualified domain name. IA treats this as a free
format field and does little validation. (IP6 notation is not
supported at this time.)
For each IP address, there should be a port. The port number
identifies the port at which the proxy will be servicing requests.
Do not put the Interaction Center Server in this field, since it will
cause all SIP calls to be looped back to the Interaction Center.
Valid: 1024 to 65535
Default: 5060
External List List of external telephone numbers that are not configured in our
system but need to be directed to our server when encountered.
Therefore, we must register them with the registrar. Typically,
these are numbers that are provisioned on the PSTN interface
but not provisioned in our system, like a 1-800 number.
Line Configuration
Granted Access | Denied Address Granted Access: By default, all IP addresses will be allowed
access to the IC server except those listed in the list below.
Denied Access: By default, all IP addresses will be denied
access to the IC server except those listed in the list below.
Access | IP Address Put the IP addresses in the list. It’s possible to enter a single IP
address or a range of IP address.
See the “IC Regionalization and Dial Plan” tech note for details of regionalization.
There are 3 techniques that the Interaction Center server does to transfer calls and release control.
They are:
Enable Call Putback Check if you want the Interaction Center to For Call Putback (or
RLT or Release Transfer) to occur, the following must be true:
• The Enable Call Putback checkbox must be checked.
• If using a handler, the BlindTransfer or Consult Transfer
Tool Steps must not specify false for “Use Putback”.
• Both calls must be external SIP calls.
Global SIP Note that all these values are used by default by each station. If
Station desired, each station has the ability to individually configure these
Configuration options.
Connection SIP This is the SIP address used to call the SIP device. This address is used by the
Address Interaction Center to initiate calls to this SIP station. It’s also used to send
MWI notifications f MWI is enabled.
Values:
Same as Identification Address. Use the station’s identification address (in the
station configuration) as the contact address. Note: This option should only be
used if the Identification address is a fully-qualified domain name or SIP
address.
Dynamically Updated. Allow the station’s contact information to be
automatically set from SIP URI in the SIP Message Contact Header in the
station’s INVITE or REGISTER SIP message. This option is very useful if SIP
stations use DHCP and can change IP addresses frequently. NOTE: This option
also is susceptible to ‘spoofing’ and can allow a rogue user to masquerade as
another SIP station when not using authentication. If deploying on an unsafe
network then it’s recommended that authentication (section 20.6 “Global
Station Configuration: Authentication Page”) be used to secure the station from
these types of attacks.
In the station configuration, you can also specify a unique contact address if
desired.
20.2.1 Notes on “Dynamically Updated Contact Addresses” and the audio-enabled client.
The Interaction Center client (when running in audio-enabled mode) will use the Microsoft RTC APIs to
send a registration request. Here are two cases.
Case 1.
Case 2.
REGISTER message, station ID=”sip:7104@1.1.1.1:5060”. Client created “From” header
from the station ID field.
REGISTER sip:1.1.1.1 SIP/2.0
Via: SIP/2.0/UDP 172.16.129.124:7483
From: <sip:7104@1.1.1.1:5060>;tag=224c331a-cf97-4ecb-9d3e-8207ef618896
To: <sip:7104@1.1.1.1:5060>
Call-ID: e4b2b988-4821-49de-a59c-59500cf61391@172.16.129.124
CSeq: 1 REGISTER
Contact: <sip:172.16.129.124:7483>;methods="INVITE, OPTIONS, BYE, CANCEL, ACK"
User-Agent: Windows RTC/1.0
Expires: 1200
Event: registration
Content-Length: 0
All Parameters All these parameters are documented in the Line Configuration
section for the Audio Page.
Global SIP Note that all these values are used by default by each
Station Configuration station. If desired, each station has the ability to
individually configure these options.
All Parameters, except the ones All these parameters are documented in the Line Configuration
below. section for the Transport Page.
Use Proxy for Station Connections Checked indicates that the proxy list configured in the line
configuration in Interaction Administrator should be used to
connect stations. Unchecked the Interaction Center will contact
the stations directly.
Line Group The line (or lines) in this line group will be used to connect to
SIP stations. The line group is configured in the Line Groups
container in Interaction Administrator. This is needed if you
have a large number of lines (for efficiency) or if you want a
specific SIP line to be used for contacting the configured SIP
stations.
Global SIP Note that all these values are used by default by each
Station Configuration station. If desired, each station has the ability to
individually configure these options.
All Parameters, except the ones All these parameters are documented in the Line Configuration
below. section for the Session Page.
Station Connections are Persistent Checked indicates that connections to the station are persistent,
and will not be disconnected until the station initiates the
disconnection. Unchecked indicates that when the Interaction
Center determines that the audio path to the station is no longer
needed, the Interaction Center will initiate the disconnection.
Note that if Persistent is used, the number of call appearances
will be 1. The connection will be established by the SIP phone
(when it makes a call) or by the Interaction Center server (when
it calls the SIP phone because a connection is requested via the
Interaction Client (pickup, makecall, listen,…).
Persistent is typically used when the user uses the Interaction
Client exclusively, and does not use the phone to transfer or
consult.
Recommended setting:
Operators: If you want to handle more calls than the phone is
capable (for instance an operator want to handle up to 20
simultaneous calls), check the Persistent checkbox. The
Interaction Client can be used to manipulate a large number of
calls while the phone will be the audio device for the calls. The
phone will show one call while the Interaction Client will be used
to manipulate the calls.
Call Center Agents: If call center agents are using an IP phone
with a headset and using the Interaction Client, Persistent
should be used.
Number of Call Appearances per Enter the number of call appearances the phone can handle. The
Station Interaction Center will send up to the configured number of calls
to the phone.
Note that if Persistent is used, the number of call appearances
will be 1.
Note that if using the Interaction Client, the number of call
appearances should be 1. Why? Because if the phone would
put a call on hold, you can not take it off hold with the
Interaction Client (the phone itself must take the call off hold).
When using 2 call appearances, the phone will put one call on
hold when answering a second call (if over 1 call appearance is
configured).
Recommended Setting:
General: This value should be over 1 for only experienced phone
users
Vendor Specific
Cisco: The Cisco IP phone 7960 can have up to 6 line
appearances (each line appearance is equivalent to a station).
Each line appearance has a unique SIP address. Don’t confuse
line appearances with call appearances. Each line appearance
handles 2 call appearances. Configure the phone to one line
appearance and then this station configuration to 1 or 2 call
appearances.
Pingtel: Pingtel Expressa IP phone has one line appearance that
handles 4 call appearances. Configure station configuration to 1,
2, 3, or 4 call appearances.
Connection Call Warmdown Time For non persistent connection calls, this is the number of
seconds the SIP call will remain active to a station before the
connection call is automatically disconnected. The IC server
could typically send multiple regular calls (for whisper, IVR) to
the station, and having the Connection Call Warmdown Time
greater than 0 will cause the same connection call to be reused
(which is good).
Station Authentication Use this dialog to enter authentication information for all SIP
stations. If desired, each station has the ability to individually
configure these options. Enabling authentication forces the
phone to authenticate itself with the Interaction Center Server
before the Interaction Center Server processes any request from
the station. SIP station authentication prevents access to
Interaction Center resources from unauthorized SIP devices. If
authentication fails, then the station will not be able to make
outbound calls.
If enabled, the Interaction Center Server will challenge all calls
from phones that match the stations ID address by sending a
401 response. The User Name and Password on this tab are
used to validate the phones response. The digest access
algorithm is used as defined in RFC 2617 HTTP Authentication:
Basic and Digest Access Authentication.
All Parameters All these parameters are documented in the Line Configuration
section for the Compression Page.
Phone Manufacturer • Blank (default). This means use the value in the Global
Station, which defaults to “Interaction Client”
• “Interaction Client”
• “Polycom”
• “Generic”
Special Logic:
“Interaction Client” will cause “ININCC=x” tag to be put in the
From Header on an outbound INVITE. x=0 for normal ringing
calls and x=1 for calls that should be “auto off hook”.
“Polycom” will cause the Alert-Info header to be added for
calls that should be “auto off hook”. This feature is available
starting with the 1.1.1 Polycom firmware. The SIP message
Alert-Info headers will look like this:
Alert-Info: <http://localhost/AutoAnswer>
In the Polycom sip.cfg file , set the following alertInfo
attributes: <alertInfo
voIpProt.SIP.alertInfo.1.value="<http://localhost
/AutoAnswer>"
voIpProt.SIP.alertInfo.1.class="3"/>
SIP
Station Configuration
Use Global SIP Station Connection If checked, the values configured in the Global SIP Station
Settings Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
Identification SIP Address This is the SIP address that identifies the SIP device. This
address is used by the Interaction Center to identify this SIP
station. See section 21.3.1 “Identification SIP Address Page”
for details.
Connection SIP Address This is the SIP address of the SIP device. This address is used
by the Interaction Center to connect to this SIP station.
Same as Identification Address should rarely be used.
Dynamically Updated will update the connection address when
the phone sends a SIP REGISTER or INVITE.
Other - see section 21.3.2 “Connection SIP Address Page” for
details.
Identification User This is the SIP address that is used to identify calls made from the SIP station.
and Host When a managed SIP station makes a call, it is routed through the Interaction
Center. The Interaction Center will use this address to identify that the call was
made from a SIP station and then the Interaction Center will complete the call.
Note: The user field is matched against the user portion of the SIP message. IP
phones typically put their configured number in the user portion of the SIP
message. Do NOT confuse this with a user’s extension.
Note: The address of the station when a call comes into the IC server
(identification address) can be different than the address the IC server needs to
use when calling the station (contact address). This is because an inbound call
from a station could be coming through a proxy server. The header of the SIP
message could contain the address of the Interaction Center and not the Station
address itself.
Option 1 “Use a predefined format”, “Use User Portion Only” selected. If running
Switchover, the “Use User Portion Only” must be selected so that each switchover
server can identify the station. NOTE: Using this option without Authentication
can result in “spoofing” and “masquerading” attacks if Authentication is not used.
If the phones are being deployed in environments where this may be a concern,
then it’s recommended that Authentication be used.
Option 2 “Use a predefined format” with the “Use User Portion Only” not selected.
This option provides more security (than option 2) to prevent “spoofing” and
“masquerading” because the IP or host portion of the From address is used to
identify the station as well as the user portion. It’s typically harder to spoof an IP
address as well as a user portion. NOTE: Using this option can still result in
“spoofing” and “masquerading” attacks if Authentication is not used. If the
phones are being deployed in environments where this may be a concern, then it’s
recommended that Authentication be used.
Option 3 “Use an alternate format” should be used rarely.
Important: Setting up a station on the WAN connected over VPN is identical to
configuring a station on the LAN. Note that when a remote device establishes a
VPN tunnel into the network, it is given a local IP address. Since this IP address
can change on every instance of connecting over VPN, the contact address in the
station configuration should be the “name” of the station, rather than the station’s
IP address. For more info on VPNs, see 12.2 “VPN”.
Continued on next page….
Vendor Specific:
Cisco: For Cisco IP phones, the user field is the same value configured for
“line1_name” and the host field is the value configured for “proxy1_address”
(unless using the “proxy_backup” feature on the Cisco phones).
The Identification User and Host value should be (using Option 2)
sip:[value configured for line1_name]@[proxy1_address]:5060
if you are not using “proxy_backup” configuration and not using IC switchover.
“proxy_backup” is used if:
Using 2 or more proxies
Using no proxies and using Interaction Center switchover
Using no proxies and using a local gateway or emergency (911) gateway
The Identification User and Host value when using “proxy_backup” configuration
ro IC switchover should be (using Option 1)
line1_name (no “sip:”, no “@”, no host name, no port number).
This value can only be set using the alternate format of the Identification User and
Host value.
Pingtel: For Pingtel IP phones, the user field is the same value configured for
“PHONESET_EXTENSION” and the host field is the phone’s IP address. The
Identification User and Host value when using Pingtel phones should be sip:[value
configured for PHONESET_EXTENSION]@[phone’s IP address]:5060. See the “SIP
3rd Party Component Application Note” for details (Option 2).
In the above example, the “PHONESET_EXTENSION” would be “7111”, the
phone’s IP address would be “1.1.1.1”, and the identification would NOT be
“2.2.2.2” as the above example shows but would be “1.1.1.1”. Pingtel phones do
put the proxy’s address in the FROM headers of the SIP message (like Cisco
does).
Interactive Intelligence: If using the audio-enable Interactive Client, the
indentification address can be almost anything. The audio enable client will read
this field and pass this to the Interaction Center on REGISTERs and INVITES
Microsoft: For Microsoft Messenger, the user@host portion is the value
configured in Tools | Options… | Accounts tab | Sign-in name. The Identification
User and Host value when using Messenger should be sip:[value configured in
Messenger Sign-in]:5060. See the “SIP 3rd Party Component Application Note” for
details (Option 2 or 3)
In the above example, the PC’s IP address “1.1.1.1”, and the user@host
Messenger “Sign-in name” would be “7111@2.2.2.2.
port The port value is, by default 5060. It is the same value configured in the line
configuration.
Connection User This is the SIP address of the SIP device. This address is used by the Interaction
and Host Center to connect to this SIP station. This host portion of the Connection SIP
address is the IP address or host name of the SIP device. You should be able to
ping the host address from a DOS prompt on the Interaction Center Server, such
as "ping 1.1.1.1". If you are unable to do so, check connectivity and the host
name or IP address.
In the above dialog, the SIP device has an SIP address of
7105@172.16.128.142. This could have been 7111@SIP001122334455 if
the SIP phone had a host name of SIP001122334455.
port The port value is, by default 5060. It is the same value configured in the line
configuration.
SIP
Station Configuration
Use Global SIP Station Audio Settings If checked, the values configured in the Global SIP Station
Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
All other parameters If the “Use Global SIP Station Settings” check box is checked,
the values configured in the “Global SIP Station Configuration”
will be used. If the check box is not checked, then these
configurations will be able to be set independently. See the
Global SIP Station Configuration (see section 20 “Defining
Global Configurations for SIP Stations”) for complete
description of these parameters.
SIP
Station Configuration
Use Global SIP Station Transport If checked, the values configured in the Global SIP Station
Settings Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
All other parameters If the “Use Global SIP Station Settings” check box is checked,
the values configured in the “Global SIP Station Configuration”
will be used. If the check box is not checked, then these
configurations will be able to be set independently. See the
Global SIP Station Configuration (see section 20 “Defining
Global Configurations for SIP Stations”) for complete
description of these parameters.
SIP
Station Configuration
Use Global SIP Station Session If checked, the values configured in the Global SIP Station
Settings Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
All other parameters If the “Use Global SIP Station Settings” check box is checked,
the values configured in the “Global SIP Station Configuration”
will be used. If the check box is not checked, then these
configurations will be able to be set independently. See the
Global SIP Station Configuration (see section 20 “Defining
Global Configurations for SIP Stations”) for complete
description of these parameters.
SIP
Station Configuration
Use Global SIP Station Authentication If checked, the values configured in the Global SIP Station
Settings Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
All other parameters If the “Use Global SIP Station Settings” check box is checked,
the values configured in the “Global SIP Station Configuration”
will be used. If the check box is not checked, then these
configurations will be able to be set independently. See the
Global SIP Station Configuration (see section 20 “Defining
Global Configurations for SIP Stations”) for complete
description of these parameters.
SIP
Station Configuration
Use Global SIP Station Compression If checked, the values configured in the Global SIP Station
Settings Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
All other parameters If the “Use Global SIP Station Settings” check box is checked,
the values configured in the “Global SIP Station Configuration”
will be used. If the check box is not checked, then these
configurations will be able to be set independently. See the
Global SIP Station Configuration (see section 20 “Defining
Global Configurations for SIP Stations”) for complete
description of these parameters.
SIP
Station Configuration
Use Global SIP Station Compression If checked, the values configured in the Global SIP Station
Settings Configuration (see section 20 “Defining Global Configurations
for SIP Stations”) will be used.
All other parameters If the “Use Global SIP Station Settings” check box is checked,
the values configured in the “Global SIP Station Configuration”
will be used. If the check box is not checked, then these
configurations will be able to be set independently. See the
Global SIP Station Configuration (see section 20 “Defining
Global Configurations for SIP Stations”) for complete
description of these parameters.
Phone Model FUTURE: Will be used when the different models of the
Manufacturer require different configurations.
SIP
Station Configuration
Appearances For List of stations that have a line appearance that will appear on
this station.
See the “IC Regionalization and Dial Plan” tech note for details of regionalization.
RTP Disconnect Time 1..3600 (default Whether to detect the lack of RTP traffic as a reason to
30). disconnect the call is a check box in the SIP Global
Station, the SIP Stations, and the SIP Line.
This configuration is for the number of seconds to wait
before disconnecting.
Default Display String any string, defaults Used as the SIP display string in the FROM header when
to “Interaction calls are made to persistent SIP managed stations and to
Center” any SIP managed station when the client MakeCall
button is pressed. This string will show on the From field
on the phone display.
Managed Phone any character Used as a convenient way for managed phones to
Shortcut available from connect to the main IVR.
telephone keypad.
This value should be either the whole SIP address with
type and port number (sip:user@host:port) or just the
See section 21.4 user portion (user).
“Configuring the
Managed Phone Note: This number is typically a “*”. If managed phones
Shortcut” for details. are using a SIP proxy (rather than the Interaction
Center) to make routing decisions, then you must
configure the SIP proxy to route the calls to this number
to the Interaction Center.
Message Button any number Used for voice mail retrieval over the IP phone when the
message button on the SIP phone is pressed.
See section 21.2
“Configuring the This value should be either the whole SIP address with
Message Button for type and port number (sip:user@host:port) or just the
Voicemail Retrieval” for user portion (user).
details.
Note: You must configure voicemail button of the phone
to call this number when it is pressed.
Ringback File Name of wav file, Used to play ringback on external calls when the
defaults to gateway doesn’t not use early media.
“Ringback.waw”
Voicemail Direct any number Used to send calls directly to voicemail for unmanaged
phones. Voicemail for managed phones is already
See section 21.3 handled.
“Configuring Voice Mail
for Non-Managed This value should be either the whole SIP address with
Phones (SIP Diversion)” type and port number (sip:user@host:port) or just the
for details. user portion (user) of the SIP Uri.
The diversion header is used to find what user this
voicemail is destined for.
Note: You must configure your network to send calls,
destined for voicemail, to this number.
22.2.1 Setup
Set the parameter IP Message Button (see section 22.1 “Server Configuration: SIP Telephony
Parameters Page”).
The Message Button value should be either the whole SIP address with type and port number
(sip:user@host:port) or just the user portion (user).
22.2.2.1 Cisco
The parameter for configuring Cisco phones’ message button is messages_uri. See the “SIP 3rd Party
Component Application Note” for details. An example would be 1002@172.16.132.16 where
172.16.132.16 is the Interaction Center’s IP address and 1002 is the value set in the server
parameter IP Message Button.
22.2.2.2 Pingtel
The parameter for configuring Pingtel phones’ message button is PHONESET_VOICEMAIL_RETRIEVE.
See the “SIP 3rd Party Component Application Note” for details. An example would be
1002@172.16.132.16 where 172.16.132.16 is the Interaction Center’s IP address and 1002 is the
value set in the server parameter IP Message Button.
Notes
• Eic_RedirectionTn contains the whole SIP address with type and port (sip:user@host:port) of
the SIP message URI.
• The handlers check if the VoiceMail Direct parameter equals the whole SIP address
(sip:user@host:port) in Eic_RedirectionTn OR just the SIP address user portion (user) in
Eic_RedirectionTn. If there is a match, the Interaction Center will route the call to the user’s
mailbox whoses extension matches the user portion of the Eic_RedirectingTn, OR to the user
whoses Attribute 2 value matches either the whole or user portion of RedirectingTn.
Your phones or proxies must be configured to send the calls to the number configured as the
VoiceMail Direct number.
Then configure, in Attribute 2 in the user configuration in Interaction Administrator, the address in the
diversion header, if the address in the diversion header does not match a user extension.
22.3.3.1 Cisco
The Cisco phones do not forward calls to voicemail systems. This responsibility is done by proxies.
22.4.1 Setup
Set the parameter Managed Phone Shortcut (see section 22.1 “Server Configuration: SIP Telephony
Parameters Page”).
The Managed Phone Shortcut value should be either the whole SIP address with type and port number
(sip:user@host:port) or just the user portion (user).
For example, setting Managed Phone Shortcut to “*” or “123” will allow IP phones to dial this number
as a convenience to get to the main IVR for managed phones. Note that the phones must be able to
dial this number (some IP phones do not consider a “*” as a dialed number).
Previous to 2.3 RC3, this configuration was in Attribute 3 in the ACD section of the user configuration
was used. Now there is a MWI tab in the user configuration. For station-less users (i.e. users using
Unmanaged Stations) that still require MWI, this value in the user configuration of IA can be used.
The phone number (WITHOUT “sip:” and WITHOUT “:5060”) should be set in Interaction Administrator
| User configuration | ACD Tab | Attribute 3 field (i.e. 2222@172.16.131.11). When voice mail is left
22.5.1.1 Cisco
The Cisco phones do not subscribe for notifications. The Interaction Center will send unsubscribed
notifications to the Cisco phones.
22.5.1.2 Pingtel
The Pingtel phones can subscribe for notifications. The parameter for configuring Pingtel phones’
subscription is PHONESET_MSG_WAITING_SUBSCRIBE. See the “SIP 3rd Party Component Application
Note” for details. If the Pintel phone subscribes for notifications, the Interaction Center will send
subscribed notifications to the Pingtel phone. If the Pintel phone does not subscribe for notifications,
the Interaction Center will send unsubscribed notifications to the Pingtel phone.
Both input conversions above convert the number to “sip:something”. On the Dial Plan page, you can
specify a dial group for handling outbound SIP calls (calls in the format of “sip:something”). See the
Phone Numbers in IC whitepaper (located in the \Documentation directory) for more information on
working with phone numbers and dial plans in IC.
Dial Group The line group with the sip lines to be used for the call.
Dial String The number to be dialed for the specified input pattern. In the above
dialog, “sip:something” for the input pattern “sip:something”.
Important: The trailing “Z” is present to allow “/” dialing and account
code dialing (someone might dial 201-555-1111/123).
Number is in a non tel or TsServer will convert the number to a tel TsServer will convert the number to
non sip format, i.e. format. i.e. tel:3178723000. a tel format. i.e. tel:3178723000.
3178723000. SIPEngine will fail the call since
there is no IP address to send the
If “Use tel: Scheme” is checked, SipEngine call to.
will reconvert the number from tel to a sip
format (sip:3178723000@proxy) and send
the call to the configured proxy.
If “Use tel: Scheme” is not checked,
SipEngine will keep the number in the tel
format (tel:3178723000) and send the call to
the configured proxy.
3. Use Dial Plan: In the dial plan (described in this sections below), configure a translation from
5551212 to sip:5551212@gateway.
Dial The line group with the sip line to be used for the call. This line group (“SIP Lines” in the above
Group dialog) will typically contain one SIP line.
Multiple Gateway Note when using a single SIP Line: Add a second dial group entry when using
multiple gateways. This second entry will be used if the first entry fails. The second dial group
entry will have a dial string equal to the 2nd gateway’s name or IP address. The same SIP line
group can be specified on both entrys. When using a single SIP Line in the two entries, you are
using the SIP message responses from the gateway to inform the Interaction Center that the
gateway is congested.
More complicated and rarely used - Multiple Gateway Note when using multiple SIP Lines: Add a
second dial group entry when using multiple gateways. This second entry will be used if the first
entry fails. The second dial group entry will have a dial string equal to the 2nd gateway’s name
or IP address. When using a multiple SIP Lines in the two entries, you are using both the SIP
message responses from the gateway and the number of calls configured in the line
configuration to restrict the number of calls sent to a particular gateway.
Dial String The number to be dialed for the specified input pattern. In the above dialog, the number to be
dialed is 1201Nxxxxxx@gateway1 for the input pattern +1201NxxxxxxZ.
Important: Ordinals are used (i.e. “{7}”) rather than the wildcard syntax (NXYZ?) since the
wildcard syntax (NXYZ?) can NOT be used with alpha characters, such as “gateway1”. A
wildcard syntax is shown below.
Important: Specify the dial string with the Dial Group rather than in the “Default Dial String”
field. The default dial string field is only used when no dial groups are specified.
Important: The trailing “{13}” is present to allow “/” dialing and account code dialing (someone
might dial 201-555-1111/123).
Dial Group The line group with the sip line to be used for the call. This line group (“SIP Lines” in the above
dialog) will typically contain one SIP line.
Multiple Gateway Note when using a single SIP Line: Add a second dial group entry when using
multiple gateways. This second entry will be used if the first entry fails. The second dial
group entry will have a dial string equal to the 2nd gateway’s name or IP address. The same
SIP line group can be specified on both entries. When using a single SIP Line in the two
entries, you are using the SIP message responses from the gateway to inform the Interaction
Center that the gateway is congested.
More complicated and rarely used - Multiple Gateway Note when using multiple SIP Lines: Add
a second dial group entry when using multiple gateways. This second entry will be used if the
first entry fails. The second dial group entry will have a dial string equal to the 2nd gateway’s
name or IP address. When using a multiple SIP Lines in the two entries, you are using both
the SIP message responses from the gateway and the number of calls configured in the line
configuration to restrict the number of calls sent to a particular gateway.
Dial String The number to be dialed for the specified input pattern. In the above dialog, the number to be
dialed is 1202Nxxxxxx@172.16.128.4 for the input pattern +1202NxxxxxxZ.
Important: Ordinals (i.e. “{7}”) are not used in this example. The wildcard syntax (NXYZ?)
could be used since there are no alpha characters, such as “gateway1”.
Important: Specify the dial string with the Dial Group rather than in the “Default Dial String”
field. The default dial string field is only used when no dial groups are specified.
Important: The trailing “Z” is present to allow “/” dialing and account code dialing (someone
might dial 201-555-1111/123).
24.2.2 Example 2
The example below, a new Dial Plan object “sip:?@Z” was created so only the user portion of the SIP
address ({5} is the ordinal of the user portion) is displayed.
A sip inbound call from sip:marketing@sip.inin.com will be displayed as marketing.
25 Call Analysis
Detail: The call analysis and answering machine detection required for predictive dialing are highly
sensitive to noise and delays. Interactive Intelligence can only vouch for results when telephony
trunks (T1/E1 spans) are terminated directly on supported voice processing boards from Intel and
Aculab. Interactive Intelligence has not tested predictive dialing when PSTN trunks are terminated on
VoIP gateways because of the multitude of gateway vendors and configurations. Given the inherent
changes in audio introduced by the conversion of voice to IP traffic, Interactive Intelligence suspects
that call analysis and answering machine detection may be less accurate than with direct terminations
on Intel/Aculab boards and perhaps unacceptably so. For these reasons, Interactive Intelligence
recommends that predictive dialing only be done with direct terminations on Intel/Aculab voice
processing boards.
Outlook: Interactive Intelligence plans to test predictive dialing with certain VoIP gateways and SIP
configurations (especially using Intel HMP software on the CIC server). Also, Interactive Intelligence
is investigating the availability of more intelligent VoIP gateways capable of doing call analysis and
answering machine detection "at the edge" and thus avoiding the pitfalls of doing such work after the
conversion of voice to IP packets.
26 Fax Configuration
Our SIP technologies use the RTP protocol to transport audio across the IP network. Problems occur if
the same technique (RTP) that is used to transport audio is used to transport faxing and modem
communication, especially if compression, packet loss, or network delay occurs.
Even when using a completely uncompress audio codec like G.711 some minor audio anomalies do
occur. These are often so subtle they aren't detectable by the human ear when listening to normal
speech. These are significant to affect audio modulated data carriers (modems and fax).
Even at the slower data rates typically used by fax and modems (9600/14400 baud)
the anomalies in the transport can affect the stability of the carrier.
For faxing, the T.38 protocol solves the IP problem. T.38 encapsulates the T.30 data and handling
the problems that T.30 experiences over IP networks.
Also, HMP does not support T.30, only T.38.
Over IP, T.38 will be the only supported fax protocol.
26.1 Availability
T.38 is available with AudioCodes in CIC 2.2 SR-D and EIC 2.2 SR-A (via HF 1674). It is also
available in all 2.3 releases.
T.38 is available with HMP in CIC 2.2 SR-E. It is NOT available in EIC 2.2 releases. It is also available
in all 2.3 releases. With HMP, faxing is only possible via T.38.
• Via an “to send fax, press start now” option in the IVR. The sender, after dialing but before
sending the fax, can navigate the IVR informing the Interaction Center that a fax is coming.
• Configure a specific number (or group of numbers) as dedicated fax numbers.
• Use the RFC2833 CNG tone. This is currently not supported yet. This method works well with
low bit rate codecs, such as G.729 and g.723.
26.3 Scenarios
• Before the call is handed to the fax server, the IC server will re-invite the gateway to T.38
mode. NOTE: it is important that the gateway, on inbound calls, does not switch to T38 mode.
It should be instructed to do so by the Interaction Center.
• The gateway can reject the re-invite. For fax resources that require T.38 (as is the case with
HMP), the fax will disconnect; for other resources the call will continue as a voice conversation
would (via RTP). Without T.38, faxing could fail since faxes (T.30) does not work well over IP
(due to latency and packet loss).
• If the gateway accepts the re-invite, the IC server will switch the call into T.38 mode and pass
it to the fax server to begin receiving the fax.
• The IC server will OK the INVITE and stop listening to the RTP audio stream and instead begin
processing the T.38 messages, playing them to whichever device initiated the call
• In the event the gateway/receiving end never re-invites to T.38, the IC server will simply
continue the call as if it were a voice conversation (via RTP). If the codec selected involves
lossy compression, it is likely the fax will fail to transmit. For faxing resources that require
26.5.1 Cisco
Not all IOS versions support T.38, so you should consult Cisco's web site to find which version will
work with your platform. Additionally, during the course of I3 testing, the following versions were
found to have problems with T.38:
12.2(11)T
T.38 can be enabled globally or for each specific dial peer. To enable globally,
voice service voip
fax protocol t38 ls-redundancy 0 hs-redundancy 0
To enabled it on a specific dial peer,
dial-peer voice tag voip
dtmf-relay h245-signal
fax protocol t38 ls-redundancy 0 hs-redundancy 0
fax rate 14400
fax relay ecm-disable
session protocol sipv2
For more information about configuring T.38, please visit Cisco’s web site at
http://www.cisco.com/univercd/cc/td/doc/product/software/ios122/122newft/122t/122t11/faxapp/t38
.htm
• Manual dialing between systems can be accomplished with SIP addressing (the user will dial a
user extension, followed by an “@” sign, followed by the IC server name). For example, a user
with extension 101 on IC server A can dialed by users on server B or C by simply dialing
101@A.
• Tie lines can be configured between systems. A SIP line is no different than a T1 or ISDN line
and can be added to a line group in the very same manner. The dial plan can be configured
to use a line group when dialing a specific number or a specific set of numbers. For example,
when dialing 715-xxxx, the dial plan can be configured to modify the dial string to 715xxxx@B
and chose the line group with the SIP line can be used.
• Multi-site can be configured with SIP lines, just like any other T1 or ISDN lines. Again, in
Multi-site, each system is configured with a set of numbers indicating how to reach each other
system in the collective. So, on IC server A, you would configure xxx@B as the number to
reach IC server B. When someone on server A dials a user extension and that user extension
is on B, Multi-site will dial xxx@B to get to that server. xxx@B will be configured in the dial
plan to use the line group containing the SIP line.
29 Switchover Configuration
Read the Switchover white paper for the most up-to-date switchover information.
• OR run Messenger configured NOT to use a communication service. See the “SIP 3rd Party
Component Application Note” for details.
• OR start the Interaction Client before Messenger (Messenger could have or not have a
configured communication service). If not, Messenger will process the incoming calls, thus
blocking the Interaction Client from processing the calls.
In the Pages dialog, select Line Details form the Available list, as shown in the following figure.
31 Phone Services
Currently, phone services is only supported on the Cisco 7960/7940 SIP phones. However, this same
mechanism can be used by other phones, but is not included at this time. This mechanism is simply
linking a selection on the phone to a handler, which will then perform the requested feature.
Certain phones have displays that can be used to display menus. These menus can have many of the
same features that the Interaction Client has, such as record call. These displays can also have
custom menus, such as room service, checkout, order food, etc.
By default, the following features are available using phone services with a Cisco 7960/7940 SIP
phone:
1. Log in to (uses the IC Client’s user extension & password)
2. Log out
3. Change user status (Available, Out of Office,…)
4. Call control of current call (hold, transfer, voice mail, record, alert supervisor via email)
All these actions (login, logout, status change, call control) are implemented in the CiscoIPXML.ihd
handler and can be changed to add new features.
Instructions
1. Run the 2.2 CIC SR-C/2.2 EIC SR-A Cisco Phone Services install on a Web Server. The Web
Server must be running Internet Information Services (IIS). This Web Server does not need
to be the same computer as IC Server.
2. Using the Internet Information Services application, make sure that install directory (i3webs by
default) is shared as a web application on the Web Server.
32 Server Parameters
You can set the following values in the Server Parameters container in Interaction Administrator.
“Force Message Button “No” (default) Use to indicate whether the user id and password will be
Login” required at all times. By default, the user id and
“Yes” password are only required if the Interaction Client is not
at an available status.
33 Troubleshooting
33.2 Tracing
The flowing trace topics should be set to a trace level of Notes (61) when debugging TsServer issues.
33.4 Echo
• Echo is a challenging topic to troubleshoot. Make sure you understand echo (see section 10.2
“Echo”) before trying to locate and fix sources of echo.
• The direction of the echo is key to locating it and resolving it. Are the IC users hearing their
own voice or are the remote callers hearing their own voice? If the IC users hears their own
voice then the source of the echo is likely in the remote callers leg of the call.
• Use the RTP Audio Monitor and Analysis Guide to record the audio directly from the network
(see section 34.4 “RTP Audio Monitor and Analysis Guide”)
• Adjust the Audiocodes gain parameters. If the phones are transmitting too “hot”, the agent
could hear their own voice echoed back at them. In this case, the Network Gain can be slowly
turned down to help overcome the phone’s transmit levels.
• Some headphones are susceptible to acoustical echo. Be sure to use I3 certified headsets.
• Some phones generate echo if their volume is turned too high. Be sure to use I3 certified
headsets.
• If so, you have run out of voice resources. The cause is:
• For Intel/Dialogic HMP systems, check how many voice resource are allocated in the
Intel/Dialogic license file.
• For Audiocodes systems, voice resources are used from other Aculab or Intel boards. Make
sure you have configured these correctly.
33.6.3 DTMF from Managed Phone not being recognized by remote system
• See IVR DTMF Recognition Problem above. The phones and Interaction Center should be set
to RFC2833 if possible.
33.7 Miscellaneous
33.7.1 Selecting hold on the Interaction client puts the call in Held, put the IP phone still
shows connected.
• A SIP call can be held by either endpoint, and since the phone did not put the call on hold, it
can not take it off hold (since its side was never held). Thus, the hold state will not show on
the phone. The same goes for a call held by the phone and unheld by the client. It must still
be unheld by the phone for the complete audio path to be connected.
33.7.4 Internal Call made from SIP phone is placed correctly, but does not show up on
client.
Make a call from the phone to an internal number. If the call completes correctly but you do not see
the call on the Interaction Tab in the client, then this call is not being identified as a call from a
managed station. Solution: Check the “Line Details” page, then verify that the call’s Number field
exactly matches the value configured as the SIP Identification Address of the station in Interaction
Administrator (see section 21 “Creating and Configuring SIP stations in Interaction Administrator”).
33.7.5 Calls made from SIP phones do not show on Line Details Page
If the call does not show on the Line Details page (see section Error! Reference source not found.
“Error! Reference source not found.”), the SIP message in not making it to the Interaction Center
Server. The Interaction Center must be configured as the phone’s proxy or the proxy must be set to
send outbound calls from this managed station to the Interaction Center.
33.7.6 Phone rings when I use the MakeCall button in the Interaction Client
This is normal. The Interaction Center server must establish an audio path to the SIP phone. This is
accomplished by making a call to the phone. When you make a call from a client, and your phone is
a SIP phone (and not a SIP soft phone running with the audio-enabled client), and you do not have a
persistent connection, then the IC server call the phone.
34 Tools
• DSL and cable connections are shared (at some point in the network). At 3PM when the kids
come home from school, the extra traffic can compromise your bandwidth.
NetIQ’s Qcheck can test response times, throughput, and streaming
• Qcheck download (registration required): http://www.netiq.com/free/default.asp
• Qcheck Info: http://www.netiq.com/qcheck/default.asp
Instructions
1. Select UPD (on the left side)
2. Select Throughput (on the right side)
3. Load Qcheck on two servers (one server should be the Interaction Center server).
4. Put two servers (one as Endpoint 1 and one as Endpoint 2) in the drop down and get the
results (one server should be the Interaction Center server).
5. Swap the servers in the drop down list and get the results for audio in the other direction.
34.3 Speakeasy
Test upload and download speeds: http://chi.speakeasy.net/