Interworking profile field descriptions

Last Updated : Nov 27, 2024 |

General options

Name

Description

Hold Support

Indicates the standard to be used to provide HOLD support. The options are:

  • None

  • RFC 2543 - c=0.0.0.0

  • RFC 3264 - a=send only

  • Microsoft Teams

The Microsoft Teams option is required for Microsoft Teams deployments to handle the hold/resume feature of Microsoft Teams. It enforces the Microsoft Teams side to send the a=inactive message. When this option is set, none of the following messages are sent towards Microsoft Teams: a=sendonly, a=recvonly, or c=0.0.0.0.

In addition, when you select the Microsoft Teams option, a Feature Flag is set in the Call Detail Record (CDR) by Avaya SBC. The Feature Flag is the 35th field in the CDR and is set to a value of 8. The Feature Flag identifies the call in CDR as a Microsoft Teams call.

180 Handling

Determines how 180 Ringing messages are handled. The options are:

  • None

  • SDP

  • No SDP

181 Handling

Determines how 181 Call Forwarding messages are handled. The options are:

  • None

  • SDP

  • No SDP

182 Handling

Determines how 182 Queued messages are handled. The options are:

  • None

  • SDP

  • No SDP

183 Handling

Determines how 183 Session Progress messages are handled. The options are:

  • None

  • SDP

  • No SDP

For Microsoft Teams, the 183 Handling option must be administered with No SDP. This is required so that ringback is heard on trunks.

Refer Handling

Indicates whether Avaya SBC passes or consumes the REFER message. When an endpoint invokes a supplementary service, such as a call transfer, the endpoint generates and sends an in-dialog REFER request to Avaya SBC through the enterprise call server. Avaya SBC applies URI-based routing to the new INVITE message triggered towards the transfer target.

Refer Handling feature works in either of the following two modes:

  • Send Hold

  • Delayed Offer

When configuring a profile to use with Microsoft Teams, enable the Refer Handling option.

URI Group

Indicates the URI group that is required for REFER handing.

Note:

Avaya SBC enables the URI Group field only when you select the Refer Handling checkbox.

When configuring Microsoft Teams, it is recommended that the URI Group option be set to None. However, this option can be enabled if required by the PSTN side and topology.

Send Hold

Indicates whether Avaya SBC sends a HOLD message to a trunk when processing REFER messages for that trunk. Disable this setting for trunks that do not support SIP HOLD. By default, this setting is on.

Note:

Avaya SBC enables the Send Hold check box only when you select the Refer Handling check box.

When configuring Microsoft Teams, it is recommended that the Send Hold option be disabled. However, this option can be enabled if required by the PSTN side and topology.

Delayed Offer

Indicates whether Avaya SBC sends an INVITE message to the transferee without SDP. If you select Delayed Offer, Avaya SBC gets the complete capabilities of the transferee as an SDP Offer message.

Avaya SBC enables the Delayed Offer check box only when you select the Refer Handling check box.

When configuring Microsoft Teams, it is recommended that the Delayed Offer option be disabled. However, this option can be enabled if required by the PSTN side and topology.

3xx Handling

Indicates whether the Avaya SBC security device will handle the 3xx Redirection Response messages.

Diversion Header Support

Indicates whether the Avaya SBC security device supports diversion headers.

Note:

When you select the 3xx Handling check box, the system enables the Diversion Header Support check box.

Delayed SDP Handling

Indicates whether the Avaya SBC security device processes delayed SDP packets.

Important:

The features Media Unanchoring and Delayed SDP Handling cannot both be enabled for a call. For more information about administering those features, see Administering Avaya Session Border Controller.

Re-Invite Handling

Indicates whether Reinvite Handling is enabled for Avaya SBC. If a trunk or call server does not want in-dialog RE-INVITES, then enable Reinvite Handling.

Precondition: RE-INVITE SDP must be the same as the previous INVITE transaction SDP. For example, consider a trunk server that has Reinvite Handling enabled. When the first INVITE with SDP goes to the trunk server, Avaya SBC stores this message. When the next INVITE goes to the trunk server, Avaya SBC tries to match the current INVITE SDP with the stored SDP. If both SDPs are same, Avaya SBC stops INVITE and responds . However, if a second INVITE comes without any SDP change, while adding extra SDP parameters to Hold or Resume, Avaya SBC handles RE-INVITE.

Important:

When Re-Invite Handling is enabled, the far end should not change its CODEC, SRTP, and media parameters mid-call. If any of these parameters change, Reinvite Handling will not work

Prack Handling

Indicates whether Provisional Response Acknowledgement (PRACK) handling is enabled. When called party sends provisional requests with 100 rel option in the Require header, called party must receive PRACK message in the response to ensure end to end successful communication. If the trunk or call server does not send 100 rel option in the supported header for the initial INVITE request then by selecting Prack Handling, Avaya SBC sends the PRACK for that particular trunk or call server to the called party.

Allow 18X SDP

Indicates whether a PRACK message is permitted in an 18x record route header.

T.38 Support

Indicates whether Avaya SBC security device. supports the T.38 FAX Relay standard.

URI Scheme

Indicates the URI scheme that the Avaya SBC security device will use. The options are:

  • SIP

  • TEL

  • ANY

Via Header Format

Indicates the header format used by the Avaya SBC security device. The options:

  • RFC3261

  • RFC2543

SIPS Required

Use this option to control the SIP/SIPS URI scheme handling for SRTP calls. By default, this option is enabled.

When doing an upgrade to Release 8.1.2 or later, this option is automatically enabled after the upgrade. For any configurations that do not use this feature, you must manually disable this option after you do the upgrade. For example, you must disable this option in Server Interworking profiles when the deployment has or uses Microsoft Teams, Skype for Business, or Lync.

Note:

When Assured SIP (AS-SIP) mode is enabled, the SIPS Required option is grayed out and is not available.

Mediasec Handling

Use this option to distinguish security mechanisms that apply to the media plane by defining a new Session Initiation Protocol (SIP) header field parameter to label such security mechanisms.

SIP Timers options

Name

Description

Min-SE

Specifies the minimum value for the SIP min-SE timer. The Min-SE timer is used for a SIP refresh (Re-Invite/Update) session as the minimum session expire time value.

The time range is 90 to 86400 seconds.

Init Timer

Specifies the initial request retransmission interval. This interval corresponds to Timer T1 in RFC 3261. This timer is used when sending a request over UDP.

The time range is 50 to 1000 milliseconds.

Max Timer

Specifies the maximum retransmission interval for non-INVITE requests. This interval is for non-INVITE requests and corresponds to Timer T2 in RFC 3261.

The time range is 200 to 8000 milliseconds.

Trans Expire

Specifies the Transaction Expiration timer. The default value for this field is 32 seconds.

Any request that the server sends times out if the server does not receive a response within the time set as the Transaction Expiration time. To use alternate routing, you must set a shorter transaction expiration value than the default value of 32 seconds.

The time range is 1 to 64 seconds.

Invite Expire

Specifies the transaction expiration time for an INVITE transaction after what receives a provisional response .

The time range is 180 to 300 seconds.

Retry After

Specifies the maximum time after which the server sends the routing request again.

The time range is 2 to 32 seconds.

Privacy options

Name

Description

Privacy Enabled

Indicates whether privacy is used between the Avaya SBC security device and the SIP server.

Note:

When you select the Privacy Enabled checkbox, the system enables the following fields: User Name, P-Asserted-Identity, P-Preferred-Identity, and Privacy Header fields.

User Name

Specifies the user name to be used for privacy authentication.

P-Asserted-Identity

Indicates that Avaya SBC rewrites the FROM header in a trusted SIP message with the P-Asserted-ID.

This field is used for maintaining privacy for the FROM header. Trunk servers usually Accept SIP INVITE with P-asserted ID. For some Trunk servers, Avaya SBC inserts this header into the FROM header, insert the header in P-asserted ID and change From as Anonymous user, and send out the request. not clear

P-Preferred-Identity

Indicates that Avaya SBC uses the P-Preferred-ID during private sessions.

Privacy Header

Specifies the Privacy Header to be used during privacy sessions.

Advanced options

Name

Description

Record Routes

Directs the Avaya SBC security device to record route information. The options are:

  • None: Avaya SBC does not add any record route. However, to remove all record routes, enable Topology Hiding (TH) with record route auto.

  • Single Side: Avaya SBC adds only one record route. If Avaya SBC receives a 200 OK message, Avaya SBC passes the same record route outside the enterprise network. If TH is enabled, the 200 OK record routes are removed.

  • Both Sides: Avaya SBC adds two record routes. If Avaya SBC receives a 200 OK message, Avaya SBC passes the same record route outside the enterprise network. If TH is enabled, the 200 OK record routes are removed and only one record route is retained.

    When configuring a profile to use with Microsoft Teams, enable the Both Sides option.

  • Dialog Initiate Only (Both Sides): Avaya SBC adds two record routes, but not to the in-dialog message. If Avaya SBC receives a 200 OK message, Avaya SBC passes the same record route outside the enterprise network. If TH is enabled, the 200 OK record routes are removed and only one record route is retained.

  • Dialog Initiate Only (Single Side): Avaya SBC adds one record route, but not to the in-dialog message. If Avaya SBC receives a 200 OK message, Avaya SBC passes the same record route outside the enterprise network. If TH is enabled, the 200 OK record routes are removed.

Include Endpoint IP for Context Lookup

Directs the Avaya SBC security device to use endpoint IP while looking for Avaya SBC internal SIP context.

Extensions

Directs the Avaya SBC security device to use functionality specific to different environments. The available options are:

  • Avaya

    Important:

    You must use the Avaya option if you want to use the traceSBC command to search for Av-Global-Session-ID (GSID) headers to filter SIP call traces.

  • Nortel

  • Lync

    Note:

    When configuring a profile to use with Microsoft® Teams, enable the Lync option. Lync was a prior name for Microsoft® Teams.

  • Cisco

  • KDDI

Diversion Manipulation

Directs the Avaya SBC security device to copy SIP Diversion header from 3xx messages to Sip Request messages while 3xx handling is enabled on Avaya SBC security device.

Diversion Condition

Specifies the diversion condition.

Note:

When you select the Diversion Manipulation check box, the system enables the Diversion Condition field.

Diversion Header URI

Specifies the Avaya SBC security device to add SIP Diversion header on the SIP Invite message.

Note:

When you select the Diversion Manipulation check box, the system enables the Diversion Header URI field.

Has Remote SBC

Directs the Avaya SBC security device to use far-end firewall functionality.

Route Response on Via Port

Directs the Avaya SBC security device to use SIP Via header port to route response.

MOBX Re-INVITE Handling

Select this option to enable MOBX Re-INVITE Handling.

Enable this feature for calls made by Mobile Extension (MOBX) users that are calling through a Mobile Service Provider (MSP) serviced by an Avaya SBC system. The Avaya SBC can terminate these mobile calls to a PSTN user through SIP-PRI gateways or to a user connected to an Avaya private network communication server.

Use this option to allow Avaya SBC to filter the reinvite messages coming from an Avaya private network communication server to the MSP. The Re-INVITE handling configuration must be enabled on the MSP trunk server interworking profiles.

NATing for 301/302 Redirection

When NATing for 301/302 Redirection is enabled for server interworking, Avaya SBC will NAT 301/302 contact addresses going to the server.

Select this option for Adhoc conferencing support with the Next Generation 911 feature. When enabled, Avaya SBC will NAT on 301/302 contact address received from the Next Generation Core Services (NGCS) conference factory.

This option has no affect operation of 301/302 messages on Remote Worker configurations.

SIP Recording

Relay INVITE Replace

Select this option to enable Relay INVITE Replace.

Include Called Participant

Select this option to set the AOR attribute of the called participant in the SIPREC metadata to To header AOR of the communication session. By default, this option is disabled.

Note:

Configure this field only if the Server Type is administered as Recording Server.

Conference URI

Enter the conference URI to be updated in the conference media stream participant information. Avaya SBC and the recording vendor use this conference URI to identify the mixed media streams coming from the conference bridge.

You can leave this field blank if there is no requirement from the recording vendor.

Note:

Configure this field only if the Server Type is administered as Recording Server.

DTMF

DTMF Support

These options define whether and how RFC 2833 DTMF touch-tone signals are converted to SIP messages. When conversion occurs, the DTMF signals and SIP messages are sent in parallel in the call path to support signaling devices that require either DTMF signals (such as an IVR) or SIP messages (such as SIP trunks). You must have interworking profiles for both inbound calls (always set to None) and outbound calls (using one of the options defined below). You must define the profiles for the servers.

Note:

DTMF signal conversion to SIP messages will not happen when a registered user is involved in the call.

Important:

Avaya recommends that for deployments where personal data protection based on GDPR requirements are critical, you should not use DTMF interworking. For more information about Avaya SBC support for GDPR, see Avaya Session Border Controller Overview and Specification.

  • None – RFC 2833 DTMF touch-tone signals are passed through and are not converted to SIP messages.

  • SIP Notify – RFC 2833 DTMF touch-tone signals are converted to out-of-band SIP Notify messages. Conversely, SIP Notify messages are converted back to RFC 2833 DTMF touch-tone signals.

  • RFC 2833 Relay & SIP Notify – RFC 2833 DTMF touch-tone signals passed through and are also converted to out-of-band SIP Notify messages. Conversely, SIP Notify messages are converted back to RFC 2833 DTMF touch-tone signals. See the information below about how this option is used for MOBX calls.

  • SIP INFO – RFC 2833 DTMF touch-tone signals are converted to out-of-band SIP Info messages. Conversely, SIP Info messages are converted back to RFC 2833 DTMF touch-tone signals.

  • RFC 2833 Relay & SIP Info – RFC 2833 DTMF touch-tone signals passed through and are also converted to out-of-band SIP Info messages. Conversely, SIP Info messages are converted back to RFC 2833 DTMF touch-tone signals. See the information below about how this option is used for MOBX calls.

  • Inband – RFC 2833 DTMF touch-tone signals are converted to in-band DTMF. Conversion in the opposite direction is not supported.

Avaya SBC uses the RFC 2833 Relay & SIP Info or RFC 2833 & SIP Notify options to fork the incoming RFC 2833 DTMF touch-tone signals and SIP Info or SIP Notify messages to carry the DTMF signals in SIP signaling messages. The MOBX URI group configuration is required to configure these DTMF options.

MOBX calls use standard mobile user features that invoke RFC 2833 DTMF touch-tone signals, such as digits for an IVR. Avaya SBC must pass the original DTMF touch-tone signals to a media gateway or endpoint in parallel with sending the SIP Notify or SIP Info messages to an Avaya private network communication server.

Any server configured on Avaya SBC that supports MOBX users on a Mobile Service Provider (MSP) must also have a URI group configured that identifies the MSP users.

Adaptive Inband Detection

Select this check box to enable Avaya SBC adaptive conversion of RFC 2833 DTMF touch-tone signals to INBAND DTMF based on the SDP Answer received from the service providers. Avaya SBC uses SIP/SDP signaling for this functionality. If the SDP answer has no telephone codec, the conversion happens from RFC 2833 to INBAND. Otherwise, it will be RFC 2833 relay.

This field is available only when you set the DTMF Support field to None.

URI Manipulation options

Note:

Options for the URI Manipulation and Header Manipulation rules cannot be added until after you administer the basic interworking options. After you add a new profile, you can add these rules using the Add button located on the two rule tabs.

Name

Description

User Regex

The Regex rule to be used to match the User field in the SIP message.

Domain Regex

The Regex rule to be used to match the Domain field in the SIP message.

User Action

The action that the Avaya SBC security device takes on finding a User Regex match . The options are:

  • None

  • Add prefix [Value]

  • Remove prefix [Value]

  • Replace with [Value]

  • Replace [Value 1] with [Value 2]

User Values

The values to be used as specified in the User Action field.

Note:

When you select the Replace [Value 1] with [Value 2] option, the system enables the second text box.

Domain Action

The action that the Avaya SBC security device takes on finding a Domain Regex match . The options are:

  • None

  • Add prefix [Value]

  • Remove prefix [Value]

  • Replace with [Value]

  • Replace [Value 1] with [Value 2]

Domain Values

The values to be used as specified in the Domain Action field.

Note:

When you select the Replace [Value 1] with [Value 2] option, the system enables the second text box.

Header Manipulation options

Name

Description

Header

The SIP header field to be manipulated.

The options are:

  • Contact

  • Diversion

  • From

  • P-Asserted-Identity

  • RequestURI

  • To

Action

The action to be performed. The options are:

  • Add Parameter w/ [Value]

  • Remove Parameter w/ [Value]

Parameter

The parameter to be used in the action performed in the Action field.

Value

The value of the parameter defined in the Parameter field.