sip_route

Handles SIP route interface data.

Format
  • sip_route:
    • -Print -profile list (offered in your market): sip_route -print -profile
    • -Print profile list (offered in all markets): sip_route -print -profile -all-markets
    • -Print profile data: sip_route -print -profile a
    • -Print route data: sip_route -print -route [ -short]
    • -Remove route data: sip_route -remove -route
  • sip_route (Outgoing traffic):
    • -set -route [ -profile a] [ -service s] [ -remoteport y] [ -protocol z] [ -proxyip x] [ -proxyport u] [ -routeset v] [-addheader a] [ -uristring0 "s"] [ -uristring1 "s"] [ -uristring2 "s"] [ -uristring3 "s"] [ -uristring4 "s"] [ -uristring5 "s"] [ -uristring6 "s"] [ -uristring7 "s"] [ -fromuri0 "f" ] [ -fromuri1 "f"] [ -fromuri2 "f" ] [ -fromuri3 "f"] [ -fromuri4 "f" ] [ -fromuri5 "f"] [ -fromuri6 "f" ] [ -fromuri7 "f"] [ -remotetelip "r"] [ -rexfromuri "e"] [ -rexstring "e"]

  • sip_route (Incoming traffic):
    • -set -route [ -profile a] [ -service s] [ -accept x] [ -match x] [ -priority p] [ -contextb0 "p"] [ -contextb1 "p"] [ -contextb2 "p"] [ -contextb3 "p"] [ -contextb4 "p"] [ -contextb5 "p"] [ -contextb6 "p"] [ -contextb7 "p"] [ -contexta0 "p"] [ -contexta1 "p"] [ -contexta2 "p"] [ -contexta3 "p"] [ -contexta4 "p"] [ -contexta5 "p"] [ -contexta6 "p"] [ -contexta7 "p"] [ -mwinumber "n"] [ -handleasexn "h"] [ -challenge "c"]

  • sip_route (Emergency call data):
    • -set -route -accept EMERGENCY -match "x" -sosanumber "d" -uristring0 "sip:?@" [ -priority pp]

  • sip_route (Third-party registration):
    • -set -route [ -register l] [ -timer t] [ -numbers 123...321] [ -registerstring "s"] [ -registerport p] [ -proxyip x] [ -proxyport u] [ -routeset v] [ -addheader a] [ -supervise s] [ -supervisetime t] [-localdomain "l"]

  • sip_route (Set Digest Credentials):
    • -set -route [ -realm "r" -authname "a" -password "w" ]

  • sip_route (Set Trusted network interoperability):
    • -set -route -trusted t

  • sip_route (Set codec filtering):
    • -set -route -codecs c

Function

The sip_route command is used to administrate route data specific to SIP trunks. The data is in addition to the traditional route data. When initiating a SIP trunk, you need to use sip_route and then ROCAI, RODAI and ROEQI. Changes to sip_route data can be made without removing RO-data.

Execution
  1. sip_route -set [-profile <trunk profile name>] -route Y -uristring0 "sip:?@<SIPreqURI>",[other sip_route parameters needed or required by the profile -Profile include parameters-]
  2. ROCAI:ROU=Y, SIG={D11=A for SIP route}, other service parameters.
  3. RODAI:ROU=Y,TYPE=TL66,VARI=00000000,VARC=00000000,VARO=00000000;

    If sip_route -profile is set then VARI,VARC,VARO must have zeros. Instead, this configuration is set in the profile listed as -Profile line protocol parameters-.

  4. ROEQI:ROU=Y,TRU=<lim>->-<first sequence number>&&<lim>-<lastsequence number>

    The TRU parameter defines the LIMs and capacity used for SIP signaling for this route.

    Example: Set route which limits the route to signal via lim 3 with maximum 60 concurrent calls.ROEQI:ROU=Y,TRU=3-1&&3-60;

    Note: The sip route command has to be executed before "ROEQI", which ties equipment to the route.

  5. Define access code which direct outbound calls to this route RODDI:ROU=Y,DEST=<dest-number>

Parameters

Examples

Notes

Sip routes can be configured just to register subscribers in remote system without traffic configuration.

For information how to use type of number conversion: see commands "RODDI:ADC=..", "LCDDI:BTON..." and "number_conversion_initiate".

context:

ContextaX and contextbX is normally used to match "phone-context=..." or "trunk-context=...".

ContextaX and contextbX is setting type of number (TON) to "International number" if "+" is found, or if the contextX1 is matched. "Unknown public number" is set if string contextX0 is matching or if no other contextxX string is matching.

fromuri:

If no fromuri data is present for the used type of number, then "fromuri0" is used if configured. If "fromuri0" is empty, then "uristring0" is used.

When "uristring0" is used and registration is not used then the host portion is replaced with the server FQDN.

The A-number is inserted at the "?" position, or a rexstring (see 'rexstring' description) may be inserted at a "!" position. Format is "sip:[email protected]".

An ipv6 address must be sourrounded by brackets: "sip:?@[2001:DB8::2C]". The default type of number for an internal party making an outgoing call is "Unknown private number" but this can be changed depending on other configuration in system (; for example, number conversion).

uristring:

Request uri in SIP requests (that is, INVITE).

The destination of the request is resolved from the uristring and remoteport (see 'remoteport' description). The "?" position is substituted with the B-number. An ipv6 address must be sourrounded by brackets: "sip:?@[2001:DB8::2C]". If no uristring data is present for the used type of number then "uristring0" will be used.

Format is "sip:[email protected]"

"tel:?"

"tel:?;phone-context=+1-1234-555-1000"

"tel:?;phone-context=sub.company.com"

A special format is "sip:?@(host1|host2|host3|...)"

It will cause each telephony server to select one of the hosts in a round-robin fashion.

DNS lookup:

MX-ONE supports multiple A-Records in a DNS SRV lookup if port "0" is used. If -records are returned a second lookup to the DNS is done with the A-Record.

The result of the A-record may contain more than one IP address. The order of the list is the priority by which MX-ONE will attempt to send INVITE until the call is successful. No answer or 503 Service Unavailable will trigger MX-ONE to try the next entry.