Page History

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

Page Tree

root	Resource - sipprofile

Creates a SIP Profile Table given a specific Table ID.

URL:

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

HTTP Method

PUT

Requires Authentication:

true

Parameters

Parameter Name

Required

Service Affecting

Data Type

Default Value

Possible Values

Description

No

string

none

64 - Max Length

Short descriptive name of the SIP profile

UserAgentHeader

No

string

none

256 - Max Length

Specifies whether to populate a SIP User Agent header. Blank field will not include a UA header in messages.

FQDNinFromHeader

No

Enum

0

Possible values:

0 - eDisable
1 - eSBCFqdn
2 - eServerFqdn
3 - eStatic

Specifies whether FQDN(Sonus 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
- Sonus SBC 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.

StaticHost

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

Enum

1

Possible values:

0 - btFalse
1 - btTrue

If it is true, the Sonus SBC 1000/2000 will send out request with Allow: header in it.

SessionTimer

No

Enum

1

Possible 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.

SessionTimerMin

No

int

600

Possible values:

0 - Minimum
7200 - Maximum

Specifies the minimum value to use for incoming session refresh in seconds. If the Sonus SBC negotiates session refresh this value will be used to indicate the minimum value acceptable for a session refresh.

Info
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.

SessionTimerExp

No

int

600

Possible values:

0 - Minimum
7200 - Maximum

Preferred local UAC session refresh timeout.

Info
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.

TerminateOnRefreshFailure

No

Enum

0

Possible values:

0 - btFalse
1 - btTrue

Controls how 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

Enum

0

Possible values:

0 - eDisabled
1 - eSupported
2 - eRequired
3 - eUnsupported

Specifies support for PRACK option. SIP options are defined in the Supported and Required headers.

0 - Disabled
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

OptionTimer

No

Enum

0

Possible values:

0 - eDisabled
1 - eSupported
2 - eRequired
3 - eUnsupported

Specifies support for session timers. SIP options are defined in the Supported and Required headers.

0 - Disabled
- this option is used when SessionTimer is disabled.
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

OptionUpdate

No

int

0

Possible values:

0 - Minimum
3 - Maximum

Specifies support for update. SP options are defined in the Supported and Required headers.

0 - Disabled
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

TimerT1

No

int

500

Possible values:

100 - Minimum
10000 - Maximum

Specifies the RTT estimate.

TimerT2

No

int

4000

Possible values:

1000 - Minimum
80000 - Maximum

Maximum interval for non-Invite requests and Invite responses

TimerT4

No

int

5000

Possible values:

1000 - Minimum
100000 - Maximum

Maximum duration a message will remain in the network.

TimerC

No

int

180000

Possible values:

360 - Minimum
3600000 - Maximum

Specifies Proxy Invite transaction timeout

TimerD

No

int

32000

Possible values:

5000 - Minimum
640000 - Maximum

Specifies Wait time for response retransmits.

TransportTimeoutTimer

No

int

5000

Possible 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.

MaxRetransmits

No

int

0

Possible 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.

PidfPlPassthru

No

Enum

1

Possible values:

0 - btFalse
1 - btTrue

This flag is used to allow the passthrough of pidf+xml content from Ingress to Egress.

UnknownPlPassthru

No

Enum

0

Possible values:

0 - btFalse
1 - btTrue

This flag is used to allow the passthrough of unknown subtype content from Ingress to Egress.

ElinIdentifier

No

Enum

0

Possible 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.

SendAssertHdrAlways

No

Enum

0

Possible 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 Sonus SBC system does not send Assert headers.

TrustedInterface

No

Enum

1

Possible 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.

CgNumberNameFromHdr

No

Enum

0

Possible 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.

DiversionSelection

No

Enum

0

Possible values:

0 - edsLast
1 - edsFirst

Selects which of multiple Diversion headers in an incoming SIP message is used as the redirecting number.

SendNumberofAudioChan

Yes

No

Enum

1

Possible 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).

ConnectionInfoInMediaSection

Yes

No

Enum

1

Possible values:

0 - btFalse
1 - btTrue

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 white spaces allowed. If security is a concern, use "-" .

SessionName

Yes

No

string

VoipCall

64 - Max Length

Value of the Session Name (s=). White space allowed. If security is a concern, use "-".

Usage Example: (about cURL | requires a session token)

Code Block

language	bash

curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44cuc2h83fqaispmu6m519sa5642 -s -k -i https://134.56.72.218/rest/sipprofile/1 -X PUT --data "SessionTimerExp=90&ConfigIEState=1&SessionName=VoipCall&TimerT2=4000&TimerT1=500&TimerT4=5000&RefreshMethod=0&DiversionSelection=0&StaticHost=&OptionUpdate=1&Option100Rel=1&MaxRetransmits=0&TimerD=32000&TimerC=180000&ConnectionInfoInMediaSection=1&SendNumberofAudioChan=1&SessionTimer=0&CgNumberNameFromHdr=0&UserAgentHeader=Sonus SBC&Description=Default SIP Profile&TrustedInterface=1&SendAssertHdrAlways=0&FQDNinFromHeader=0&TerminateOnRefreshFailure=0&TransportTimeoutTimer=5000&OriginFieldUserName=SBC&ElinIdentifier=0&PidfPlPassthru=1&UnknownPlPassthru=0&OptionTimer=0&AllowHeader=1&SessionTimerMin=90"

Response:

Code Block

language	html/xml

<?xml version="1.0"?>
<root>
 <status>
  <http_code>200</http_code>
 </status>
 <sipprofile id="1" href="https://134.56.72.218/rest/sipprofile/1">
  <AllowHeader>1</AllowHeader>
  <CgNumberNameFromHdr>0</CgNumberNameFromHdr>
  <ConnectionInfoInMediaSection>1</ConnectionInfoInMediaSection>
  <Description>Default SIP Profile</Description>
  <DiversionSelection>0</DiversionSelection>
  <ElinIdentifier>0</ElinIdentifier>
  <FQDNinFromHeader>0</FQDNinFromHeader>
  <MaxRetransmits>0</MaxRetransmits>
  <Option100Rel>1</Option100Rel>
  <OptionTimer>0</OptionTimer>
  <OptionUpdate>1</OptionUpdate>
  <OriginFieldUserName>SBC</OriginFieldUserName>
  <PidfPlPassthru>1</PidfPlPassthru>
  <RefreshMethod>0</RefreshMethod>
  <SendAssertHdrAlways>0</SendAssertHdrAlways>
  <SendNumberofAudioChan>1</SendNumberofAudioChan>
  <SessionName>VoipCall</SessionName>
  <SessionTimer>0</SessionTimer>
  <SessionTimerExp>90</SessionTimerExp>
  <SessionTimerMin>90</SessionTimerMin>
  <StaticHost></StaticHost>
  <TerminateOnRefreshFailure>0</TerminateOnRefreshFailure>
  <TimerC>180000</TimerC>
  <TimerD>32000</TimerD>
  <TimerT1>500</TimerT1>
  <TimerT2>4000</TimerT2>
  <TimerT4>5000</TimerT4>
  <TransportTimeoutTimer>5000</TransportTimeoutTimer>
  <TrustedInterface>1</TrustedInterface>
  <UnknownPlPassthru>0</UnknownPlPassthru>
  <UserAgentHeader>Sonus SBC</UserAgentHeader>
 </sipprofile>
</root>

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

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

URL:

HTTP Method

Requires Authentication:

Parameters

Usage Example: (about cURL | requires a session token)

Response: