IP Call Control Module Specific Settings
Maximum SIP Sessions:
[sip_max_sessions] This parameter specifies the maximum number of concurrent session initiation protocol (SIP) call control sessions. Set this value to a number that at least doubles the number of channels in the system because the system can be tearing down a call while processing the next call.
Primary Gateway:
[sip_default_gateway] This parameter specifies the IP address of a default gateway to use for outbound calls. If a user only specifies a phone number when making a SIP call and the application is not using a SIP proxy server, the API forwards the call to the gateway specified with this parameter. The API forwards the specified phone number to the gateway for routing purposes. When set, this parameter must contain an IP address of type IPv4, IPv6, or Hostname in the form: IP address:Port Number The API does not use this parameter if the configuration file specifies a sip_registration_server or sip_proxy_server.
Additional SIP Gateway #2:
[sip_gateway2] This parameter specifies the SIP Gateway 2 URL.
Additional SIP Gateway #3:
[sip_gateway3] This parameter specifies the SIP Gateway 3 URL.
Additional SIP Gateway #4:
[sip_gateway4] This parameter specifies the SIP Gateway 4 URL.
Primary Proxy Server:
[sip_proxy_server1] This parameter specifies the SIP proxy server 1 URL.
Additional Proxy Server #2:
[sip_proxy_server2] This parameter specifies the SIP proxy server 2 URL.
Additional Proxy Server #3:
[sip_proxy_server3] This parameter specifies the SIP proxy server 3 URL.
Additional Proxy Server #4:
[sip_proxy_server4] This parameter specifies the SIP proxy server 4 URL.
Primary Registrar Server URL:
[sip_registration_server1] This parameter specifies the SIP registration server 1 URL.
Additional Registrar Server #2:
[sip_registration_server2] This parameter specifies the SIP registration server 2 URL.
Additional Registrar Server #3:
[sip_registration_server3] This parameter specifies the SIP registration server 3 URL.
Additional Registrar Server #4:
[sip_registration_server4] This parameter specifies the SIP registration server 4 URL.
From Value:
[sip_From] This parameter specifies the value provided in the SIP header for the From parameter. The From parameter contains a display name and a SIP uniform resource identifier (URI) or SIPS (secure SIP) URI that identifies the originator of the session request.
Contact IPv4 Address:
[sip_Contact] This parameter specifies the value provided in the SIP header for the Contact parameter. The Contact parameter contains a SIP uniform resource identifier (URI) or SIPS (secure SIP) URI that defines the address of the sender. When this parameter is set to its default value ( sip_Contact=0.0.0.0 ), the SIP stack uses the IPv4 address of the local host and port 5060. If the host has not registered its host name, the SIP initialization process will fail and SIP calls will not be processed. To process SIP calls in this case, the value in the sip_Contact parameter must be specifically set to an IPv4 address of one of the host network interface boards with an optional name pre-pended. When set, this parameter must contain an IPv4 address in the form: xxx.xxx.xxx.xxx:PortNumber or username@xxx.xxx.xxx.xxx:PortNumber. This parameter is ignored when the parameter IP Interface For SIP [sip_ip_interface] is set.
Username:
[sip_username] This parameter specifies the name inserted into the o= line in the SIP session description protocol (SDP). The o= line defines the owner or creator of the session and the session identifier. This value must not contain spaces. A dash or hyphen character indicates the absence of an owner name or session ID.
Session Name:
[sip_session_name] This parameter specifies the value used for the s= line in the SIP SDP. The s= line provides a textual string that gives a name to the session.
Session Description:
[sip_session_description] This parameter specifies the value used for the i= line in the SIP SDP. The i= line provides a textual string that describes the session’s purpose or provides information about the session.
Description URI:
[sip_description_URI] This parameter specifies the value used for the u= line in the SIP SDP. The u= line identifies the SIP uniform resource identifier (URI) of the session description.
Email Address:
[sip_email] This parameter specifies the value used for the e= line in the SIP SDP. The e= line identifies the email address of the person or entity responsible for the session.
Phone Number:
[sip_phone] This parameter specifies the value used for the p= line in the SIP SDP. The p= line identifies the phone number to associate with the session. Phone numbers use the conventional international format: the number preceded by a + (plus symbol), the country code and a space or hyphen character. For example: +1 408-370-0881
Advanced Settings
Primary Registrar Server Address of Record:
[sip_registration_server1_aor] This parameter specifies the SIP registration server 1 address of record. The address of record is set in the To: and From: fields in the SIP REGISTER message.
Primary Registrar Server Username:
[sip_registration_server1_username] This parameter specifies the username used as part of the authentication process when the registration server 1 requires authentication. Authentication is based on RFC2617.
Primary Registrar Server Password:
[sip_registration_server1_password] This parameter specifies the password used as part of the authentication process when the registration server 1 require authentication. Authentication is based on RFC2617.
Primary Registrar Server Expiration:
[sip_registration_server1_expires] This parameter specifies the expiration interval in seconds for registration server 1.
Additional Registrar Server #2 AOR:
[sip_registration_server2_aor] This parameter specifies the SIP registration server 2 address of record. The address of record is set in the To: and From: fields in the SIP REGISTER message.
Additional Registrar Server #2 Username:
[sip_registration_server2_username] This parameter specifies the username used as part of the authentication process when the registration server 2 requires authentication. Authentication is based on RFC2617.
Additional Registrar Server #2 Password:
[sip_registration_server2_password] This parameter specifies the password used as part of the authentication process when the registration server 2 require authentication. Authentication is based on RFC2617.
Additional Registrar Server #2 Expiration:
[sip_registration_server2_expires] This parameter specifies the expiration interval in seconds for registration server 2
Additional Registrar Server #3 AOR:
[sip_registration_server3_aor] This parameter specifies the SIP registration server 3 address of record. The address of record is set in the To: and From: fields in the SIP REGISTER message.
Additional Registrar Server #3 Username:
[sip_registration_server3_username] This parameter specifies the username used as part of the authentication process when the registration server 3 requires authentication. Authentication is based on RFC2617.
Additional Registrar Server #3 Password:
[sip_registration_server3_password] This parameter specifies the password used as part of the authentication process when the registration server 3 require authentication. Authentication is based on RFC2617.
Additional Registrar Server #3 Expiration:
[sip_registration_server3_expires] This parameter specifies the expiration interval in seconds for registration server 3.
Additional Registrar Server #4 AOR:
[sip_registration_server4_aor] This parameter specifies the SIP registration server 4 address of record. The address of record is set in the To: and From: fields in the SIP REGISTER message.
Additional Registrar Server #4 Username:
[sip_registration_server4_username] This parameter specifies the username used as part of the authentication process when the registration server 4 requires authentication. Authentication is based on RFC2617.
Additional Registrar Server #4 Password:
[sip_registration_server4_password] This parameter specifies the password used as part of the authentication process when the registration server 4 requires authentication. Authentication is based on RFC2617.
Additional Registrar Server #4 Expiration:
[sip_registration_server4_expires] This parameter specifies the expiration interval in seconds for registration server 4.
Registration Interval:
[sip_registration_interval] This parameter specifies the interval in minutes at which SIP registration messages are sent when no expires parameter is present in the Contact header and no Expires header is present.
Registration Interval Delta:
[sip_registration_interval_delta] This parameter specifies to reregister this many seconds before the registration expires.
Registration Proxied:
[sip_registration_proxied] This parameter selects if the SIP REGISTER will be sent to the active SIP Proxy Server.
Maximum Forwards:
[sip_Max-Forwards] This parameter specifies the value provided in the SIP header for the Max-Forwards parameter. The value in the Max-Forwards parameter serves to prevent loops by limiting the number of hops a SIP request can make on the way to its destination. The value consists of an integer that the system decrements by one at each hop. When this value reaches 0, the system discards the request.
Contact IPv6 Address:
[sip_ContactV6] This parameter specifies an IPv6 address value provided in the SIP header for the Contact parameter. The Contact parameter contains a SIP uniform resource identifier (URI) or SIPS (secure SIP) URI that defines the IPv6 address of the sender. When this parameter is set to its default value ( sip_ContactV6=[::] ), the SIP stack uses the IPv6 address of the local host and port 5060. If the host has not registered its host name, the SIP initialization process will fail and SIP calls will not be processed. To process SIP calls in this case, the value in the sip_ContactV6 parameter must be set to an IPv6 address of one of the host network interface boards with an optional name pre-pended. When set, this parameter must contain an IPv6 address in the form: [%]:PortNumber or username@[%]:PortNumber. This parameter is ignored when the parameter IP Interface for SIP [sip_ip_interfaceV6] is set.
Route URL:
[sip_Route] This parameter specifies the value provided in the SIP header for the Route parameter. The Route parameter contains the address or multiple addresses of proxy servers. The system uses the Route parameter to force routing of a request through the listed set of proxies.
Session Timeout:
[sip_session_timer_session_expires] Maximum time in seconds before a session is considered timed-out without a successful INVITE or OPTIONS transaction. A value of 0 means the session timer feature is disabled. Values in the range 1 to 89 will use 90.
Session Refresh Interval:
[sip_session_timer_minse] Establishes the lower bounds for the session refresh interval in seconds. Values in the range 0 to 89 will use 90.
Session Refresh Method:
[sip_session_timer_refresh_method] Defines the SIP method used to refresh the session. A value of 0 means use the INVITE method and a value of 1 means use the UPDATE method.
IP Preference For SIP:
[sip_ip_preference] This parameter sets the IP family preference that should be used for SIP call control. Valid values are ipv4_only, ipv6_only, ipv4_preferred and ipv6_preferred.
IPv4 Interface For SIP:
[sip_ip_interface] This parameter sets the IPv4 interface that should be used for call control. When left blank the parameter Contact IPv4 Address [sip_Contact] will be used. When set the parameter Contact IPv4 Address [sip_Contact] will be ignored.
IPv6 Interface For SIP:
[sip_ip_interfaceV6] This parameter sets the IPv6 interface that should be used for call control. When left blank the parameter Contact IPv6 Address [sip_ContactV6] will be used. When set the parameter Contact IPv6 Address [sip_ContactV6] will be ignored.
IPv4 Interface Port:
[sip_ip_interface_port] This parameter sets the IPv4 port that should be used for call control. This parameter is used when the parameter IPv4 Interface For SIP [sip_ip_interface] has been set.
IPv6 Interface Port:
[sip_ip_interface_portV6] This parameter sets the IPv6 port that should be used for call control. This parameter is used when the parameter IPv6 Interface For SIP [sip_ip_interfaceV6] has been set.
Redirect As Calling Party:
[sip_redirect_as_calling_party] Specifies whether or not to report the redirect number as the calling party number to the application. Set the parameter as follows: 0 - Causes the system to use the original calling party number as the number reported to the application. 1 - Causes the system to use the redirect number as the calling party number reported to the application. Selecting this option removes any association between the original calling party number and the call.
T1 Timeout Retransmission:
[sip_T1_timeout] This parameter sets the INVITE retransmit timeout (ms) and doubles after every retransmission. The estimated round-trip time (RTT).
Maximum INVITE Retransmissions:
[sip_max_invite_retransmissions] This parameter sets the maximum number of INVITE request transmissions. A call will terminate after the INVITE has been transmitted this many times. If no response is received after T1 Timeout Retransmission [sip_T1_timeout], the INVITE will be retransmitted at an interval of double the previous timeout.
Redirect As Called Party:
[sip_redirect_as_called_party] Specifies whether or not to report the redirect number as the called party number to the application. Set the parameter as follows: 0 - Causes the system to use the original called party number as the number reported to the application. 1 - Causes the system to use the redirect number as the called party number reported to the application. Selecting this option removes any association between the original called party number and the call.
TCP Enable:
[sip_tcp_enable] This parameter is used to enable/disable TCP transport protocol functionality for the SIP stack.Valid values are true and false.
User-Agent:
[sip_user_agent] This parameter specifies a text description of the software/hardware/product provided in the User-Agent header. The syntax is specified in RFC 3261.
RFC 3325 Identity:
[sip_RFC3325_Identity] Inserts an Identity header and Privacy header with the identity of the call originator specified in the calling_party parameter. Set the parameter as follows: 0 - No RFC 3325 Identity or Privacy headers will be inserted. 1 - Insert the header Privacy=none and P-Asserted-Identity with the calling_party for outbound calls. 2 - Insert the header Privacy=none and P-Preferred-Identity with the calling_party for outbound calls.
Transport Protocol:
[sip_transport_protocol] This parameter specifies what transport protocol (either UDP or TCP) should be used for outbound SIP calls. Valid values are udp and tcp.
Response code for Call Not Answered:
[sip_reject_call_not_answered] This parameter specifies the SIP response code to transmit when an inbound SIP call is received and a call is not answered by the application. This can occur when all channels are busy, when a call is completed but the application has not restarted ring detection or when the Boston Host Service has been started and a call arrives before the application is started.
Response code for Unsupported Media:
[sip_reject_unsupported_media] This parameter specifies the SIP response code to transmit when an inbound SIP INVITE is received and the SDP doesn't contain any supported media types.
Response code to reject T.38 renegotiation:
[sip_reject_t38_renegotiation] This parameter specifies the SIP response code to transmit when an inbound SIP INVITE is received that specifies a codec of T.38 in the SDP and the Fax Transporting Protocol parameter [fax_transport_protocol] is set to G.711 pass-through only (i.e. t38_never).
100 TRYING Enable:
[sip_100_call_not_answered] This parameter is used to enable/disable transmit of SIP 100 TRYING when inbound call not answered. Valid values are true and false.
RFC 6913 Enable:
[sip_RFC6913_enable] This parameter is used to enable/disable support for the fax media-feature tag specified in RFC 6913. Valid values are true and false.
SIP OPTIONS UP Interval:
[sip_options_up_interval] This parameter specifies the interval to transmit SIP OPTIONS requests to SIP Gateways when their status is currently UP.
SIP OPTIONS DOWN Interval:
[sip_options_down_interval] This parameter specifies the interval to transmit SIP OPTIONS requests to SIP Gateways when their status is currently DOWN.