Defines a SIP Profile Table to be used in a SIP Signaling Group.
REST API Methods for this Resource
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| Description | No | No | string | none | 64 - Max Length | Short descriptive name of the SIP profile |
| UserAgentHeader | No | No | string | Ribbon SBC Edge | 256 - Max Length |
Specifies whether to populate a SIP User Agent header. Blank field will not include a UA header in messages.
This option is available when TrustedInterface is set to Enable |
| FQDNinFromHeader | No | No | Enum | 0 | Possible values:
|
Specifies whether FQDN (SBC's or Server's) is used in the From Header as opposed to IP address.
|
| FQDNinContactHeader | No | No | Enum | 0 | Possible values:
| Specifies whether the SBC's FQDN or a user entered FQDN or IP address to be used in the Contact Header.
|
| StaticHost | No | No | string | none | 255 - Max Length | Specifies the host portion to be used in the From Header. Must be filled in with FQDN/IP if 'Static' is selected in FQDNinFromHeader |
| AllowHeader | No | No | Enum | 1 | Possible values:
| If it is true, the SBC will send out request with Allow: header in it. |
| SessionTimer | No | No | Enum | 1 | Possible values:
|
Specifies whether session timers are available for this Signaling group
|
| SessionTimerMin | No | No | int | 600 | Possible values:
|
Specifies the minimum value to use for incoming session refresh in seconds.
If the SBC negotiates session refresh this value will be used to indicate the minimum value acceptable for a session refresh.
This option is available when Session Timer is set to Enable. If Session Timer is disabled, this value needs to be 0. If it is enabled, this value needs to be in the range 300-7200. |
| SessionTimerExp | No | No | int | 600 | Possible values:
| Preferred local UAC session refresh timeout.
This option is available when Session Timer is set to Enable. If Session Timer is disabled, this value needs to be 0. If it is enabled, this value needs to be in the range 300-7200. |
| SessionTimerOffset | No | No | int | 5 | Possible values:
| Preferred local UAC session refresh timeout offset.
This option is available when Session Timer is set to Enable. If Session Timer is disabled, this value needs to be 0. If it is enabled, this value needs to be in the range 0-3599. |
| TerminateOnRefreshFailure | No | No | Enum | 0 | Possible values:
| Controls how the SBC will respond if the session refresher fails. When set to false, the SBC will send a refresh (re-Invite or Update) if refresher fails. When set to true, the SBC will end the session by sending a BYE if refresher fails. Present only if Session Timer is enabled. |
| Option100Rel | No | No | int | 1 | Possible values:
|
Specifies support for PRACK option. SIP options are defined in the Supported and Required headers.
|
| OptionPath | No | No | int | 3 | Possible values:
|
Specifies support for PRACK option. SIP options are defined in the Supported and Required headers.
|
| OptionTimer | No | No | int | 1 | Possible values:
|
Specifies support for session timers. SIP options are defined in the Supported and Required headers.
|
| OptionUpdate | No | No | int | 1 | Possible values:
|
Specifies support for update. SP options are defined in the Supported and Required headers.
|
| TimerT1 | No | No | int | 500 | Possible values:
| Specifies the RTT estimate. |
| TimerT2 | No | No | int | 4000 | Possible values:
| Maximum interval for non-Invite requests and Invite responses |
| TimerT4 | No | No | int | 5000 | Possible values:
| Maximum duration a message will remain in the network. |
| TimerC | No | No | int | 180000 | Possible values:
| Specifies Proxy Invite transaction timeout |
| TimerD | No | No | int | 32000 | Possible values:
| Specifies Wait time for response retransmits. |
| TransportTimeoutTimer | No | No | int | 5000 | Possible values:
| This specifies the interval for which the new TCP/TLS connections over SIP can be tried out for when no response is received from far end. The interval specified is in milliseconds. It is recommended to set this timer value to 5 seconds. |
| MaxRetransmits | No | No | int | 0 | Possible values:
| Number of maximum retransmissions for client transaction messages over UDP. Default value 0 disables this feature and maximum retransmissions happen by TimerB and TimerF values. Any non-zero value modifies TimerB and TimerF. |
| RedundancyRetryTimer | No | No | int | 180000 | Possible values:
| This specifies Redundancy Retry Timer for SIP Registers in Registration FailOver Feature. The interval specified is in milliseconds. It is recommended to set this timer value to 180000 milliseconds. |
| PidfPlPassthru | No | No | Enum | 1 | Possible values:
| This flag is used to allow the passthrough of pidf+xml content from Ingress to Egress. |
| UnknownPlPassthru | No | No | Enum | 0 | Possible values:
| This flag is used to allow the passthrough of unknown subtype content from Ingress to Egress. |
| ElinIdentifier | No | No | Enum | 0 | Possible values:
| ELIN identifier maps the selected label from PIDF-LO XML content to the call router translation table input field. |
| SendAssertHdrAlways | No | No | Enum | 0 | Possible values:
| If TrustedOnly the P-Asserted-ID/P-Preferred-ID and Privacy Headers will be sent out if it is Trusted Interface. If Always, send the Asserted header always and if Never, the SBC does not send Assert headers. |
| DiagnosticsHeader | No | No | Enum | 1 | Possible values:
| Setting this flag to true enables the SBC to send internal diagnostics related information in Ribbon properietary diagnostics header. |
| TrustedInterface | No | No | Enum | 1 | Possible values:
| Setting this flag makes the SIP signalling group as Truster Interface and sends P-Asserted-ID/P-Preferred-ID and Privacy Headers on the Egress side. |
| CgNumberNameFromHdr | No | No | Enum | 0 | Possible values:
| Setting this flag on Ingress SIP Signalling Group makes the SIP to use Calling Number and Name from FROM header always. By default if P-Asserted-ID/P-Preferred-ID present, Calling Number and Name are derived from P-Asserted-ID/P-Preferred-ID headers. |
| DiversionSelection | No | No | Enum | 0 | Possible values:
| Selects which of multiple Diversion headers in an incoming SIP message is used as the redirecting number. |
| RecordRouteHdrPref | No | No | Enum | 0 | Possible values:
| Selects which technical specification RFC 3261 or ETSI needs to be used to process Record-Route header. |
| SendNumberofAudioChan | Yes | No | Enum | 0 | Possible values:
| In SDP, in the a= line, drop the /1 field if the value is false (Ex: TRUE-> a=rtpmap:4 g723/8000/1 FALSE-> a=rtpmap:4 g723/8000). |
| ConnectionInfoInMediaSection | Yes | No | Enum | 1 | Possible values:
| In SDP, remove c= line in media section if the value is false. |
| OriginFieldUserName | Yes | No | string | SBC | 64 - Max Length | Value of the Origin Field (o=) username. No whitespace characters are allowed. If security is a concern, use "-" . |
| SessionName | Yes | No | string | VoipCall | 64 - Max Length | Value of the Session Name (s=). Blank spaces are allowed. If security is a concern, use "-". |
| DigitPreference | Yes | No | Enum | 1 | Possible values:
| Digit transmission preference when both RFC2833 and SIP INFO are available. |
| TimerJ | No | No | int | 4000 | Possible values:
| Transaction complete timeout |
| SDPHandling | Yes | No | Enum | 0 | Possible values:
| SDP Handling preference. |
Overview
Content Tools