Skip to end of metadata
Go to start of metadata

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

Creates a CAS FXS Signaling Profile given a specific ID.

Note

The CAS FXS Signaling Profile identifier can only be within the range 1-5000 (inclusive)

URL:

https://192.168.0.111/rest/fxssignalingprofile/{identifier}

HTTP Method

PUT

Requires Authentication:

true

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length A description of the profile.
FxsLineTypeYesNoEnum0Possible values:
  • 0 - eCas_Analog
  • 1 - eCas_Digital
Used to decide if this Loop Start FXS profile is applied to analog or digital. Not currently supported.
OrientationYesNoEnum1Possible values:
  • 0 - eCas_User
  • 1 - eCas_Network
Set the CAS signaling orientation to Network (FXS). Not currently supported.
LoopStartTypeYesYesEnum2Possible values:
  • 0 - eCas_LoopStartBasic
  • 1 - eCas_LoopStartReverseBattery
  • 2 - eCas_LoopStartForwardDisconnect
Set the Signaling Type for this Loop Start protocol.
ForwardDisconnectDurationYesNoint700Possible values:
  • 100 - Minimum
  • 3000 - Maximum
Used to set the time that qualifies a valid forward disconnect (battery removal) that the system will accept. The value specifies the time in milliseconds.
FlashhookSignalDetectionYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to set if the SBC Edge should detect flashhook signals. Set to "true" to enable or "false" to disable.
MaximumFlashhookDurationYesNoint700Possible values:
  • 50 - Minimum
  • 1000 - Maximum
Used to set the maximum duration of the flashhook that will be received. Value is the time in milliseconds. Not used when FlashhookSignalDetection is set to "false".
MinimumFlashhookDurationYesNoint200Possible values:
  • 50 - Minimum
  • 1000 - Maximum
Used to set the minimum duration of the flashhook that will be received. The value specifies the time in milliseconds. Not used if FlashhookSignalDetection is "false".
DisconnectToneGenerationYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to set whether a Disconnect Tone should be generated when the call is disconnected from the far end. Set to "true" to enable or "false" to disable.
RevBattIncomingImmediateYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to set whether battery polarity should be reversed on off-hook and disconnect only (for special use, PortaOne elevator devices). Set to "true" to enable or "false" to disable.
CadenceOnTimeYesNoint2000Possible values:
  • 50 - Minimum
  • 9000 - Maximum
Used to set the cadence on time (that the local Ring Tone is audible) for a ring generated on the analog FXS side. The value is specified in milliseconds. This parameter is valid only when Group Type is set to Analog.
CadenceOffTimeYesNoint4000Possible values:
  • 50 - Minimum
  • 9000 - Maximum
Used to set the cadence off time (that the local Ring Tone is inaudible) for a ring generated on the analog FXS side. The value is specified in milliseconds. This parameter is valid only when Group Type is set to Analog.
CadenceOnTime2YesNoint400Possible values:
  • 50 - Minimum
  • 9000 - Maximum
Used to set the second cadence on time for a double ring generated on the analog FXS side. The value is specified in milliseconds. This parameter is valid only when Group Type is set to Analog and DoubleCadence is set to "true".
CadenceOffTime2YesNoint2000Possible values:
  • 50 - Minimum
  • 9000 - Maximum
Used to set the second cadence off time for a double ring generated on the analog FXS side. The value is specified in milliseconds. This parameter is valid only when Group Type is set to Analog and DoubleCadence is set to "true".
DoubleCadenceYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Indicating if Double Cadence is used to generate a double ring on the analog FXS side. Set to "true" to enable and "false" to disable. This parameter is valid only when Group Type is set to Analog.
InterDigitTimeoutYesNoint4000Possible values:
  • 250 - Minimum
  • 30000 - Maximum
Used to set the timeout time between dialed numbers. The value specifies the timeout period in milliseconds.

  • No labels