In this section:
This section lists SIP Common IP Attributes Relay Flags parameter details.
% set profiles signaling ipSignalingProfile <profile_name> commonIpAttributes relayFlags conferenceEventPackage <disable | enable> dialogEventPackage <disable | enable> dtmfBody <disable | enable> force503to500Relay <disable | enable> info <disable | enable> message <disable | enable> messasge <disable | enable> notify <disable | enable> options <disable | enable> options <disable | enable> publish <disable | enable> refer <disable | enable> refer <disable | enable> referToHeaderRelay <disable | enable> regEventPackage <disable | enable> sonusMediaBody <disable | enable> statusCode3xx <disable | enable> statusCode4xx6xx <disable | enable> thirdPartyBodies <disable | enable> updateWithoutSdp <disable | enable>
Relay Flags
Parameter | Description |
---|---|
conferenceEventPackage | Enable to relay conference event xml message body (application/conference-info+xml body) to the peer.
NOTE: To pass this body transparently, enable the |
dialogEventPackage | Enable this flag to allow the SBC to send the Dialog Event Package to the peer.
NOTE: This flag only applies to unregistered users. |
dtmfBody | Enable flag to allow the SBC to relay DTMF body to the peer for responses to INVITE and BYE messages, relayed INFO, REFER, NOTIFY, OPTIONS, SUBSCRIBE request messages, and relayed 3xx, 4xx, 5xx, and 6xx in response to INVITE messages. Provision this flag on the ingress leg with respect to the message direction.
|
force503to500Relay | Enable flag to force 503 Service Unavailable message to map to 500 Internal Server Error message.
|
info | Enable to relay SIP INFO method to the peer. If disabled, the SBC processes SIP INFO methods locally.
|
message | Enable to relay SIP MESSAGE method to the peer. If disabled, the SBC processes SIP MESSAGE methods locally.
|
notify | Enable this flag to relay SIP NOTIFY method to the peer. If disabled, the SBC processes SIP NOTIFY methods locally.
|
options | Enable this flag to relay SIP OPTIONS method to the peer. If disabled, the SBC processes SIP OPTIONS methods locally.
NOTE: The SBC will relay the OPTIONS method if Route header is present and Max-forwards value is not "0" irrespective of whether this flag is enabled or disabled. If no suitable route is found, the SBC returns "404 Not Found" error response. |
publish | Controls the transfer of instant messages (IMs). Enable flag to allow the SBC to relay SIP PUBLISH methods to the peer. When disabled, the SBC processes SIP PUBLISH methods locally. Provision this flag on the ingress leg with respect to the message direction.
|
refer | When enabled, the SBC relays SIP REFER methods to the peer. When disabled, the SBC processes SIP REFER methods locally.
|
| Use this flag to relay the replaces in refer-To header of relayed REFER request. The options are:
|
regEventPackage | Enable this flag to relay Registration Event Package information to the peer. If disabled, the SBC rejects the Registration Event Package.
|
sonusMediaBody | Enable this flag to relay Ribbon media body to the peer for responses to INVITE and BYE messages, relayed INFO, REFER, NOTIFY, OPTIONS, SUBSCRIBE request messages and relayed 3xx, 4xx, 5xx, and 6xx in response to INVITE messages. Provision this flag on the ingress leg with respect to the message direction.
|
statusCode3xx | Enable this flag to relay 3xx status code to the peer in response to INVITE requests. Provision this flag on the trunk group that receives the 3xx response (the egress leg of the call).
|
statusCode4xx6xx | Enable this flag to relay the error status codes (4xx, 5xx, or 6xx) in response to initial INVITE requests (does not apply to re-INVITEs). Provision this flag on the trunk group that receives the error response (the egress leg of the call).
NOTE: You must enable this flag when using |
thirdPartyBodies | Enable this flag to relay third party bodies to the peer in response to INVITE and BYE messages, relayed INFO, REFER, MESSAGE, NOTIFY, OPTIONS, SUBSCRIBE request methods and relayed 3xx, 4xx, 5xx, and 6xx responses to INVITE methods. Provision this flag on the ingress leg with respect to the message direction.
|
| Enable this flag to relay UPDATE message without SDP.
|
Refer to SBC SIP Transparency Implementation Guide for a list of SIP headers not controllable by relay (or transparency) flags in relay scenarios.
The Transparency Profile is the recommended method of configuring transparency on the SBC Core for new deployments as well as when applying additional transparency configurations to existing deployments. Do not use IP Signaling Profile flags in these scenarios because the flags will be retired in upcoming releases.
Refer to the SBC SIP Transparency Implementation Guide for additional information.