Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

isdnsg - REST API Methods
Page Tree
rootResource - isdnsg

Creates an ISDN Signaling Group Table given a specific Table ID.

Note
titleNote

The ISDN Signaling Group identifier can only be within the range 10001-20000 (inclusive)

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/isdnsg/{identifier}

HTTP Method

PUT

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[isdnsg - REST API Methods|Resource - isdnsg]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description

...

customAdminState

...

YesYesEnum1Possible values:
  • 0 -

...

  • cmCustomDisabled
  • 1- cmCustomEnabled
  • 2 -

...

  • cmCustomDrain
Enable or Disable this signaling group or set to Drain mode.
ApplyToPortNameYesYesstringnone128 - Max LengthSpecifies which physical T1/E1 Port this signaling group is for.
DescriptionNoNostringnone64 - Max LengthDescribes the Signaling Group so that it is easily identifiable when selected for a Call Route Table
IsdnSgSwitchVariantYesYesEnum3Possible values:
  • 0 - isvATT4ESS
  • 1 - isvATT5ESS
  • 2 - isvDMS100
  • 3 - isvNI2
  • 4 - isvETSI
  • 5 - isvQSIG
  • 6 - isvINET1500
Specifies the ISDN variant for this signaling group
IsdnSgSideOrientationYesYesEnum0Possible values:
  • 0 - isoUser
  • 1 - isoNetwork
  • 2 - isoNone
Specifies the ISDN user/network side for this signaling group
IsdnSgOverlapRxModeYesYesEnum0Possible values:
  • 0 - iorDisable
  • 1 - iorEnable
Specifies if overlap receiving is enabled on the signaling group. Only valid for Euro ISDN (ETSI) and QSIG Switch Variants.
IsdnSgOverlapTxModeYesYesEnum0Possible values:
  • 0 - iosDisable
  • 1 - iosEnable
Specifies if overlap sending is enabled on the signaling group. Only valid for Euro ISDN (ETSI) and QSIG Switch Variants.
IsdnSgIndicatedChannelYesYesEnum1Possible values:
  • 0 - iicPreferred
  • 1 - iicExclusive
Specifies the setting of the Indicated Channel field for the Channel Identification IE in the SETUP message sent to the far end for this signaling group.
IsdnServiceMessageCapabilityYesYesEnum1Possible values:
  • 0 - iscDisable
  • 1 - iscEnable
Specifies if service messaging is used on the signaling group. Only valid for ATT 4ESS, ATT 5ESS, NI2 and INS NET 1500 Switch Variants.
IsdnStopFarEndT310UponTryingFromSipYesYesEnum0Possible values:
  • 0 - isfDisable
  • 1 - isfEnable
Specifies if a Q.931 PROGRESS message is sent to the far-end so that it does not timeout (T310) while SIP response is pending from the SIP leg, causing the call to release. This setting typically enabled only for testing scenarios and should not used in a production system.
IsdnAllowCallingNameDisplayToSwitchYesYesEnum0Possible values:
  • 0 - iacDisable
  • 1 - iacEnable
 Specifies if the Q.931 SETUP message is sent to the far-end should include the DISPLAY Information Element (IE). If this option is enabled, the DISPLAY IE is populated for NI2 or Euro-ISDN switch types, otherwise the DISPLAY IE is not populated for these switch types.
Info

This setting is available when ISDN Side is set to User and Switch Variant is either NI2 or Euro-ISDN.

Info

In general, the DISPLAY IE is populated according to ISDN communication standards. The NI2 and Euro-ISDN specifications state that the DISPLAY IE _should not_ be populated. This option allows you to override that configuration for your environment.

IsdnSgHuntMethodYesYesEnum4Possible values:
  • 0 - sghmStandard
  • 1 - sghmReverseStandard
  • 2 - sghmRoundRobin
  • 3 - sghmLeastIdle
  • 4 - sghmMostIdle
  • 5 - sghmOwnNumber
Method that Call Control uses to allocate ISDN channels. This is only valid for Outbound or Bidirectional Direction settings.
  • Standard - This option assigns the first available low numbered channel.
  • Reverse Standard - This option assigns the 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.
IsdnSgDirectionYesYesEnum2Possible values:
  • 0 - sgdirInbound
  • 1 - sgdirOutbound
  • 2 - sgdirBidirectional
 Indicates the direction of calls supported
  • Inbound - Support only incoming calls from ISDN endpoints.
  • Outbound - Support only outgoing call to ISDN endpoints.
  • Bidirectional - Support both incoming or outgoing calls to ISDN endpoints.
IsdnSgRingbackPlayPolicyYesYesEnum0Possible values:
  • 0 - sgrbpAuto
  • 1 - sgrbpAlways
  • 2 - sgrbpNever
  • 3 - sgrbpAutoOnAlertProgress
  • 4 - sgrbpAlwaysOnAlertProgress
 Specifies when to generate local ring back
  • Auto on Alert - Depends if inband audio is available when processing Alert
  • Always on Alert - always generate inband ringback when processing Alert
  • Auto on Alert/Progress - Depends if inband audio is available when processing Alert or Progress
  • Always on Alert/Progress - always generate inband ringback when processing Alert or Progress
  • Never - never generate inband ringback
ToneTableNumberYesYesint

...

0Possible values:

    ...

    • 0 - Minimum
    • 65534 - Maximum
    		Specifies the Tone Table to use on this signaling group. This option is only available for Inbound and Bidirectional.
    ActionsetTableNumberNoNoint0Possible values:
    • 0 - Minimum
    • 65534 - Maximum
    		Specifies the Action Set Table to use on this signaling group. This option is only available for Inbound and Bidirectional.
    RouteTableNumberYesYesint1Possible values:
    • 1 - Minimum
    • 65534 - Maximum
    		Specifies the Call Route Table to use on the signaling group to route calls with. This option is only available for Inbound and Bidirectional.
    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.
    TimerSanitySetupNoNoint255000Possible 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. The duration of this timer should be equal to or greater than the T301 timer.
    IsdnSgTimerT301YesYesint180Possible values:
    • 1 - Minimum

    ...

    • 600 - Maximum
    		Specifies the timeout after the ISDN call enters Ringing before clearing the call if the call is not answered. The duration of this timer should not exceed the Call Setup Response Timer (TimerSanitySetup)
    IsdnSgTimerT302YesYesint15Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the inter digit timeout before proceeding with the call in overlapped dialing
    IsdnSgTimerT303YesYesint4Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after a SETUP is sent to wait for a proceeding response
    IsdnSgTimerT305YesYesint30Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after a DISCONNECT is sent to wait for a response
    IsdnSgTimerT308YesYesint4Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after a RELEASE is sent to wait for a response
    IsdnSgTimerT309YesYesint6Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after the D channel goes down to release active calls
    IsdnSgTimerT310YesYesint30Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after CALL PROCEEDING to wait for a call progress response
    IsdnSgTimerT313YesYesint4Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout for Network side ISDN after sending a CONNECT to wait for the response
    IsdnSgTimerT314YesYesint4Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout for QSIG to wait between SEGMENT messages for a segmented message
    IsdnSgTimerT316YesYesint120Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after sending a RESTART message for a response
    IsdnSgTimerT322YesYesint4Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after sending a STATUS ENQUIRY to wait for a response
    IsdnSgTimerT3M1YesYesint120Possible values:
    • 1 - Minimum
    • 255 - Maximum
    		Specifies the timeout after sending a SERVICE for a response
    ProtocolIdentifierNoNoEnum1Possible values:
    • 0 - apiNetworkExtensions
    • 1 - apiROSE
    		Specifies the Protocol Identifier to use within ASN.1 for QSIG.
    AsnNumberingSpaceNoNoEnum0Possible values:
    • 0 - ansLocal
    • 1 - ansGlobal
    		Specifies the ASN.1 numbering space for QSIG.
    IncludeNFEIAPDUNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		Specifies whether or not to include the Network Facility Extension and Interpretation APDU in ASN.1 for QSIG.
    IncludeInterfaceIdentifierNoNoEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		Specifies whether or not to include the interface identifier in out going channel identification information elements.
    ChannelNumberBitNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		Specifies whether or not to set the high bit in the channel number byte in channel identification information elements.
    SendRNInFacilityNoNoEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		Controls how the redirecting number is sent for Euro ISDN (ETSI). When enabled, redirecting number is passed into the Facility IE.
    PortChannelCountFullYesYesEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 Specifies whether or not every channel is being used for the signaling group. When set to 1 ApplyToChannelList is not used. Only applicable for PRI signaling groups.
    ApplyToChannelListYesYesstringnone512 - Max Length Apply to Channel List used to store the channel list from user. Comma seperated values of type "card.port:channel" E.g. 1.1:1,1.1:2,1.1:3,... if Channels selected and NULL, if no channels are selected. Only applicable for PRI signaling groups.
    DelayChannelClearingYesYesEnum0Possible values:
    • 0 -

    ...

    • NoDelay
    • 1- DelayUntilTimerExpiry
    • 2 -

    ...

    • DelayUntilCancelOrRelease
    		 Specifies whether or not a channel should be kept open post Disconnect, when PI=8 received.
    ChannelClearingDelayYesYesint10 Delay in Seconds channel is kept open after receiving the DISCONNECT with PI=8.
    ImmediateDisconnectOnCausecodeYesYesEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 Specifies whether or not a channel should be immediately disconnected on cause code received in Disconnect Message.
    CauseCodesYesYesstring16400 - Max Length This is a comma separated string of the Q.850 cause codes listed in the Q.850 Cause Codes. Channel should be immediately disconnected if any one of these cause code matches to that received in the Disconnect Message.
    ConvertDisconnectToProgressYesYesEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 Specifies whether or not to Send a PROGRESS message to the inbound channel when the outbound ISDN receives a DISCONNECT with PI = 8 is received.
    TEIAssignmentNoYesint-1Possible values:
    • -1 - Minimum
    • 63 - Maximum
    		 Specifies the TEI to use for TE/User side BRI. 0 through 63 are absolute values and -1 is automatic assignment. If signaling group is set for PRI or NT/Network side BRI this is not used.
    SGTypeYesYesEnum0Possible values:
    • 0 - dstDS1
    • 1 - dstBRI
    • 2 - dstNone
    		Specifies the type of ISDN signaling group.
    SendFacilityPassthroughNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 Specifies if the Signaling Group should transmit a Facility message passed through from another ISDN Signaling Group. If set then Facility message is sent, if not set then the Facility message is dropped.
    AddSetupProgressNoNoEnum0Possible values:
    • 0 - apiNone
    • 1 - apiNotEndToEnd
    • 2 - apiDestISDN
    • 3 - apiOrigISDN
    • 4 - apiReturnISDN
    • 5 - apiInterworking
    • 6 - apiInbandInfo
    • 7 - apiDelayEncountered
    		 Specifies if an outgoing SETUP message should have a Progress Indicator IE added to it with the configured value. Only adds the IE if one is not already present.
    AddNetworkSpecificFacilityNoNoEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 Specifies if an outgoing SETUP message should have a Network Specific Facility IE added to it. Only adds the IE if one is not already present. Only valid for ATT 4ESS and ATT 5ESS ISDN variants.
    NSFIdentificationNoNoEnum0Possible values:
    • 0 - nidNone
    • 1 - nidUser
    • 2 - nidNational
    • 3 - nidInternational
    		 Sets the Network Specific Facility IE identification if the IE is not present but does not modify an existing IE. Only valid when AddNetworkSpecificFacility is Enabled.
    NSFInformationNoNoEnum0Possible values:
    • 0 - ninSDN
    • 1 - ninTollFree
    • 2 - ninMEGACOM
    • 3 - ninACCUNET
    • 4 - ninInternationalTollFree
    • 5 - ninMultiQuest
    • 6 - ninLongDistance
    • 7 - ninCallRedirection
    		 Sets the Network Specific Facility IE information if the IE is not present but does not modify an existing IE. Only valid when AddNetworkSpecificFacility is Enabled.

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

    Code Block
    languagebash
    curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44 -s -k -i https://134.56.72.218/rest/isdnsg/10001 -X PUT --data "ApplyToPortName=1.1&SendRNInFacility=0&IsdnSgSwitchVariant=3&NSFIdentification=0&IsdnSgTimerT3M1=120&IsdnSgHuntMethod=4&SGType=0&IsdnSgDirection=2&IsdnSgTimerT301=180&IsdnSgTimerT302=15&IsdnSgTimerT303=4&IsdnStopFarEndT310UponTryingFromSip=0&ChannelClearingDelay=10&ChannelNumberBit=1&NoChannelAvailableId=34&IsdnSgRingbackPlayPolicy=0&TimerSanitySetup=255000&PortChannelCountFull=1&IsdnAllowCallingNameDisplayToSwitch=0&IsdnSgTimerT310=30&ConfigIEState=1&IsdnSgTimerT314=4&IsdnSgTimerT313=4&DelayChannelClearing=0&AddSetupProgress=0&IsdnServiceMessageCapability=1&IsdnSgSideOrientation=0&IncludeNFEIAPDU=1&ActionsetTableNumber=0&IsdnSgTimerT305=30&IsdnSgIndicatedChannel=1&NSFInformation=0&IsdnSgOverlapTxMode=0&IsdnSgTimerT308=4&IsdnSgTimerT309=6&IsdnSgOverlapRxMode=0&Description=REST ISDN&IncludeInterfaceIdentifier=0&IsdnSgTimerT322=4&RouteTableNumber=1&ToneTableNumber=1&AsnNumberingSpace=0&ApplyToChannelList=&AddNetworkSpecificFacility=0&SendFacilityPassthrough=1&IsdnSgTimerT316=120&ProtocolIdentifier=1&TEIAssignment=-1"

    Response:

    ...

    languagehtml/xml

    ...

    EarlyMediaOnDestNotIsdnNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 Specifies whether receiving Progress Indicator value 2 (Destination not ISDN) should be considered as early media.