Creating a SIP Stack

Applies to version(s): v2.9.

Session Initiation Protocol, more commonly known as SIP, is a signaling protocol for packet-based networks and is commonly used, along with H.323 to provide signaling for Voice over IP (VoIP) communications. You must configure SIP signaling for your system. The first step in doing so is to create a SIP stack:

1- Click SIP in the navigation panel

2- Click Create New Sip

3- Create the new SIP stack:

• Verify that the box labeled Enabled is checked
• Enter a name for the stack
• Click Create

4- Verify that the "SipCfg was successfully created" message appears

Path

/configurations/@[configuration_name]/sip_stacks/@[sipStack_Name]

Parameters (text)

/configurations/@[configuration_name]/sip_stacks/@[sipStack_Name]
enabled                        = true
hardware_unit                  = "@[hardware_name]"
name                           = "@[sipStack_Name]"

/configurations/@[configuration_name]/sip_stacks/@[sipStack_Name]/dns_parameters
cache_expire_time          = "12 hours"
enabled                    = false
query_retry_count          = 3
query_timer                = "20 seconds"
server_address             = ""
server_dns_port            = 53
use_cache                  = true
use_enum                   = false

/configurations/@[configuration_name]/sip_stacks/@[sipStack_Name]/dns_parameters/local_dns_transport_server
ip_interface = "@[hardware_name].@[voip_Name]"
port         = 1024
port_type    = "UDP"

/configurations/@[configuration_name]/sip_stacks/@[sipStack_Name]/header_parameters_and_timers
add_rport                   = true
allow_recurse               = false
always_send_100             = true
default_invite_expires      = "2 minutes"
default_register_expires    = "30 seconds"
default_session_timer_value = "30 minutes"
domain_name                 = "@[hardware_name]"
insert_accept               = true
insert_allow                = true
insert_date                 = true
insert_expires              = true
insert_supported            = true
insert_timestamp            = true
max_forward                 = 70
min_se_value                = "90 seconds"
organization                = ""
provisional_response_type   = "Supported"
subject                     = ""
t1_timer                    = "500 milliseconds"
t2_timer                    = "4 seconds"
t4_timer                    = "5 seconds"
use_compact_hdr             = false
use_fqdn_contact            = false
use_session_timer           = false

/configurations/@[configuration_name]/sip_stacks/@[sipStack_Name]/quirks_and_advanced_parameters
add_angle_brackets_around_sip_uri        = true
advanced_transport_servers_configuration = false
clear_subscriptions_on_call_complete     = false
etsi_ts102_0272_2006_compliant           = false
generate_space_after_colon               = false
refuse_initial_invite_with_to_tag        = false
support_latin_characters                 = false
support_method_update                    = true
support_pound_and_backslash_in_user_info = true
support_quotes_in_quoted_string          = false
support_spiral_call                      = false

Parameters (json)

{
  "dns_parameters" : {
    "cache_expire_time" : "12 hours",
    "enabled" : false,
    "local_dns_transport_server" : {
      "ip_interface" : "@[hardware_name].@[voip_Name]",
      "port" : 1024,
      "port_type" : "UDP"
    },
    "query_retry_count" : 3,
    "query_timer" : "20 seconds",
    "server_address" : "",
    "server_dns_port" : 53,
    "use_cache" : true,
    "use_enum" : false
  },
  "enabled" : true,
  "hardware_unit" : "@[hardware_name]",
  "header_parameters_and_timers" : {
    "add_rport" : true,
    "allow_recurse" : false,
    "always_send_100" : true,
    "default_invite_expires" : "2 minutes",
    "default_register_expires" : "30 seconds",
    "default_session_timer_value" : "30 minutes",
    "domain_name" : "@[hardware_name]",
    "insert_accept" : true,
    "insert_allow" : true,
    "insert_date" : true,
    "insert_expires" : true,
    "insert_supported" : true,
    "insert_timestamp" : true,
    "max_forward" : 70,
    "min_se_value" : "90 seconds",
    "organization" : "",
    "provisional_response_type" : "Supported",
    "subject" : "",
    "t1_timer" : "500 milliseconds",
    "t2_timer" : "4 seconds",
    "t4_timer" : "5 seconds",
    "use_compact_hdr" : false,
    "use_fqdn_contact" : false,
    "use_session_timer" : false
  },
  "name" : "@[sipStack_Name]",
  "quirks_and_advanced_parameters" : {
    "add_angle_brackets_around_sip_uri" : true,
    "advanced_transport_servers_configuration" : false,
    "clear_subscriptions_on_call_complete" : false,
    "etsi_ts102_0272_2006_compliant" : false,
    "generate_space_after_colon" : false,
    "refuse_initial_invite_with_to_tag" : false,
    "support_latin_characters" : false,
    "support_method_update" : true,
    "support_pound_and_backslash_in_user_info" : true,
    "support_quotes_in_quoted_string" : false,
    "support_spiral_call" : false
  },
 }

List of Parameters

• Enabled
• Name
• Unit

• Support Spiral Calls
• Generate Space After Colon
• Support # and \ in User Info
• ETSI TS 102 027-2 2006 Compliant
• Clear Subscriptions on Call Complete
• Support Quotes in Quoted String
• Support Latin Characters
• Add Angle Brackets Around SIP URI
• Support method UPDATE
• Refuse initial INVITE with To tag

Advanced

• Advanced Transport Servers configuration

• T1 Timer
• T2 Timer
• T4 Timer
• Default Register Expires
• Default Invite Expires

• Domain Name
• Subject
• Organization
• Provisional Response Type
• Use Fqdn Contact
• Add rPort
• Always Send 100
• Use Compact Hdr
• Allow Recurse
• Insert Date
• Insert Supported
• Insert Allow
• Insert Expires
• Insert Accept
• Insert Timestamp
• Max Forward

• Enabled
• Use Cache
• Use Enum
• Cache Expire Time
• Query Timer
• Query Retry Count
• Server Address
• Server DNS Port
• Local Port Type
• Local DNS Port
• Local IP Interface

• Use session timer
• Default session timer value
• Min-SE value