Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

REST API Method: POST /rest/fxosignalingprofile/{identifier}

Modifies a CAS FXO Signaling Profile given a specific ID.

Note

The CAS FXO Signaling Profile identifier can only be within the range 5001-10000 (inclusive)

URL:

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

HTTP Method

POST

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length A description of the profile.
FxoLineTypeYesNoEnum1Possible values:
  • 0 - eCas_Analog
  • 1 - eCas_Digital
Used to decide if this Loop Start FXO profile is applied to analog or digital. Not currently supported.
OrientationYesNoEnum0Possible values:
  • 0 - eCas_User
  • 1 - eCas_Network
Set the CAS signaling orientation to FXO. Not currently supported.
LoopStartTypeYesYesEnum0Possible values:
  • 0 - eCas_LoopStartBasic
  • 1 - eCas_LoopStartReverseBattery
  • 2 - eCas_LoopStartForwardDisconnect
Set the Signaling Type for this Loop Start protocol.
DTMFOnTimeYesNoint100Possible values:
  • 45 - Minimum
  • 250 - Maximum
Used to set how long DTMF tones are on. The value specifies the time in milliseconds.
DTMFOffTimeYesNoint100Possible values:
  • 45 - Minimum
  • 250 - Maximum
Used to set how long DTMF tones are off. The value specifies the time in milliseconds.
MinimumForwardDisconnectDurationYesNoint700Possible 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. This parameter is valid only when Loop Start Type is set to "Forward Disconnect".
DialDelayYesNoint1000Possible values:
  • 0 - Minimum
  • 10000 - Maximum
Used to delay sending digits after going off-hook. The value specifies the time in milliseconds.
SilenceBasedDisconnectYesNoint3600Possible values:
  • 0 - Minimum
  • 3600 - Maximum
Used to enable/disable supervision that disconnects a VoIP call following silence for the length of time defined. The value specifies the time in seconds. The default of 0 disables this feature.
SilenceDetectionLevelNoNoint-38Possible values:
  • -38 - Minimum
  • -20 - Maximum
Used to configure the signal strength, in dBm, used for silence detection.
DialToneDetectYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to set if Loop Start should detect dial tone on the line before dialing out. Set to "true" to enable or "false" to disable.
ProvideToneWithAnswerYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to set if for inbound FXO calls that fail before connect, the system should attempt to Connect and play Fast Busy for a bit before Disconnecting the call. Set to "true" to enable or "false" to disable.
DisconnectSupervisionYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Used to enable/disable disconnect supervision of the CAS line. This parameter is valid only when Loop Start Type is set to "Basic".
DisconnectSupervisionOptionsYesNoint2Possible values:
  • 1 - Minimum
  • 5 - Maximum
Used to set the desired on/off cadence time in one cycle for disconnect tone detection. The value specifies the number of on-off intervals per cadence cycle. This parameter is valid only when Disconnect Supervision is set to "true".

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

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

Put code example here

Response:

Put Code response here
  • No labels