Resources | addressContext | zone | sipTrunkGroup | signaling
|
Configuration
| Parameter | Presence | Type | Default | Description | |
|---|---|---|---|---|---|
 | accessClass | O | enumeration | none | This flag specifies the type of access network this Trunk Group represents. |
| routeMsgValidation | O | enumeration | noValidation | Specifies if route validation should be done for the received message and if the message should be validated to ensure it is SIP-only or SIP-I. The call will be released if validation is done and an invalid message type is received |
| maxFwdsDefault | O | uint8 | 70 | Default value for the Max Forwards Header. |
| backwardInfoMsgConDialog | O | enumeration | disabled | If enabled, an INFO message will only be sent after confirmed Dialog. If disabled, an INFO message will be only sent after a 18x message. This functionality only applies to SIP-I. |
| isupMimeBodyRelay | O | enumeration | disabled | When enabled, an ISUP mime body received in SIP signaling will be transparently relayed in egress SIP signaling. When disabled, ISUP mime bodies will be decoded and interworked based on the egress signaling configuration. |
| proxyBehaviorFor18xWhenE2EPrackEnabled | O | enumeration | disabled | Enabling this flag gives proxy behaviour for 18x wrt 100 rel behaviour when E2E Prack is enabled |
| rel100Support | O | enumeration | enabled | This controls the 100rel support for the reliability of provisional messages as specified in RFC3262. When enabled, 100rel will be specified on egress and accepted on ingress. When disabled, 100rel will not be specified on egress and will be ignored on ingress. |
| sdp100relIwkForPrack | O | enumeration | disabled | This control is used for Asymmetric Prack Interworking. |
| prefRequireTransparency | O | enumeration | disabled | This Controls the transparency of tag pref in Require header |
| privacyParamRestricted | O | enumeration | default | SIP Mapping Privacy Header parameters from incoming call to outgoing call. Default - map Privacy parameters header, id, or user to restrict. IdOnly - only map Privacy parameter id to restrict. |
| relayNonInviteRequest | O | enumeration | disabled | Relay Non Invite Requests. |
| localOODReferSupport | O | enumeration | disabled | Process out of dialog Refer locally. |
| treatPortZeroAsNoAudio | O | enumeration | disabled | Treat Audio m line with port zero as Audioless. |
| relayUpdatewithSdp | O | enumeration | disabled | Relay in-dialog Update Request with Sdp. |
| interOperatorID | O | string | The Inter Operator ID for IMS node | |
| uriPreference | O | enumeration | none | This indicates URI presentation preference for outgoing messages. None - No preference. SIP - Present TEL URI as SIP URI. TEL - Present SIP URI as TEL URI. |
| strictParse | O | enumeration | disabled | Enables strict SIP Parsing. If enabled, requests which are understandable but which violate the relevant RFC ABNF will be rejected. |
| skipDTGLookupForRouteHdr | O | enumeration | disabled | Skip destination trunk group lookup on Route header when routing calls using Route headers received in a request. |
| support3xxEmbeddedHdrOverGWGW | O | enumeration | notSupported | Enables 3xx with Embbeded Header support over GW-GW Protocol. |
| processTgrpContext | O | enumeration | disabled | If enabled, the tgrp-context parameter will determine if tgrp needs to be processed locally or relayed. |
| isubParamPreference | O | enumeration | rfc2806 | This trunk group attribute specifies how the ISDN Sub-Address parameter shall be handled in SIP. default: follow rfc2806 when handling ISUB parameter. nonstandard: treat the percentage character as an escape character when receiving this parameter. On sending, do not include characters not allowed by certain proxies. rfc3966: encode and decode the ISUB parameter based on the ABNF for ISUB specified in RFC3966. |
| variantType | O | enumeration | sonus | Specifies the variant of functionality. |
| factorValue | O | uint8 | 1 | The factor value used to interwork the SIP Max-Forwards header and the ISUP Hop counter parameter. |
| alwaysReplyInactiveIfReceivedInactive | O | enumeration | disabled | If enabled, SBC will reply datapath mode as Inactive; If received Inactive. |
| localNumberSupport | O | enumeration | disabled | If enabled, P-cscf will globalize To hdr in Register,req URI in SUBSCRIBE for regevt and do a PSX dip for non-INVITE for tel URI and will handle dial string feature. |
| disableTermIOIForPcscf | O | enumeration | disabled | If enabled, P-cscf will not add the param term-ioi in any of the request while creating PCV |
| deRegParentWithChildDereg | O | enumeration | disabled | If enabled, P-cscf will delete Parent RCB and all its childs during deregistration of any of the child IMPU. |
| usePSXRouteAsReqUriInReg | O | enumeration | disabled | If enabled, P-cscf will modify the Request URI of register with PSX returned route. |
| psxRouteForSubscribe | O | enumeration | disabled | This flag specifies whether to use PSX routes for routing the SUBSCRIBE to registered users. When ENABLED PSX routing is performed and when DISABLED no PSX routing is performed. |
| defaultCallingPartyNumber | O | string | The defaultCallingNumber for Caller privacy feature | |
| validateAor | O | enumeration | enabled | Flag that specifies if the AOR needs to be validated or allows anonymous calling |
| sourceAddressValidation | O | enumeration | disabled | This flag specifies whether source address validation is supported. |
| condIncMethInAllowHdr | O | enumeration | disabled | Flag that specifies whether to use ingress message Allow header values in the egress message. Only methods which are configured as allowed at the egress TG (signaling/method) are populated from ingress into the egress message. |
| flexiblePolicyAdapterProfile | O | reference | The name of the flexible policy adapter profile. | |
| sipFilterProfile | O | reference | default | The name of the sip filter profile. |
| NNIProfile | O | reference | Name of the NNI Signaling Profile to be attached | |
| psxScriptProfile | O | reference | Name of the PSX Script Profile to be attached to the TG | |
| acceptHistoryInfo | O | enumeration | disabled | Flag that specifies if a History-Info header received on the ingress trunk group will be accepted. |
| egressCallIdStaticString | O | string | - | String to be used for generating the egress callid when configured option for egressCallIdType in PSX is "Use Static String" |
| allowByeChallenge | O | enumeration | disabled | This flag enables the Challenge for BYE requests. |
| enforceTlsIfSipsUriScheme | O | enumeration | disabled | This flag enforces that TLS is used to egress a request, if the Request-URI/topmost Route header uses sips scheme on a per peer group basis |
| enforceSipsIfEgressIsTls | O | enumeration | disabled | This flag changes the URI scheme of the URI in the Request-URI to "sips", if the request is to be egressed via TLS on a per peer group basis. |
| tlsPeerName | O | string | Name of the TLS peer in the peer certificate | |
| usePsxRouteForEmergencyCall | O | enumeration | disabled | This flag specifies whether to use PSX routes for routing the Emergency Call from registered users. When ENABLED full PSX routing is performed and PSX route is used for Emergency Call |
| ocsSupport | O | enumeration | disabled | If enabled, relays INVITE with CSTA. |
| relayReplacesHeader | O | enumeration | disabled | This flag specifies whether P-cscf is locally process INVITE or relay Replaces header with INVITE. If enabled, P-CSCF will translate dialog identifier and relays the Replaces header in INVITE. |
| feidForPDCS | O | string | The Feid used in P-DCS-Billing-Info header. | |
| sendSdpToPsx | O | enumeration | disabled | Enabling this flag will pass SDP information to the PSX excluding the data till the first occurrence of m-line in a diameter structure |
| useGAPwhenRnDisabled | O | enumeration | disabled | This flag is valid only when disableRn flag under numberPortabilityAttributes of profile is ena If enabled, SBC will populate user info part of the R-URI and TO header with the GAP/OCN number |
| support199OptionTag | O | enumeration | disabled | Support for conditional inclusion of 199 option tag in Supported head |
| keepSupport | O | enumeration | disabled | This flag when enabled supports keep alive mechanisms (RFC-6223). |
| outboundSupport | O | enumeration | disabled | This flag when enabled supports outbound procedures (RFC-5626). |
| silenceSuppTreatment | O | enumeration | treatAsFaxTransmissionIndication | Specifies silence suppression treatment when reInvite with silenceSupp:of It will be treated as FAX call transition or G711 call with silence suppr |
| pemInterworking | O | enumeration | sendPEMBeforeIngressPreconditions | This flag controls the behavior of sending PEM header |
| rfc3261ValidateCSeqInBYE | O | enumeration | disabled | Validate CSeq number for BYE in INVITE dialog. |
| rfc3261ValidateInvite200OkRetransmissions | O | enumeration | disabled | Validate 200 OK retransmissions to INVITE as per rfc 3261 in INVITE Client transaction case. |
| useRandomUserInfoInContactHdr | O | enumeration | disabled | If enabled, use randomly generated value as UserInfo in contact header. |
| suppressNonRouteInviteResponse | O | enumeration | disabled | If enabled, response for non-route invite will be suppressed. |
| sipLocalRegistrar | O | enumeration | disabled | If enabled, this the messages for this Trunk group would be routed to SipRegistrar . |
| dnsForceReQuery | O | enumeration | disabled | If enabled, on REGISTER transaction timeout, requests are retried to IP/Port resolved from external DNS server skipping internal DNS Cache. |
| usePcfaCcf | O | enumeration | disabled | When this flag is enabled, SBC uses ccf received in PCFA as CDF. |
| honorMaddrParam | O | enumeration | disabled | Support for maddr present in Contact and Refer-To Header |
| rewriteIdentities | O | enumeration | disabled | Enables SIP URI transparency feature where IP Address received in certain headers will be mapped to domain names and domain name will be preserved if received in these headers. |
| transitIOI | O | string | The transit inter operator ID for IMS node | |
| termIOI | O | string | The terminating inter operator ID | |
| usePortRangeFlag | O | enumeration | disabled | Administrative state of the usePortRange indicating that separate port to be used for each registration. |
| storeICID | O | enumeration | disabled | This flag is used to retain the same ICID value in the Redirected/Crankback call scenario. |
| clearTcpConnectionsforRegistration | O | enumeration | disabled | Clear Tcp connections used for REGISTER upon deREGISTERing UE. |
| stopLmsdToneOnUpdate | O | enumeration | disabled | stop LMSD tone before sending UPDATE . |
| dropIsupMimeBody | O | enumeration | disabled | drop the ISUP MIME body from received requests. |
| cpcInterworkingForNNI | O | enumeration | disabled | If enabled, fills Calling Party Category in SIP Uri of P-Asserted-Identity for NNI. |
| convertAlertToProgress | O | enumeration | disabled | Convert 180 to 183 When SBC is configured to play Tone. |
| rfc7332ValidateMaxForwards | O | enumeration | disabled | validates Max-Forwards header value as per rfc-7332. |
| minimizeRelayingOfMediaChangesAtGwSg | O | enumeration | disabled | This flag is used in GW-GW call to minimize the relaying of media changes to the other Gateway leg on a Ribbon SBC. |
| disableMediaLockDownAtGwSg | O | enumeration | disabled | This flag is used in GW-GW call to apply disableMediaLockDown logic to suppress reInvite/Update messages. |
| relayDatapathModeChangesAtGwSg | O | enumeration | disabled | This flag is used in GW-GW call to apply relayDatapath Mode changes from one Gw to another. The functioning of the Relay Data Path Mode Changes To The Other Gateway is dependent on the status of minimizeRelayingOfMediaChangesAtGwSg. |
| s8hrSupport | O | enumeration | disabled | Support S8HR Roaming Network Calls. |
| gibaSupportForS8hrInboundUser | O | enumeration | enabled | GIBA Procedure Support for S8HR Inbound User Enabled - When this flag is enabled(default), GIBA procedure applied for S8HR Inbound user. Disabled - When this flag is disabled, GIBA procedure will not applied for S8HR Inbound user. |
| embeddedRegInfoinUserPart | O | enumeration | disabled | If enabled, reg-info value will be appended to UserInfo of contact header in REGISTER method |
| allowSimultaneous18xUPDATEtransaction | O | enumeration | disabled | If enabled, simultaneous 18x and UPDATE transactions will be allowed. |
| clearModeAsCodec | O | enumeration | disabled | If enabled, then CLEARMODE will be treated as codec. If disabled, then CLEARMODE call shall be accepted based on clearModeForDataCalls. |
| honorContactInRegisterForTLSCalls | O | enumeration | disabled | If enabled, SBC should honor the contact in REGISTER when the SBC receives calls towards registered user for TLS transports |
| performPrecondtionRenegotiation | O | enumeration | disabled | If enabled, then preconditions will be renegotiated on the ingress when there is a change in SDP. If disabled, then already negotiated preconditions will prevail without any new negotiation. |
| preferUPDATEOverReINVITE | O | enumeration | disabled | If enabled, SBC shall use UPDATE to communicate SDP towards ingress instead of re-INVITE when call goes to confirmed state. If disabled, then re-INVITE will be used to communicate change in SDP towards ingress. |
| sipJJ9030InterworkingProfile | O | reference | The SIP JJ-90.30 Interworking profile associated with this trunk. | |
| sipXHeaderProfile | O | reference | The SIP X Header profile associated with this trunk. | |
| calledPrefixMatchProfile | O | reference | The Called Prefix Match profile associated with this trunk. | |
| onlySendSubsequent18xSdpIfUnreliable | O | enumeration | disabled | If enabled, SBC shall conform to RFC 6337 page 9 and even if configured to send SDP in subsequent 18x, it shall only so until a reliable response has been sent. |
| minimizeMediaChangesForNtwkSdp | O | enumeration | disabled | If enabled, SBC shall minimize the media changes for network SDP received for internally generated Re-INV/UPDATE if there is no change. |
| sendOnlySingleCodecInAns | O | enumeration | disabled | If enabled, SBC shall send single codec in answer and modify answer towards peer. |
| preferPtimeInSdp | O | enumeration | disabled | If enabled, SBC shall prefer ptime value over maxptime in incoming SDP. |
| effectiveRelayOfMediaChangesFromOtherCallLeg | O | enumeration | disabled | If enabled, SBC effectively relays the media changes from the other call leg such as change in codec order, addition/deletion of a codec etc. |
| doNotAutoAnswer | O | enumeration | disabled | If enabled, SBC does not auto answers internally for outstanding request. |
| sendPaiUriToPsx | O | enumeration | disabled | This control is used for sending PAI URIs in policy request. |
| crlfMsgRateControlforPortRange | O | uint16 | 100 | The rate control of CRLF messages when port range is configured |
| emgCallByeHandleLegHoldTime | O | uint32 | 0 | Emergency Call Bye Handling feature flag, when the value is 0 feature is disabled. When it is configured (non zero), SBC applies Emergency Call Bye Handling procedure and considers this value as leg hold time. |
| userToUserHdrSupport | O | enumeration | disabled | This control is used for supporting user to user header . |
 | callingParty | O | Specifies what SIP headers may be used when determining the Calling Party information. | ||
| TCPFallback | O | Maximum Size of PDU accepted over UDP. | ||
| P-HeaderExtensions | O | Prescribes behavior associated with various 3GPP P-Headers. | ||
| sdpTransparency | O | sdp Transparency controls. | ||
| messageManipulation | O | Manipulation of SIP headers or content. | ||
| causeCodeMapping | O | Controls the mapping of CPC cause codes to/from SIP cause codes. | ||
| methods | O | Specifies whether to allow or reject various SIP methods. | ||
| retryCounters | O | Retry counter values for various SIP request types. | ||
| timers | O | Retransmission and session-keepalive timer parameters. | ||
| registration | O | Parameters controlling registration relay behavior. | ||
| authentication | O | Parameters controlling non registered authentication behavior. | ||
| transportPreference | O | The preference ordering of allowed SIP transports. | ||
| E164Profiles | O | Contains the Local and Global E164Profiles associated to this trunk group. | ||
| X-Headers | O | Controls the X and P Header behavior applicable to this trunk group. | ||
| postDialDelay | O | Post Dial Delay flags. | ||
| nassImsAuth | O | This flag specifies the type of access network(tispan-nass) this Trunk Group represents. | ||
| generateOrReplacePCV | O | Generate or Replace PCV flags. |
| RESTCONF API: GET Example |
|---|
curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/restconf/data/sonusAddressContext:addressContext={name}/sonusZone:zone={name}/sonusSipTrunkGroup:sipTrunkGroup={name}/signaling |
Overview
Content Tools