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/cassg/{identifier}

cassg - REST API Methods
Page Tree
rootResource - cassg

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

Note
titleNote

The CAS Signaling Group identifier can only be within the range 20001-30000 (inclusive)

URL:

https://134.56.227.163/rest/cassg/{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.
DescriptionNoNostringnone64 - Max LengthA description about this signaling group.
CasLineTypeYesYesEnum0Possible values:
  • 0 - eCas_Analog
  • 1 - eCas_Digital
Indicating if this CAS Signaling Group is applied to an analog or digital line.
CasSignalingTypeYesYesEnum0Possible values:
  • 0 - eCas_LoopStartFxs
  • 1 - eCas_LoopStartFxo
  • 2 - eCas_EnM
  • 3 - eCas_R2
Sets the CAS signaling type for this Signaling Group. Can be set to E&M, R2, FXS Loop Start or FXO Loop Start. If Line Type is set to Analog, only Loop Start profiles will be valid.
CallerIDTypeYesYesNoEnum1Possible values:
  • 0 - eCas_CallerIdDisabled
  • 1 - eCas_CallerIdFSK
  • 2 - eCas_CallerIdDTMF
  • 3 - eCas_CallerIdDTMF_ReverseBattery
  • 4 - eCas_CallerIdETSI_ReverseBattery
  • 5 - eCas_CallerIdNTT_Japan
  • 6 - eCas_CallerIdETSI
  • 7 - eCas_CallerIdDTMF_NoRing
  • 8 - eCas_CallerIdFSK_NoRing
Used to specify the Caller ID Type for this signaling group.
CasEnMProfileIdNoYesint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Sets the CAS E&M profile index. When this Signaling group is configured for CAS E&M this will be the index of the CAS Signaling profile used. If set to 0 it indicates that the CAS Signaling Group is not configured for CAS E&M operation. Only one of the four attributes: CasEnMProfileId, CasR2ProfileId, CasLoopStartFxoProfileId and CasLoopStartFxsProfileId should be set to a non-zero value at a time.
CasR2ProfileIdNoYesint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Sets the CAS R2 profile index. When this Signaling group is configured for CAS R2 this will be the index of the CAS Signaling profile used. If set to 0 it indicates that the CAS Signaling Group is not configured for CAS R2 operation. Only one of the four attributes: CasEnMProfileId, CasR2ProfileId, CasLoopStartFxoProfileId and CasLoopStartFxsProfileId should be set to a non-zero value at a time.
CasLoopStartFxoProfileIdNoYesint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Sets the CAS FXO Loop Start profile index. When this Signaling group is configured for CAS FXO Loop Start this will be the index of the CAS Signaling profile used. If set to 0 it indicates that the CAS Signaling Group is not configured for CAS FXO Loop Start operation. Only one of the four attributes: CasEnMProfileId, CasR2ProfileId, CasLoopStartFxoProfileId and CasLoopStartFxsProfileId should be set to a non-zero value at a time.
CasLoopStartFxsProfileIdNoYesint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Sets the CAS FXS Loop Start profile index. When this Signaling group is configured for CAS FXS Loop Start this will be the index of the CAS Signaling profile used. If set to 0 it indicates that the CAS Signaling Group is not configured for CAS FXS Loop Start operation. Only one of the four attributes: CasEnMProfileId, CasR2ProfileId, CasLoopStartFxoProfileId and CasLoopStartFxsProfileId should be set to a non-zero value at a time.
CasSupplementaryProfileIdNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Supplementary Services Profile Index. If set to 0, it indicates that no Supplementary Services are supported in this CAS SG. This item will be shown only when CAS Signaling Profile is set to a Loop Start Signaling Profile.
CasSgDirectionYesYesEnum2Possible values:
  • 0 - sgdirInbound
  • 1 - sgdirOutbound
  • 2 - sgdirBidirectional
Direction of calls handled by this signaling group.
EndOfDialDigitYesNostringnone1 - Max LengthUsed to set the end dial digit of the dialed numbers. This parameter is unused at this time.
RelayCallingNameYesNoEnum1Possible values:
  • 0 - eCas_Disabled
  • 1 - eCas_RelayCallingName
  • 2 - eCas_RelayDeafultCallingName
Used to enable/disable Relay Calling Name.
CasSgHuntMethodYesYesNoEnum4Possible values:
  • 0 - sghmStandard
  • 1 - sghmReverseStandard
  • 2 - sghmRoundRobin
  • 3 - sghmLeastIdle
  • 4 - sghmMostIdle
  • 5 - sghmOwnNumber
Channel hunting method. It is applicable only if Direction is "Incoming".
CasSgRingbackPlayPolicyYesYesNoEnum0Possible values:
  • 0 - sgrbpAuto
  • 1 - sgrbpAlways
  • 2 - sgrbpNever
Play ringback tone on channel.
RouteTableIdYesYesNoint1Possible values:
  • 1 - Minimum
  • 65534 - Maximum
Route Table Index.
ToneTableIdYesYesNoint1Possible values:
  • 1 - Minimum
  • 65534 - Maximum
Tone Table Index. In Sonus SBC 1000/2000 2.0, the Tone table should support ring back tone, dial tone, disconnect tone and busy tone.
ActionSetTableIdNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Action Set Index. It is not used if Direction is set to "Outgoing". Note. When ActionSetTableId is not 0, it takes precedence over Route Table.
NoChannelAvailableIdNoNoint34Possible values:
  • 1 - Minimum
  • 127 - Maximum
 In case of "No Channel/Circuit available" release cause code, Common Call Control 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. The cause code should be in the range of 1 to 127 as defined in Q.850 Cause Codes.
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.
CallForwardYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to enable/disable the Call Forward feature. If it is enabled the configuration for the Activate and Deactivate keycodes will become visible. The user can then configure their own keycodes if desired. This attribute is only applicable for Analog FXS signaling groups.
CallForwardActivateYesNostring*726 - Max LengthThis field indicates the characters that are used to activate Call Forward on a specific port. This attribute is only applicable for Analog FXS signaling groups, and only if call forwarding is enabled.
CallForwardDeactivateYesNostring*736 - Max LengthThis field indicates the characters that are used to deactivate Call Forward on a specific port. This attribute is only applicable for Analog FXS signaling groups, and only if call forwarding is enabled.
ApplyToChannelListYesYesstringnone512 - Max LengthDS1 Channel IDs or Analog Channel IDs. This is a comma separated list of channel IDs. Channel ID format needs to specified as "x.y" (ports) or "x.y.z" (channels) where: x - card number, y - port number, z - channel numbers. x must be 1 or 2; y must be an integer between 1 and 8 for digital, or an integer between 1 and 24 for analog; z must be an integer or a range of integer between 1 and 24 for T1, or be an integer between 1 and 31 for E1, or 1 for analog.
ChannelOwnNumberListNoNostringnone1024 - Max LengthFor Own Number hunting this field will be a comma-separated list of up to 48 channel phone numbers, whose entries line up with their associated channel in the AppliedToChannelList.
FXSHotlineNumberListNoNostringnone1024 - Max LengthFor FXS signaling groups this field is a comma-separated list of CAS FXS Hotline phone numbers, whose entries line up with their associated channel in the AppliedToChannelList. Token values within the commas will be empty if the corresponding channel is not configured for hotline.
FXSCallForwardingNumberListNoNostringnone1024 - Max LengthFor FXS Analog Signaling Groups this field is a comma-separated list of CAS FXS Call Forwarding phone numbers, whose entries line up with their associated channel in the AppliedToChannelList. Token values within the commas will be empty if the corresponding channel is not configured for call forwarding. This list may either be updated by a configuration update, or by an analog subscriber setting a call forwarding number through their telephone touch pad.
CasSgDTMFCallerIDStartDelimiterNoNoEnum13Possible values:
  • 0 - tone_0
  • 1 - tone_1
  • 2 - tone_2
  • 3 - tone_3
  • 4 - tone_4
  • 5 - tone_5
  • 6 - tone_6
  • 7 - tone_7
  • 8 - tone_8
  • 9 - tone_9
  • 10 - tone_A
  • 11 - tone_B
  • 12 - tone_C
  • 13 - tone_D
  • 14 - tone_Hash
  • 15 - tone_Asterisk
This field indicates the DTMF tones used as the caller ID start delimiter. This attribute is applicable only if the signaling profile is of type FXS or FXO, only if the Line Type is Analog, and only if the Caller ID Type iss DTMF, DTMF No Ring, or DTMF Reverse Battery.
CasSgDTMFCallerIDEndDelimiterNoNoEnum12Possible values:
  • 0 - tone_0
  • 1 - tone_1
  • 2 - tone_2
  • 3 - tone_3
  • 4 - tone_4
  • 5 - tone_5
  • 6 - tone_6
  • 7 - tone_7
  • 8 - tone_8
  • 9 - tone_9
  • 10 - tone_A
  • 11 - tone_B
  • 12 - tone_C
  • 13 - tone_D
  • 14 - tone_Hash
  • 15 - tone_Asterisk
This field indicates the DTMF tones used as the caller ID end delimiter. This attribute is applicable only if the signaling profile is of type FXS or FXO, only if the Line Type is Analog, and only if the Caller ID Type iss DTMF, DTMF No Ring, or DTMF Reverse Battery.
CallInformationFormatENMYesYesNoEnum0Possible values:
  • 0 - eCas_CalledParty
  • 1 - eCas_CallingCalled
  • 2 - eCas_CalledCalling
Indicates the format of call information sent and received.
CasSgENMStartDigitNoYesNoEnum15Possible values:
  • 0 - tone_0
  • 1 - tone_1
  • 2 - tone_2
  • 3 - tone_3
  • 4 - tone_4
  • 5 - tone_5
  • 6 - tone_6
  • 7 - tone_7
  • 8 - tone_8
  • 9 - tone_9
  • 10 - tone_A
  • 11 - tone_B
  • 12 - tone_C
  • 13 - tone_D
  • 14 - tone_Hash
  • 15 - tone_Asterisk
Indicates the first digit of the call information sent or received.
CasSgENMEndDigitNoYesNoEnum15Possible values:
  • 0 - tone_0
  • 1 - tone_1
  • 2 - tone_2
  • 3 - tone_3
  • 4 - tone_4
  • 5 - tone_5
  • 6 - tone_6
  • 7 - tone_7
  • 8 - tone_8
  • 9 - tone_9
  • 10 - tone_A
  • 11 - tone_B
  • 12 - tone_C
  • 13 - tone_D
  • 14 - tone_Hash
  • 15 - tone_Asterisk
Indicates the last digit of the call information sent or received.
CasSgENMDelimiterDigitNoYesNoEnum15Possible values:
  • 0 - tone_0
  • 1 - tone_1
  • 2 - tone_2
  • 3 - tone_3
  • 4 - tone_4
  • 5 - tone_5
  • 6 - tone_6
  • 7 - tone_7
  • 8 - tone_8
  • 9 - tone_9
  • 10 - tone_A
  • 11 - tone_B
  • 12 - tone_C
  • 13 - tone_D
  • 14 - tone_Hash
  • 15 - tone_Asterisk
Indicates the digit of the call information sent or received which separates calling and called numbers".
CallerIdPrivacySignalingYesNostringnone5 - Max LengthThis field indicates the characters that are sent to signal that the Caller Id is private/restricted. Only valid for CAS Digital and Analog LoopStart FXS interfaces.