Versions Compared

Old Version 5

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 6

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterDescription

bci

Use this object to configure Backward Call Indicator (BCI) for Egress IP attributes.

  • bciInterworkEncountered – Enable flag to indicate that ISUP is interworking with a network which is not capable of providing as many services as ISUP does. ISUP networks will therefore not employ certain features they otherwise normally would, including potentially the use of ISDN cause codes in failure conditions .
    • disable (default)
    • enable
  • bciIsdnAddess – Enable flag to enable ISDN Address in the BCI parameter of backward SS7 messages (e.g. ACM or ANM).
    • disable (default)
    • enable

...

Code Block
languagenone
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes domainName 
	useIpSignalingPeerDomainInRequestUri <disable | enable> 
	useSipDomainNameInFromField <disable | enable> 
		preserveIngressFromDomainName <disable | enable> 
		useLowerCaseDomainNames <disable | enable> 
	useSipDomainNameInRequestUri <disable | enable> 
		preserveIngressRUriDomainName <disable | enable> 
		useLowerCaseDomainNames <disable | enable> 
	useZoneLevelDomainNameInContact <disable | enable>

	useZoneLevelDomainNameInPathHdr <disable | enable>

Command Parameters

Caption
0Table
1Domain Name Parameters
3Domain Name Parameters
 

Parameter

Description

useIpSignalingPeerDomainInRequestUri 

Enable flag to use IP Signaling Peer Domain in Request URI.

  • disable (default)

  • enable

 useSipDomainNameInFromField

By default, 

Spacevars
0product
uses its IP address as the host-port of the FROM URI in the outgoing INVITE message. Enable flag to use the originating gateway information returned in the policy response as the host-port of the FROM URI in the outgoing INVITE message.  

  • disable (default)
  • enable

When useSipDomainNameInFromField is enabled, the following parameters are available:

  • preserveIngressFromDomainName – If a SIP domain is configured for the ingress trunk group and this flag is enabled, the default gateway associated with that SIP domain will be the originating gateway. Otherwise, the originating gateway will be the default gateway associated with the SIP domain associated with the Softswitch entity.
    • disable (default)

    • enable

  • useLowerCaseDomainNames – Set flag to allow lower case domain name.
    • disable (default)

    • enable

Note

The above two flags only apply when a domainName is configured for this zone (see Zone - CLI page).


 useSipDomainNameInRequestUri

Use this flag to specify indicate how to treat SIP Domain name in outgoing SIP INVITE.

  • disable – 
    Spacevars
    0product
    includes the IP address in the host-port portion of the Request-URI in outgoing SIP INVITE messages.
  • enable –
    Spacevars
    0product
    includes the trunk group domain associated with egress trunk group as destination domain name in outgoing SIP INVITE messages.

When useSipDomainNameInRequestUri is enabled, the following parameters are available:

  • preserveIngressRUriDomainName – Preserve Ingress R-URI Domain Name Flag. When enabled, the ERE/
    Spacevars
    0product
    uses domain name received in the Request-URI as destination domain name in outgoing SIP INVITE messages. Normally, outgoing SIP INVITE messages contain the trunk group domain assigned to egress trunk group.
    • disable (default)
    • enable
  • useLowerCaseDomainNames – Set flag to allow lower case domain namenames.
    • disable (default)
    • enable

useZoneLevelDomainNameInContact

Enable flag to use Zone level domain name in the Contact header.

  • disable (default) 
  • enable
useZoneLevelDomainNameInPathHdrTBD - SBX-3830

Enable flag to send the Domain Name configured at the Zone level in the Path Header of the outgoing REGISTER message.

  • disable (default) 
  • enable

Flags

Use this object to set egress IP attribute flags.

...

Code Block
languagenone
% set profiles signaling ipSignalingProfile <SIP profile name> egressIpAttributes flags
	addLoopBackRouteHeader <disable | enable>
	bgcfTargetSchemeTransparency <disable | enable> 
	convertInactiveToSendrecv <disable | enable> 
	disable2806Compliance <disable | enable> 
	disableOptionalRegisterParameters <disable | enable> 
	ignoreSdpAfterOfferAnswerCompleted <disable | enable>
	includeEnumParameters <disable | enable>
	map3xxContactUrlToRouteHeader <disable | enable>
	map181Or182MessageTo183 <disable | enable> 
	mapContractorNumberInPSigInfoHeader <disable | enable> 
	qosBasedRouting <disable | enable> 
	sameCallIdForRequiredAuthorization <disable | enable>
	suppressUnregister <disable | enable>
	transitPAIFromUnregisteredPeer <disable | enable>
	ttcIsupMapping <disable | enable> 
	useCalledPartyInRequestUri <disable | enable> 
	useColonInSdpMediaTypeParameter <disable | enable> 
	validateIsubAddress <disable | enable>

...

Caption
0Table
1Flags Parameters
3Flags Parameters
 

ParameterDescription
bgcfTargetSchemeTransparencyaddLoopBackRouteHeader

Enable flag to add the SBC URI as the second top-most Route header in the INVITE towards EATF.

  • disable (default)
  • enable
bgcfTargetSchemeTransparencyEnable flag to preserve the scheme preserve the scheme used by the SIP INVITE Request-URI when the INVITE is routed by the
Spacevars
0product
, acting as a BGCF supporting Tel-URL. When disabled, the SBC changes the scheme used by the Request-URI parameter to SIP in the egress INVITE message.
  • disable (default)
  • enable
convertInactiveToSendrecvEnable flag to control the a-line in the SDP of an egress SIP INVITE message by converting a=inactive to a=sendrecv. When disabled, the 
Spacevars
0product
continues to use a=inactive, when appropriate, in the egress INVITE message.
  • disable (default)
  • enable
disable2806Compliance

If enabled, the 2806 Compliance Code is disabled and no phone context or user=phone parameters are signaled in egress messages.

  • disable (default)
  • enable
disableOptionalRegisterParametersEnable flag to prevent 
Spacevars
0product
from sending the DTG (Destination Trunk Group) parameter in the Contact header of egress REGISTER messages.
  • disable (default)
  • enable
ignoreSdpAfterOfferAnswerCompletedEnable flag to allow the SBC to ignore the new SDP at the egress leg in subsequent 1xx-rel or final 200 OK messages after the Offer Answer for the initial Invite dialog was completed by an earlier 1xx-rel (and does not trigger a new offer or answer).
  • disable (default)
  • enable
includeEnumParametersUse this flag to specify how to handle ENUM parameters in outgoing INVITE.
  • disabled (default) – SBC drops ENUM parameters received from ENUM server.
  • enabled – SBC sends ENUM parameters in the outgoing INVITE
map3xxContactUrlToRouteHeaderTBD. In 5.1 code

When map3xxContactUrlToRouteHeader  flag is enabled,  SBX adds 3XX contact header as second route header in the outgoing INVITE message.

This flag is enabled on a IBCF TG because when a call is routed by ECSCF to IBCF, the 3xx contact URI need to be added as second route header for subsequent routing to IP-PSAP.

  • disable (default)
  • enable
map181Or182MessageTo183Enable flag to allow 
Spacevars
0product
to map 181 or 182 response messages to 183. When disabled, the SBC handles 1xx response messages normally.
  • disable (default)
  • enable
mapContractorNumberInPSigInfoHeaderEnable flag to map the Contractor Number parameter into the outgoing SIP P-Sig-Info header. The P-Sig-Info header is a customer-specific SIP header used to convey ISUP information in SIP messages.
  • disable (default)
  • enable 
qosBasedRouting

Enable flag to allow QoS-based routing.

  • disable (default)
  • enable
sameCallIdForRequiredAuthorization???

Enable this flag to support sending an INVITE with credentials on receiving a 401 (Unauthorized) or 407 (Proxy Authentication Required) response to initial INVITE with the same call ID as in the original INVITE.

  • disable (default)

  • enable

suppressUnregister

Enable flag to prevent 

Spacevars
0product
from sending an unregister message (Register=0) to the registrar upon expiration of a SIP UA registration. When disabled, the 
Spacevars
0product
generates unregister messages on the egress leg if the UA does not refresh the registration on time.

  • disable (default)
  • enable 

transitPAIFromUnregisteredPeer

???

Enable flag to transparently pass the received PAI to the INVITE if the default PUI procedure cannot add a PAI header.

  • disable (default)
  • enable 
Note

To use this flag, you must enable the enableDefaultPUIProcedures flag and disable the privacy transparency flag.

 


ttcIsupMappingWhen enabled, and when the IP protocol type of the IP signaling profile entry is SIP or SIP-I, the application that receives the 
Spacevars
0product
policy response (which can be either the SIP signaling gateway application on the 
Spacevars
0product
or the SIP core proxy on the
Spacevars
0product
) applies the mapping necessary for TTC-ISUP signaling.
  • disable (default)
  • enable 
 useCalledPartyInRequestUri When enabled, the 
Spacevars
0product
copies the username selected for the "To" header to the Request URI instead of the registered username. When disabled, the 
Spacevars
0product
includes the registered username in the Request URI. This flag is used when interoperating with IP-PBXs that require the real end station number in the Request URI in order to do proper routing of calls terminating on them.
  • disable (default)
  • enable
useColonInSdpMediaTypeParameter

When enabled, a colon (:) is used as the separator between the SDP Media Type parameter key and value. When disabled, an equal sign (=) is used as the separator between the SDP Media Type parameter key and value.

  • disable (default)
  • enable
validateIsubAddress

 When enabled, the 

Spacevars
0product
validates ISUB digits for called and calling parties. When isabled, the 
Spacevars
0product
will not validate ISUB digits.

...

ParameterDescription
flags

Privacy flags: 

  • includeEmbeddedPaiHeaderInRedirectedInvite – Enable this flag to include the embedded PAI header in the redirected Invite message.
    • disable (default)
    • enable
  • includePrivacy – Use this flag to specify whether the SBC includes privacy information in outgoing SIP INVITE messages.
    • disable – The 
      Spacevars
      0product
      does not include a P-Preferred-Identity header or a P-Asserted-Identity header, an Anonymous identifier in the SIP From field, or a Privacy header that contains a Critical token in outgoing SIP INVITE messages, and the 
      Spacevars
      0product
      will not include a P-Asserted-Identity header or a Privacy header that contains a Critical token in outgoing SIP INVITE messages.
    • enable (default) – The 
      Spacevars
      0product
      includes either a P-Preferred- Identity header or a P-Asserted-Identity header (provisioned in Privacy Information above) in outgoing SIP INVITE messages. The 
      Spacevars
      0product
      will include a P-Asserted-Identity header in outgoing SIP INVITE messages. The 
      Spacevars
      0product
      will also insert an Anonymous identifier in the SIP From field and the 
      Spacevars
      0product
      will include a Privacy header that contains a Critical token.
  • msLyncPrivacySupport – Backward compatibility for the Caller Privacy feature. The Caller privacy feature only works if this flag is enabled.
    • disable (default)
    • enable
  • privacyRequiredByProxy – Enable flag to indicate that privacy service is mandated for any calls to the SIP trunk (proxy). In this case, the 
    Spacevars
    0product
    includes a Proxy-Require header with a privacy value, and a critical token in the Privacy header of the INVITE message. The privacy service must be applied by the proxy or the call is rejected. If disabled, the 
    Spacevars
    0product
    does not include a Proxy-Require header with privacy value. The proxy accepts the call even if it cannot provide privacy service.
    • disable (default)
    • enable
privacyInformation

Use this object to specify which of the following headers the 

Spacevars
0product
uses when sending privacy information in outgoing SIP INVITE messages:

  • pAssertedId – Used among trusted SIP entities (typically intermediaries) to carry the identity of the caller as it was verified by authentication.
  • pPreferredId – Used by a User Agent (UA) to carry the identity the caller wishes to be used, and sent to a trusted proxy to be inserted in the P-Asserted-Identity field.
  • remotePartyId – Used among trusted SIP entities (typically intermediaries) to carry the identity of the caller as it was verified by authentication. This header is specified in an earlier RFC that continues to be supported.
transparency

 Enable flag to allow ingress Privacy information to pass through unchanged.

  • disable (default)
  • enable

...

ParameterDescription
contactHandlingSelect one of the following to control processing of contacts received in SIP Redirects:
  • mergeReceivedContacts – Contacts received in Redirects are ordered by q-value and inserted at the head of the list of untried contacts.
  • purgeExistingContacts – Contacts received in Redirects are ordered by q-value and replace untried contacts.
flags

Redirect flags:

  • forceRequeryForRedirection – (applies to Invite requests only) Use flag to re-query ERE with contact information received in a 3xx response for redirection-type scenarios.
    • disable (default)
    • enable
  • honorEmbeddedHeadersin3xx –Enable flag to allow the processing of embedded headers in 3xx Contact headers for the trunk group that received the 3xx.
    • disable (default)
    • enable
  • relayUnusedContactParams – When enabled, Contact parameters received in 3xx responses that are not consumed/processed locally by the SBC (see NOTE below) can now be passed through to the R-URI of subsequent INVITE request.
    • disable (default)
    • enable 
  • skipCrankbackProfileAndAlwaysCrankback – Enable this flag to force any 4xx–6xx SIP response code to cause crankback so the next potential contact or 3xx response is tried. If disabled, only the response codes specified in default SBC crankback profile cause the call to crank back.
    • disable (default)
    • enable

mode

Use this object to control SIP redirection:

  • acceptRedirection– (default)– Multiple redirections are allowed.
  • allowSingleRedirectAttempt – Only a single Redirect is allowed per route. Additional Redirects cause crankback to be performed.
  • rejectRedirection – If a Redirect is received, crank back is performed.

 

Note
titleNOTE

Parameters consumed/processed locally by the SBC and excluded from relayUnusedContactParams command include:

  •  dtg
  •  tgrp
  •  trunk-context
  •  cic
  •  npdi
  •  npi
  •  rn
  •  bgid
  •  bgt
  •  user
  •  phone-context

...

Parameter

Description

sipCauseMapping

Use this object in a SBC ERE configuration to create Internal-to-SIP and SIP-to-Internal SIP Cause Mapping Profile names for this IP Signaling Profile.

  • internalToSipCauseMappingProfileName– The name of the Internal-to-SIP cause mapping profile.
  • sipToInternalCauseMappingProfileName – The name of the SIP-to-Internal cause mapping profile.
Info

To create a profile to map CPC and SIP, refer to CPC to SIP Cause Map Profile - CLI and

...

SIP CPC Cause Code Mapping Profiles - CLI.

To associated these profiles with Ingress/Egress trunk groups, refer to sipTrunkGroup signaling - CLI.

For configuration examples and external PSX considerations, see Configuring SIP Cause Code Mapping.

Noprint

Back to Top

SIP Headers and Parameters

...