Skip to end of metadata
Go to start of metadata

REST API Method: PUT /rest/sipprofile/{identifier}

Creates a SIP Profile Table given a specific Table ID.

URL:

https://192.168.0.111/rest/sipprofile/{identifier}

HTTP Method

PUT

Requires Authentication:

true

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length Short descriptive name of the SIP profile
UserAgentHeaderNoNostringRibbon SBC Edge256 - 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

FQDNinFromHeaderNoNoEnum0Possible values:
  • 0 - eDisable
  • 1 - eSBCFqdn
  • 2 - eServerFqdn
  • 3 - eStatic
Specifies whether FQDN (SBC's or Server's) is used in the From Header as opposed to IP address.
  • Disable
    - IP address will be used in the From Header.
  • SBC FQDN
    - SBC Edge FQDN will be used in the From Header.
  • Server FQDN
    - SIP Server FQDN(Next Hop) will be used in the From Header.
  • Static
    - User entered value in StaticHost will be used in the From Header.
FQDNinContactHeaderNoNoEnum0Possible values:
  • 0 - eDisable
  • 1 - eSBCFqdn
  • 2 - eServerFqdn
  • 3 - eStatic
Specifies whether the SBC's FQDN or a user entered FQDN or IP address to be used in the Contact Header.
  • Disable
    - IP address will be used in the Contact Header.
  • SBCFqdn
    - SBC Edge FQDN will be used in the Contact Header.
  • Static
    - User entered value in StaticHost will be used in the Contact Header.
StaticHostNoNostringnone255 - 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
AllowHeaderNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
If it is true, the SBC Edge will send out request with Allow: header in it.
SessionTimerNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether session timers are available for this Signaling group
  • Disable
    - The session refresh is not used.
  • Enable
    - The session refresh is used in calls.
SessionTimerMinNoNoint600Possible values:
  • 0 - Minimum
  • 7200 - Maximum
Specifies the minimum value to use for incoming session refresh in seconds. If the SBC Edge 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 90-7200.

SessionTimerExpNoNoint600Possible values:
  • 0 - Minimum
  • 7200 - Maximum
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 90-7200.

TerminateOnRefreshFailureNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Controls how the SBC Edge will respond if the session refresher fails. When set to false, the SBC Edge will send a refresh (re-Invite or Update) if refresher fails. When set to true, the SBC Edge will end the session by sending a BYE if refresher fails. Present only if Session Timer is enabled.
Option100RelNoNoint1Possible values:
  • 1 - Minimum
  • 3 - Maximum
Specifies support for PRACK option. SIP options are defined in the Supported and Required headers.
  • 0 - Disabled
    - this option is currently not supported
  • 1 - Supported
    - this option will be included in the supported header
  • 2 - Required
    - this option will be included in the required header
  • 3 - Unsupported
    - this option will not appear in either Supported or Require header
OptionPathNoNoint3Possible values:
  • 1 - Minimum
  • 3 - Maximum
Specifies support for PRACK option. SIP options are defined in the Supported and Required headers.
  • 0 - Disabled
    - this option is currently not supported
  • 1 - Supported
    - this option will be included in the supported header
  • 2 - Required
    - this option will be included in the required header
  • 3 - Unsupported
    - this option will not appear in either Supported or Require header
OptionTimerNoNoint1Possible values:
  • 1 - Minimum
  • 3 - Maximum
Specifies support for session timers. SIP options are defined in the Supported and Required headers.
  • 0 - Disabled
    - this option is currently not supported
  • 1 - Supported
    - this option will be included in the supported header
  • 2 - Required
    - this option will be included in the required header
  • 3 - Unsupported
    - this option will not appear in either Supported or Require header
OptionUpdateNoNoint1Possible values:
  • 1 - Minimum
  • 3 - Maximum
Specifies support for update. SP options are defined in the Supported and Required headers.
  • 0 - Disabled
    - this option is currently not supported
  • 1 - Supported
    - this option will be included in the supported header
  • 2 - Required
    - this option will be included in the required header
  • 3 - Unsupported
    - this option will not appear in either Supported or Require header
TimerT1NoNoint500Possible values:
  • 100 - Minimum
  • 10000 - Maximum
Specifies the RTT estimate.
TimerT2NoNoint4000Possible values:
  • 1000 - Minimum
  • 80000 - Maximum
Maximum interval for non-Invite requests and Invite responses
TimerT4NoNoint5000Possible values:
  • 1000 - Minimum
  • 100000 - Maximum
Maximum duration a message will remain in the network.
TimerCNoNoint180000Possible values:
  • 360 - Minimum
  • 3600000 - Maximum
Specifies Proxy Invite transaction timeout
TimerDNoNoint32000Possible values:
  • 5000 - Minimum
  • 640000 - Maximum
Specifies Wait time for response retransmits.
TransportTimeoutTimerNoNoint5000Possible values:
  • 5000 - Minimum
  • 32000 - Maximum
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.
MaxRetransmitsNoNoint0Possible values:
  • 0 - Minimum
  • 10 - Maximum
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.
RedundancyRetryTimerNoNoint180000Possible values:
  • 5000 - Minimum
  • 180000 - Maximum
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.
PidfPlPassthruNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
This flag is used to allow the passthrough of pidf+xml content from Ingress to Egress.
UnknownPlPassthruNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
This flag is used to allow the passthrough of unknown subtype content from Ingress to Egress.
ElinIdentifierNoNoEnum0Possible values:
  • 0 - e_E911_PIDFLO_TYPE_LOC
  • 1 - e_E911_PIDFLO_TYPE_HNO
  • 2 - e_E911_PIDFLO_TYPE_FLR
ELIN identifier maps the selected label from PIDF-LO XML content to the call router translation table input field.
SendAssertHdrAlwaysNoNoEnum0Possible values:
  • 0 - eSIP_SEND_ASSERT_HDR_TrustedOnly
  • 1 - eSIP_SEND_ASSERT_HDR_Always
  • 2 - eSIP_SEND_ASSERT_HDR_Never
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 Edge does not send Assert headers.
DiagnosticsHeaderNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Setting this flag to true enables the SBC Edge to send internal diagnostics related information in Ribbon properietary diagnostics header.
TrustedInterfaceNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
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.
CgNumberNameFromHdrNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
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.
DiversionSelectionNoNoEnum0Possible values:
  • 0 - edsLast
  • 1 - edsFirst
Selects which of multiple Diversion headers in an incoming SIP message is used as the redirecting number.
RecordRouteHdrPrefNoNoEnum0Possible values:
  • 0 - eRFC3261
  • 1 - eETSI
Selects which technical specification RFC 3261 or ETSI needs to be used to process Record-Route header.
SendNumberofAudioChanYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
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).
ConnectionInfoInMediaSectionYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
In SDP, remove c= line in media section if the value is false.
OriginFieldUserName YesNostringSBC64 - Max Length Value of the Origin Field (o=) username. No white spaces allowed. If security is a concern, use "-" .
SessionNameYesNostringVoipCall64 - Max Length Value of the Session Name (s=). White space allowed. If security is a concern, use "-".
DigitPreferenceYesNoEnum1Possible values:
  • 0 - drtVoice
  • 1 - drtRFC2833
  • 2 - drtSIPInfo
Digit transmission preference when both RFC2833 and SIP INFO are available.
TimerJNoNoint4000Possible values:
  • 4000 - Minimum
  • 640000 - Maximum
Transaction complete timeout
SDPHandlingYesNoEnum0Possible values:
  • 0 - e_shLegacyMLine
  • 1 - e_shRFCMLine
SDP Handling preference.

  • No labels