About this Resource

Modified: for 1.3.0

Defines a SIP Signaling Group Table for a SIP protocol connection on the SBC.

REST API Methods for this Resource

Resource Schema

Configuration

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 Length Short 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
  • 20000 - Maximum
Specifies the number of SIP channels available for calls.
ServerSelectionNoNoEnum0Possible values:
  • 0 - eSelectionRoundRobin
  • 1 - eSelectionPriorityAll
  • 2 - eSelectionFirstAvailable
  • 3 - eSelectionDnsSrv
  • 4 - eSelectionRegisterActive
 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: Register All
    - The request goes to the server with highest priority
  • First
    - The initial request goes to the 1-st available server
  • Priority: Register Active Only
    - Failover Sip 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).
SipRecordingStatusNoNoEnum0Possible values:
  • 0 - eDisableRecorder
  • 1 - eEnableRecorder
SipRecorderNoNointPossible values:
  • 0 - Minimum
  • 65534 - Maximum
RelOnQckConnectYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether the channel should be released if the call is answered too soon due to Voice mail, etc.,.
RelOnQckConnectTimerNoNoint1000Possible values:
  • 10 - Minimum
  • 5000 - Maximum
Specifies the timer for disconnecting the forked call leg for quick connect, in milliseconds.
RTPModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Audio/Fax Stream DSP Mode is supported by this Signaling Group.
RTPProxyModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Audio/Fax Stream Proxy Mode is supported by this Signaling Group.
RTPProxySrtpModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Audio/Fax Stream Proxy Srtp Mode is supported by this Signaling Group. This is only valid for the SWe Edge platform.
RTPDirectModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Audio/Fax Stream Direct Mode is supported by this Signaling Group.
VideoProxyModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Video/Application Stream Proxy Mode is supported by this Signaling Group.
VideoDirectModeYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether Video/Application Stream Direct Mode is supported by this Signaling Group. This is applicable only for the SBC 1000/2000 platforms.
CryptoProfileIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Identifies a cryto profile ID used. If no crypto profile is used then this is set to 0.
MediaConfigIDYesNoint1Possible values:
  • 1 - Minimum
  • 65534 - Maximum
 Specifies the Media List to be used by this Signaling Group.

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

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

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

ActionSetTableIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Specifies 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
  • 3 - sgrbpAutoOnAlertProgress
  • 4 - sgrbpAlwaysOnAlertProgress
 Specifies how ringback is played on a channel
  • Auto on 180 - Ringback is determined when processing 180.
  • Always on 180
    - Ringback is played for all calls and never be cut through when processing 180.
  • Auto on 180/183 - Ringback is determined when processing 180 or 183.
  • Always on 180/183
    - Ringback is played for all calls and never be cut through when processing 180 or 183.
  • Never - Ringback will never be generated and the endpoint is responsible to provide tones.
DirectionNoNoEnum2Possible values:
  • 0 - sgdirInbound
  • 1 - sgdirOutbound
  • 2 - sgdirBidirectional
 Obsolete. SIP SGs are bi-directional by default.
PlayCongestionToneNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether to play congestion tone when a 503 error response (that includes a reason header with Q.850 cause = 42) is received for an outbound INVITE.
Early183NoNoEnum0Possible 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.
RTCPMultiplexingNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to enable and disable RTP-RTCP Multiplexing
MediaCodecLatchNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to enable and disable Codec LockDown
OutboundProxyNoNostringnone256 - Max Length Specifies the outbound proxy which all SIP messages will be sent through.
ProxyIpVersionYesNoEnum0Possible values:
  • 0 - eVersionPreferIPv4
  • 1 - eVersionPreferIPv6
 Specifies whether the FQDN should be resolved into IPv4 addresses or IPv6 addresses.
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.
TimerSanitySetupNoNoint180000Possible values:
  • 180000 - Minimum
  • 750000 - Maximum
Specifies the maximum wait 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.

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.

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 SBC, on sockets/connections associated with this SIP SG
SIPListenProtocolPortListNoNostringnone64 - Max Length Comma separated list of Listen Port ids.
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.

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.

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.

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.

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.

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.

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.
SipResponseCodesYesYesstring408,409,411,413,500,501,503,504,580,604,606200 - Max Length List of Response codes which can cause Failover. This is a comma separated string of the Response codes . If a call is received with any of the Response codes, the system will retry the call and do failover registration. This is only applicable when ServerSelection is "Priority: Register Active Only(4)"
NetInterfaceSignalingYesNostringnone64 - Max Length Specifies the interface name followed by -1 for primary, followed by -2 for secondary IP, followed by -6 for IPv6 address. 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.

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

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

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 Length This 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 Length This 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. This is applicable only for the SBC 1000/2000 platforms.
VoiceQualityReportingNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Indicates if the signaling group will report voice quality statistics at the end of each call. This is applicable only for the SBC 1000/2000 platforms.
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
  • 2 - eO365
  • 3 - eO365wAD
  • 4 - eHeaderTransparency
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 or AD registration. Applicable when: 1. Agent Type is AccessMode, Interop Mode is BroadSoft and SIP Mode is Basic Call. Or 2. Interop Mode is set to 'Office 365 w/AD PBX'
ADAttributeNoNostringpager500 - Max Length Attribute name that is used as a key to search user records in the Active Directory.
ADUpdateFrequencyNoNostring1100 - Max Length Controls the frequency (in days) with which SIP queries Active Directory for all the records with AD attribute populated. Only visible when Office 365 w/ AD is selected.
ADFirstUpdateTimeNoNostring00:00:00500 - Max Length Specifies time of first AD query update in hh:mm:ss (24 hour format). Only visible when Office 365 w/ AD is selected.
Office365FQDNNoNostringnone1000 - Max Length Specifies the domain suffix to be used for outbound requests to Office 365 server.
MediaOptimizationNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether the local media optimization feature shall be activated or not.
PrivateMediaSourceIpNoNostringnone16 - Max Length Specifies the private IP address used for media when the above MediaOptimization flag is set to true.
ICESupportYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Enables/Disables Interactive Connectivity Establishment Support for media traversal involving NAT devices. When enabled, the SBC will act as an ICE agent for SIP calls. When disabled, no ICE support for a SIP call will be provided. This is applicable only for the SBC 1000/2000 platforms.
ICEModeNoNoEnum0Possible values:
  • 0 - eIceLite
  • 1 - eIceFull
 Indicates the ICE mode whether IceLite or IceFull.

This option is available when ICESupport is set to Enabled

.
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).
InboundNATPeerRegistrarMaxEnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 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.
InboundNATPeerRegistrarMaxTTLNoNoint120Possible values:
  • 30 - Minimum
  • 86400 - Maximum
 This field represents the maximum registration time to live (in seconds) for registrants that are behind 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.
SGBillingTypeNoNoEnum0Possible values:
  • 0 - eStandardLink
  • 1 - ePSTNLink
  • 2 - ePBXTieLink
  • 3 - eUCaasSLink
CustomerDomainNoNostringnone256 - Max Length This paramater is for the Customer Domain FQDN.

Runtime

Parameter Name Description Data Type Possible Values
rt_Type Provides the signaling type of the signaling group. EnumPossible values:
  • 0 - sgISDN
  • 1 - sgSIP
  • 2 - sgCAS
rt_Status Provides the runtime operational status of the signaling group. EnumPossible values:
  • 0 - sgsUP
  • 1 - sgsDOWN
  • 2 - sgsUpDraining
  • 3 - sgsUpDrained
  • 4 - sgsUpPeersDown
  • 5 - sgsNONE_EXISTS
rt_NumberOfChannels Provides the number of channels currently provisioned on this signaling group. int
rt_SGId string
rt_ChannelCount string
rt_SGStatusID Provides the number of channels currently provisioned on this signaling group. string
rt_PortId Applicable only for ISDN Signaling Group. Provides the port this signaling group is using. string
rt_PodName string
rt_PodIndex int

Statistics

Parameter Name Description Data Type Possible Values
rt_InInvite Received (incoming) Invite requests. int
rt_InBye Received (incoming) Bye requests. int
rt_InCancel Received (incoming) Cancel requests. int
rt_InOptions Received (incoming) Options requests. int
rt_InAck Received (incoming) Ack requests. int
rt_InRegister Received (incoming) Register requests. int
rt_InSubscribe Received (incoming) Subscribe requests. For future use. int
rt_InNotify Received (incoming) Notify requests. int
rt_InRefer Received (incoming) Refer requests. int
rt_InInfo Received (incoming) Info requests. int
rt_InUpdate Received (incoming) Update requests. int
rt_InPrack Received (incoming) Prack requests. int
rt_InPing Received (incoming) Ping requests. int
rt_OutInvite Sent out Invite requests. int
rt_OutBye Sent out Bye requests. int
rt_OutCancel Sent out Cancel requests. int
rt_OutOptions Sent out Options requests. int
rt_OutAck Sent out Ack requests. int
rt_OutRegister Sent out Register requests. int
rt_OutSubscribe Sent out Subscribe requests. int
rt_OutNotify Sent out Notify requests. int
rt_OutRefer Sent out Refer requests. int
rt_OutInfo Sent out Info requests. int
rt_OutUpdate Sent out Update requests. int
rt_OutPrack Sent out Prack requests. int
rt_OutPing Sent out Ping requests. int
rt_ResInvite Re-sent out Invite requests. Valid for UDP transport only. int
rt_ResBye Re-sent out Bye requests. Valid for UDP transport only. int
rt_ResCancel Re-sent out Cancel requests. Valid for UDP transport only. int
rt_ResOptions Re-sent out Options requests. Valid for UDP transport only. int
rt_ResAck Re-sent out Ack requests. Valid for UDP transport only. int
rt_ResRegister Re-sent out Register requests. Valid for UDP transport only. int
rt_ResSubscribe Re-sent out Subscribe requests. Valid for UDP transport only. int
rt_ResNotify Re-sent out Notify requests. Valid for UDP transport only. int
rt_ResRefer Re-sent out Refer requests. Valid for UDP transport only. int
rt_ResInfo Re-sent out Info requests. Valid for UDP transport only. int
rt_ResUpdate Re-sent out Update requests. Valid for UDP transport only. int
rt_ResPrack Re-sent out Prack requests. Valid for UDP transport only. int
rt_ResPing Re-sent out Ping requests. Valid for UDP transport only. int
rt_In1xxResp Received 1xx responses. int
rt_In2xxResp Received 2xx responses. int
rt_In3xxResp Received 3xx responses. int
rt_In4xxResp Received 4xx responses. int
rt_In5xxResp Received 5xx responses. int
rt_In6xxResp Received 6xx responses. int
rt_Out1xxResp Sent out 1xx responses. int
rt_Out2xxResp Sent out 2xx responses. int
rt_Out3xxResp Sent out 3xx responses. int
rt_Out4xxResp Sent out 4xx responses. int
rt_Out5xxResp Sent out 5xx responses. int
rt_Out6xxResp Sent out 6xx responses. int
rt_Res1xxResp Re-sent out 1xx responses over UDP. int
rt_Res2xxResp Re-sent out 2xx responses over UDP. int
rt_Res3xxResp Re-sent out 3xx responses over UDP. int
rt_Res4xxResp Re-sent out 4xx responses over UDP. int
rt_Res5xxResp Re-sent out 5xx responses over UDP. int
rt_Res6xxResp Re-sent out 6xx responses over UDP. int
rt_ClientTransactions Displays the number of Client Transactions for this Signaling Group. int
rt_ServerTransactions Displays the number of Server Transactions for this Signaling Group. int
rt_ClientTransactionsCompleted Displays the number of Client Transactions Completed for this Signaling Group. int
rt_ServerTransactionsCompleted Displays the number of Server Transactions Completed for this Signaling Group. int
rt_NumCurrentCalls Displays the number of Current Calls for this Signaling Group. int
rt_NumTotalCalls Displays the number of Total Calls for this Signaling Group. int
rt_NumConnectedCalls Displays the number of Connected Calls for this Signaling Group. int
rt_NumRefusedCalls Displays the number of Refused Calls for this Signaling Group. int
rt_NumErroredCalls Displays the number of Errored Calls for this Signaling Group. int
rt_NumBlockedCalls Displays the total number of blocked calls for this Signaling Group. int
rt_NumEgressCallAttempts Displays the number of Egress Call Attempts for this Signaling Group. int
rt_NumEgressCallsAccepted Displays the number of Egress Calls Accepted for this Signaling Group. int
rt_NumEgressCallsCompleted Displays the number of Egress Calls Completed for this Signaling Group. int
rt_NumEgressCallsRejected Displays the number of Egress Calls Rejected for this Signaling Group. int
rt_NumEgressCallsBlocked Displays the number of Egress Calls blocked for this Signaling Group. int
rt_NumEgressCurrentCalls Displays the number of Egress Calls active in the moment for this Signaling Group. int
rt_NumIngressCallAttempts Displays the number of Ingress Call Attempts for this Signaling Group. int
rt_NumIngressCallsAccepted Displays the number of Ingress Calls Accepted for this Signaling Group. int
rt_NumIngressCallsCompleted Displays the number of Ingress Calls Completed for this Signaling Group. int
rt_NumIngressCallsRejected Displays the number of Ingress Calls Rejected for this Signaling Group. int
rt_NumIngressCallsBlocked Displays the number of Ingress Calls Blocked for this Signaling Group. int
rt_NumIngressCurrentCalls Displays the number of Ingress Calls active (not disconnected) for this Signaling Group. int
rt_BusyHourCallAttempts Displays the number of call attempts during the busy hours. int
rt_BusyHourCallCompletions Displays the number of calls connected during the busy hours for this Signaling Group. int
rt_QoEReportSuccess Displays the Number of QoE outgoing Service Requests which received a response of Accepted(202) from the QoE Monitoring Agent for this Signaling Group. This is applicable only for the SBC 1000/2000 platforms. int
rt_QoEReportFailure Displays the Number of QoE outgoing Service Requests which did not receive a response of Accepted(202) from the QoE Monitoring Agent for this Signaling Group. This is applicable only for the SBC 1000/2000 platforms. int