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

Modifies a FAX Codec Profile Table given a specific Table ID.

Note

The FAX Codec Profile identifier can only be within the range 1-9999 (inclusive)

URL:

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

HTTP Method

POST

Requires Authentication:

true

faxcodecprofile - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max Length Identifies this profile so it can be easily recognized when selecting a codec.
FaxRateInBitsPerSecondNoNoint14400Possible values:
  • 2400 - Minimum
  • 14400 - Maximum
 Specifies the maximum fax connection rate. Acceptable rate values are:
  • 2400
  • 4800
  • 7200
  • 9600
  • 14400
SignalingPacketRedundancyNoNoint3Possible values:
  • 0 - Minimum
  • 7 - Maximum
Specifies the number of redundant packets to be sent for each T.30 (signaling) message.
PayloadPacketRedundancyNoNoint0Possible values:
  • 0 - Minimum
  • 3 - Maximum
Specifies the number of redundant packets to be sent for each packet containing page data.
ErrorCorrectionModeNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies the error correction mode (ECM) for fax calls.
TrainingConfirmationNoNoEnum1Possible values:
  • 0 - tctLocallyGenerate
  • 1 - tctSendOverNetwork
 Specifies the Training Confirmation (TCF) procedure for fax calls.
  • Locally Generate
    - The TCF data is not passed across the IP network. Each gateway independently generates or checks the TCF and only the result of the training is passed over the network.
  • Send Over Network
    - The TCF data is passed across the IP network in the same way as any other page data.

For the SWe Edge only Send Over Network is supported.

FaxRelayFallBackNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies if the T.38 should fall back to Fax Passthrough if not supported by peer.
SG3ToG3FallbackYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies if the system should force Super G3 to Super G3 fax calls to lower rates so T.38 protocol can be used. This is applicable only for the SBC 1000/2000 platforms

Helpful Tip

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

  • No labels