SIP Device Engines enable xMatters to send notifications to and receive responses from service providers using the Session Initiation Protocol (SIP). Be aware that each SIP account should have its own SIP Device Engine (i.e., each SIP account User Name must be unique to its SIP Device Engine). Also, SIP Device Engines must use a TTS language engine.
| Note: | xMatters deployments that will experience high volumes of SIP traffic must have SIP Device Engines configured on dedicated xMatters notification server Node computers (i.e., the xMatters notification server Node must reside on a computer that is separate from other xMatters components such as web servers, application servers, and the database). |
This protocol allows xMatters to make voice calls through a company PBX or SIP Gateway using Voice Over IP (VOIP) rather than lines from the telephone company.
| Note: | xMatters does not support phone extensions on SIP. |
In multiple-Company deployments, incoming SIP calls are routed based on the value of the incoming call’s CNAM (Caller ID name). (In single-Company deployments, all incoming SIP requests are routed to the default callin script.) The deployment PBX must be configured to create or replace the incoming CNAM value with the Company Name. This value is parsed by the SIP Device Engine to identify the caller’s associated Company, and pass the incoming call to the correct callin script. If the Device Engine receives a CNAM that does not match an existing Company Name, the Device Engine invokes the default error script, which plays a recording indicating that the call could not be routed.
For outbound SIP calls, the default scripts automatically populate the Caller ID field of the outbound call with the name of the Company associated with the Event, and use the Company’s call-in number, as specified on the Company details page.
| Note: | For general information about SIP Caller ID, see the SIP FAQ at http://www.egyed.com/faq/sip_faq.html#callerid. |
|
Detail |
Description |
|
Name |
Name used to identify this Device Engine. |
|
Description |
Brief description of this Device Engine (optional). |
|
Notification Polling (sec) |
How often (in seconds) the Device Engine polls the notification node for new alerts. Must be a whole number greater than or equal to 10 and less than or equal to 300. |
|
Logging |
For an explanation of Device Engine logging, see Enabling Device Engine logging. |
|
Number of Line Appearances |
Total lines available for outgoing and incoming SIP calls. The number of lines available for outgoing calls is the total number of line appearances less those reserved for incoming calls. |
|
Reserved for Incoming Calls |
The number of lines reserved for incoming SIP calls. |
|
Default Play/Date Format |
Default format to use when playing current time and date to Users as specified by the language file using the index file for phrases. The following tokens are supported: yyyy, yy, MM, DD, HH, mm, and ss; by default, the value is: |
| TTS Engine | Specifies the TTS Engine to use when playing Text-To-Speech (TTS). |
|
TTS Engine Personality |
Personality or voice to use when playing Text-To-Speech (TTS). This setting can also be changed in the xMatters script. TTS engines typically provide several different voices, like a male and female, but may also provide different languages. This requires that one or more TTS Engines are installed; SAPI is installed by default. |
|
ASR Engine Personality |
Personality or voice to use when playing Automatic Speech Recognition (ASR) methods. The default setting is Microsoft English Recognizer V5.1. |
|
Default Initial Language |
Determines the regional language settings to use when playing a language. |
|
Call-in Silence Threshold |
The threshold to use to determine silence on the line. Larger values are less sensitive to static. Valid values are from 0 to 65535; the default value is 256. |
|
Codec List |
The codec list supported by the Device Engine. Select one of the following options: Ulaw: standard telephone codec for North American calls. Alaw: standard telephone codec for European calls. |
|
Default Call-in Script |
Name of the script used to handle the communication for incoming calls. Note that this value overrides the "Sip Call In Script" setting on the Company details page. |
|
Inbound SIP Registration List |
This area displays an editable list of inbound SIP registrations available to the SIP Device Engine. Click Add New Inbound SIP Registration to create a new registration, and specify the settings as described in the table "Inbound SIP Registration settings", below. To remove a registration, select the check box next to the registrations you want to remove, and then click Remove Selected Inbound SIP Registrations. |
The following table describes the Inbound SIP Registration Settings:
|
Detail |
Description |
|
SIP Server Address |
IP address of the SIP server with which xMatters will register. |
|
SIP Server Port |
Port to use on the SIP server. |
|
SIP Local Port |
Local port to which the Device Engine will bind and which the SIP Server will use to communicate with xMatters. |
|
SIP Local Address |
IP address that the Device Engine will bind to and listen for SIP calls. |
|
SIP Domain |
Domain used by the SIP server; this domain name will be included in the SIP messages. |
|
SIP Outbound Proxy Address |
If required, the IP address of the outbound proxy server. |
|
SIP Outbound Proxy Port |
If required, the port of the outbound proxy server. |
|
RTP Port (min) |
The lower limit to the port number on which RTP is allowed (default is 1025). If you are using a firewall, you must also open a range of ports based on the RTP Port (min) and RTP Port (max). |
|
RTP Port (max) |
The upper limit to the port number on which RTP is allowed (default is 65535). If you are using a firewall, you must also open a range of ports based on the RTP Port (min) and RTP Port (max). |
|
DTMF Payload ID |
The default value is 101, though some SIP Server environments may require a different value. Contact your SIP Server Administrator for more information. Note that the xMatters SIP Device Engine supports only RFC2833 for DTMF tones. |
|
Registration Attempts |
How many times the Device Engine should attempt to register with the SIP server. |
|
Registration Timeout |
How long, in seconds, the Device Engine should wait before timing out on a registration attempt. The default is 60. |
|
Session Timeout |
How long, in seconds, the Device Engine should wait to timeout a SIP session. The default is 3600. |
|
User Name |
The user name to use on the SIP server. |
|
Password |
The password, if required, for the user name on the SIP server. |
|
Display Name |
Name displayed as source of call. |
The xMatters SIP Device Engine supports only RFC2833 for DTMF tones.