Versions Compared

Old Version 5

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 6

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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

sipsg - REST API Methods
Page Tree
rootResource - sipsg

Creates a SIP Signaling Group Table given a specific Table ID.

Note
titleNote

The SIP Signaling Group identifier can only be within the range 1-10000 (inclusive)

URL:

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

HTTP Method

PUT

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
customAdminStateYesYesEnum1Possible values:
  • 0 - cmCustomDisabled
  • 1 - cmCustomEnabled
  • 2 - cmCustomDrain
Enable or Disable this signaling group or set to Drain mode.
DescriptionYesNostringnone64 - Max LengthShort description/name of the SG.
ProfileIDYesNoint1Possible values:
  • 1 - Minimum
  • 65534 - Maximum
 SIP Profile ID. SIP profile is used for transaction timers, supported or required methods. Many SGs can share single profile.
ChannelsYesYesint10Possible values:
  • 1 - Minimum
  • 960 - Maximum
Specifies the number of SIP channels available for calls.
ServerSelectionNoNoEnum0Possible values:
  • 0 - eSelectionRoundRobin
  • 1 - eSelectionPriority
  • 2 - eSelectionFirstAvailable
  • 3 - eSelectionDnsSrv
 If the selected SIP Server Table contains DNS-SRV entries, this entry is inapplicable. When Basic call is used it will use server from server table:
  • Round Robin
    - Each initiasl invite gowes to new server in the cluster
  • Priority
    - The request goes to the server with highest priority
  • First
    - The initial request goes to the 1-st available server
ServerClusterIdNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 When Basic call is used it specifies the ID of Server table (cluster) which is the next sip hop. This is required when the SIP Mode is not Local Registrar (2).
RTPModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether RTP Audio/Fax Stream DSP Mode is supported by this Signaling Group. RTP Mode can not be disabled when RTP Proxy Mode also disabled.
RTPProxyModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether RTP Audio/Fax Stream Proxy Mode is supported by this Signaling Group. RTP Proxy Mode can not be disabled when RTP Mode also disabled.
VideoProxyMode RTPDirectModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Video Proxy Audio/Fax Stream Direct Mode is supported by this Signaling Group. Video Proxy Mode can not be disabled when all the modes for Audio is disabled.
VideoProxyMode MediaConfigIDYesNointEnum1Possible values:
  • 10 - MinimumbtFalse
  • 655341 - MaximumbtTrue
Specifies whether Video/Application Stream Proxy Mode is supported Specifies the Media List to be used by this Signaling Group.
ToneTableID VideoDirectModeNoYesNointEnum01Possible values:
  • 0 - MinimumbtFalse
  • 655341 - MaximumbtTrue
Specifies whether Video/Application Stream Direct Mode is supported Specifies the Tone Table to be used by this Signaling Group.
Info

This option is disabled if Play Ring Back is set to Never.

MediaConfigIDYesNoint1Possible values:
  • 1 - Minimum
  • 65534 - Maximum
 Specifies the Media List to be used by this Signaling Group.
Note

Assigning the encrypted media list and listening on the unencrypted port will cause the media key exchange to happen over the unencrypted listening port.

ToneTableID ActionSetTableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 Specifies the Tone Table to be used by this Signaling Group.
Info

This option is disabled if Play Ring Back is set to Never.

ActionSetTableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Specifies a defined Action Set Table a defined Action Set Table for this Signaling Group.
RouteTableIDYesYesint1Possible values:
  • 1 - Minimum
  • 65534 - Maximum
Specifies the Call Routing Table to be used by this Signalling Group.
RingBackNoNoEnum0Possible values:
  • 0 - sgrbpAuto
  • 1 - sgrbpAlways
  • 2 - sgrbpNever
 Specifies how ringback is played on a channel
  • Auto - Ringback is determined by signaling messages.
  • Always
    - Ringback is played for all calls and never be cut through.
  • Never - Ringback will never be generated and the endpoint is responsible to provide tones.
HuntMethodYesNoEnum4Possible values:
  • 0 - sghmStandard
  • 1 - sghmReverseStandard
  • 2 - sghmRoundRobin
  • 3 - sghmLeastIdle
  • 4 - sghmMostIdle
  • 5 - sghmOwnNumber
 Specifies the method that Call Control uses to allocate SIP channels.

  • Standard
    - This option assigns first available low numbered channel.
  • Reverse Standard
    - This option assigns last available high numbered channel.
  • Round Robin
    - This option assigns channels based on next available from low numbered to high numbered.
  • Least Idle
    - This option chooses channels based on the least idle channel.
  • Most Idle
    - This option chooses channels based on the most idle channel.
DirectionNoNoEnum2Possible values:
  • 0 - sgdirInbound
  • 1 - sgdirOutbound
  • 2 - sgdirBidirectional
 Obsolete. SIP SGs are bi-directional by default.
Early183 PlayCongestionToneNoNoEnum10Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether to send a SIP 183 response immediately after receiving an Invite message.play congestion tone when a 503 error response (that includes a reason header with Q.850 cause = 42) is received for an outbound INVITE.
Early183 OutboundProxyNoNostringnone256 - Max LengthSpecifies the outbound proxy which all SIP messages will be sent through.Enum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether to send a SIP 183 response immediately after receiving an Invite message.
AllowRefreshSDPNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether to allow refresh SDP after the media has been negotiated.
OutboundProxyNoNostringnone256 - Max LengthSpecifies the outbound proxy which all SIP messages will be sent through.
OutboundProxyPortNoNo OutboundProxyPortNoNoint5060Possible values:
  • 0 - Minimum
  • 65535 - Maximum
If an outbound proxy is configured a port number must be provided, within the range 1024 through 65535. Otherwise a 0 may be sent.
NoChannelAvailableIdNoNoint34Possible values:
  • 1 - Minimum
  • 127 - Maximum
 In case of "No Channel/Circuit available" release cause code, CCC is going to map this to the value configured against this entry in the signaling group. This cause code will be sent to the relevant protocol module.
TimerSanitySetupNoNoint255000180000Possible values:
  • 180000 - Minimum
  • 750000 - Maximum
Specifies the sanity timer for setup message, in milliseconds. A Call that has not received a response from the peer switch will be released after this time. This is for all call types.
TimerCallProceedingNoNoint180000Possible values:
  • 24000 - Minimum
  • 750000 - Maximum
Specifies the call proceeding timer for INVITE message, in milliseconds. A Call that has not received a 180 ringing response from the peer switch will be released after this time.
ChallengeRequestNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Indicates whether incoming request messages is challenged for security purposes. If this option is set to true you must specify a realm and at least one entry in the Authorization Table.
  • True
    - all requests will be challenged for realm/user/password
  • False
    - no request messages will be challenged
NotifyCACProfileNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Indicates whether to send NOTIFY messages with CACProfile to the remote server.
  • True
    - SIP NOTIFY with CACProfile will be sent to remote server connected to this SG
  • False
    - no SIP NOTIFY sent to remote server connected to this SG
NonceLifetimeNoNoint600Possible values:
  • 0 - Minimum
  • 3600 - Maximum
 Number of minutes a nonce will remain valid for a session. For a value is 0, nonce will remain forever.
Info

This option is applicable only if Challenge Request is set to True.

MonitorNoNoEnum2Possible values:
  • 0 - eProxyRegistrationsProxy
  • 1 - eProxyRegistrationsForward
  • 2 - eProxyRegistrationsLocal
  • 3 - eBasicCall
 Specifies how the SG will process REGISTER and INVITE message:
  • eProxyRegistrationsProxy
    - just forwards the REGISTER request (proxy mode). Not used.
  • eProxyRegistrationsForward
    - forwards the REGISTER request after inserting it to the loacal registrar.
  • eProxyRegistrationsLocal
    - Maintains local registrar only. Uses registrar bindings to terminate a call.
  • eBasicCall
    - Sends Invites to the selected Server table.
AuthorizationRealmNoNostringnone256 - Max Length Specifies the authorization realm used to challenge request messages.
Info

This option is available only when Challenge Request is set to True.

ProxyAuthorizationTableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 Local authorization table if chalenging mode is enabled.
RegistrarIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 Registrar table attached to the SG for routing purpose or/and adding registration records. This is required when the SIP Mode is not Basic Call (3)
RegistrarTTLNoNoint600Possible values:
  • 60 - Minimum
  • 86400 - Maximum
 Minimum Time to Live for inbound registrations.
OutboundRegistrarTTLNoNoint600Possible values:
  • 60 - Minimum
  • 86400 - Maximum
 Time to Live for outbound registrations.
DSCPYesNoint40Possible values:
  • 0 - Minimum
  • 63 - Maximum
DSCP value to be used in the IP header of all SIP packets from the Sonus SBC 1000/2000 system, on sockets/connections associated with this SIP SG
ListenPort_1NoNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the local listen port 1 on which SG can receive message. This needs to be provided if Protocol_1 is present.
Info

The default TCP/UDP is 5060 and the default for TLS is 5061

Protocol_1NoNoEnum0Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_1 is present.
TLSProfileID_1NoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS this is the of TLS profile in use.
LocalIP_1NoNostringnone50 - Max Length Not used in the current release.
ListenPort_2NoNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the local listen port 2 on which SG can receive message. This needs to be provided if Protocol_2 is present.
Info

The default TCP/UDP is 5060 and the default for TLS is 5061

Protocol_2NoNoEnum0Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_2 is present.
TLSProfileID_2NoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS this is the of TLS profile in use.
LocalIP_2NoNostringnone50 - Max Length Not used in the current release.
ListenPort_3NoNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the local listen port 3 on which SG can receive message. This needs to be provided if Protocol_3 is present.
Info

The default TCP/UDP is 5060 and the default for TLS is 5061

Protocol_3NoNoEnum0Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_3 is present.
TLSProfileID_3NoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS this is the of TLS profile in use.
LocalIP_3NoNostringnone50 - Max Length Not used in the current release.
ListenPort_4NoNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the local listen port 4 on which SG can receive message. This needs to be provided if Protocol_4 is present.
Info

The default TCP/UDP is 5060 and the default for TLS is 5061

Protocol_4NoNoEnum0Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_4 is present.
TLSProfileID_4NoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS this is the of TLS profile in use.
LocalIP_4NoNostringnone50 - Max Length Not used in the current release.
ListenPort_5NoNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the local listen port 5 on which SG can receive message. This needs to be provided if Protocol_5 is present.
Info

The default TCP/UDP is 5060 and the default for TLS is 5061

Protocol_5NoNoEnum0Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_5 is present.
TLSProfileID_5NoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS this is the of TLS profile in use.
LocalIP_5NoNostringnone50 - Max Length Not used in the current release.
ListenPort_6NoNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the local listen port 6 on which SG can receive message. This needs to be provided if Protocol_6 is present.
Info

The default TCP/UDP is 5060 and the default for TLS is 5061

Protocol_6NoNoEnum0Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_6 is provided.
TLSProfileID_6NoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS this is the of TLS profile in use.
LocalIP_6NoNostringnone50 - Max Length Not used in the current release.
SIPtoQ850_TableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Specifies the SIP to Q.850 Override Table to be used for this Signaling Group.
Q850toSIP_TableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Specifies the Q.850 To SIP Override Table to be used for this Signaling Group.
NetInterfaceSignalingYesNostringnone64 - Max Length Specifies the interface name followed by -1 for primary and -2 for secondary IP. The Signaling Group will bind to this interface and use it's IP address in headers and SDP. If this field is empty (default value) then the Signaling Group will listen on all available interfaces and will auto-determine the local IP used for headers and SDP.
NATTraversalTypeYesNoEnum0Possible values:
  • 0 - eNATTypeNone
  • 1 - eNATTypeStatic
 Specifies whether the Signaling Group uses a third-party entity IP address inside SIP message to support network address translation (NAT).
  • None
    - Specifies that network address translation is not used.
  • Static NAT
    - Specifies that network address translation is used.
Note

The only supported NAT type is symmetric NAT (port forwarding). This NAT configuration type means that packets received on a specific NAT server port are always forwarded to the same Sonus SBC port, for example, packets on the NAT public IP, port 5060 are forwarded to a private (SBC) IP, port 5060.

NATPublicIPAddressNoYesstringnone16 - Max Length Specifies the public IP of the NAT server visible from Internet. The NAT server's ports must be configured to allow SIP and RTP traffic, for example: port range 5060-5061 for SIP and 16000-17000 for RTP.
Note

The IP address specified in this field must be publicly accessible.

Info

This field is available when NAT Traversal is set to Static NAT.

PassthruPeerSIPRespCodeNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
This flag is used to allow the passthrough of Peer SIP Response Code. If this flag is enabled, it overrides the Q.850/SIP Mapping Tables
SGLevelMOHServiceNoYesEnum0Possible values:
  • 0 - mohDisable
  • 1 - mohEnable
  • 2 - mohEnableNoMusic
 Configures the SG level MOH service
  • Enable
    - Enable MOH feature in this SG.
  • Disable
    - Disable MOH feature in this SG.
  • mohEnableNoMusic
    - Enable MOH feature in this SG if no music.
IngressSPRMessageTableListNoNostringnone60 - Max LengthThis is a comma-separated, ordered list of SIP Protocol Manipulation Message Table references to be used on ingress. There is a maximum of 10 entries allowed."
EgressSPRMessageTableListNoNostringnone60 - Max LengthThis is a comma-separated, ordered list of SIP Protocol Manipulation Message Table references to be used on egress. There is a maximum of 10 entries allowed."
QoEReportingNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Indicates if signaling group will report QoE statistics at the end of each call. each call.
RegisterKeepAliveNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Indicates if SIP Register messages can be used as keep alive to mark a signaling group as UP/DOWN.
InteropModeNoNoEnum0Possible values:
  • 0 - eStandard
  • 1 - eBroadSoft
Indicates the type of interoperation for this SG.
AgentTypeNoNoEnum0Possible values:
  • 0 - eBackToBackUserAgent
  • 1 - eAccessMode
Indicates the SIP Agent Type for this SG.
RegistrantTTLNoNoint3600Possible values:
  • 30 - Minimum
  • 86400 - Maximum
The timeout to use for registrants that are subject to passthrough. Only applicable when Interop Mode is BroadSoft and SIP Mode is Basic Call.
InboundNATTraversalDetectionYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Enables/Disables NAT traversal detection for inbound SIP/RTP packets. When enabled, inbound SIP/RTP packets will be examined to determine if they're coming from a client that's behind a NAT, and handled accordingly. When disabled, no inbound NAT detection will be done.
InboundNATQualifiedPrefixesTableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 The row ID of the associated SIP NAT Qualified Prefix Table. When examining SIP packets, this table determines which subnets should be treated as being behind a NAT device. If the table ID is 0, all subnets will be treated as being behind a NAT device.
InboundSecureNATMediaLatchingNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Enables/Disables secure media latching for inbound RTP packets. When enabled, media latching will only occur if the RTP IP address is in the same subnet as the public IP seen by SIP signaling. When disabled, no IP address security checks will be performed during RTP latching.
InboundSecureNATMediaPrefixNoNostring255.255.255.25516 - Max Length This netmask is applied to the obtained SIP signaling IP and the result is compared with the prospective RTP IP to be used for latching. If a match occurs, it's considered secure and a valid IP for latching. If a match doesn't occur, it's considered invalid for latching and discarded. Must be in dotted decimal netmask format (e.g. 255.255.255.0).
InboundNATPeerRegistrarMaxEnabled InteropModeNoNoEnum0Possible values:
  • 0 - eStandardbtFalse
  • 1 - eBroadSoftbtTrue
Indicates the type of interoperation for this SG.
AgentTypeNoNoEnum0Possible values:
  • 0 - eBackToBackUserAgent
  • 1 - eAccessMode
Indicates the SIP Agent Type for this SG.
This field enables the maximum registration time to live for inbound registrants that are behind NATs. If a client registers with an expires value larger than the Inbound NAT Peer Registrar Max TTL, the expiration will be adjusted to the Inbound NAT Peer Registrar Max TTL.
InboundNATPeerRegistrarMaxTTL RegistrantTTLNoNoint3600120Possible values:
  • 30 - Minimum
  • 86400 - Maximum
The timeout to use This field represents the maximum registration time to live (in seconds) for registrants that are subject to passthrough. Only applicable when Interop Mode is BroadSoft and SIP Mode is Basic Callbehind NATs. If a client registers with an expires value larger than this value the expiration will be adjusted to this value.
RemoteHostsYesNostringnone2500 - Max Length Comma separated list of remote IPs or subnet from which SG can receive requests. It is not necessary to include the SIP Server entries, if the SG has a SIP Server table. Mask is mandatory. In case of FQDN after resolving it all IPs will be added to the list. If mask is empty 255.255.255.255 is assumed.
RemoteMasksYesNostringnone2500 - Max Length Comma separated list of subnet masks for the IP Addresses specified in RemoteHosts above. Mask is mandatory. In case of FQDN after resolving it all IPs will be added to the list. If mask is empty 255.255.255.255 is assumed. Mask is applied over the specified above IP in order to limit subnets intstead hosts.
SIPReSyncNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Indicates whether updates need to be performed when a SIP NOTIFY message is received from the BroadSoft server. This is applicable only for BroadSoft Auto Configuration feature.