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

Compare with Current View Page History

« Previous Version 3 Next »

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

Creates a FAX Codec Profile given a specific Table ID.

Note

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

URL:

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

HTTP Method

PUT

Requires Authentication:

true



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.
FaxRelayFallBackNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies if the T.38 should fall back to Fax Passthrough if not supported by peer.
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 the Network
    - The TCF data is passed across the IP network in the same way as any other page data.

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

curl --cookie PHPSESSID=cuc2h83fqaispmu6m519sa5642 -s -k -i https://134.56.72.218/rest/faxcodecprofile/10001 -X PUT --data "PayloadPacketRedundancy=0&SignalingPacketRedundancy=3&FaxRateInBitsPerSecond=14400&ConfigIEState=1&Description=REST FAX&TrainingConfirmation=1&ErrorCorrectionMode=0&FaxRelayFallBack=0"

Response:

<?xml version="1.0"?>
<root>
 <status>
  <http_code>200</http_code>
 </status>
 <faxcodecprofile id="10001" href="https://134.56.72.218/rest/faxcodecprofile/10001">
  <Description>REST FAX</Description>
  <ErrorCorrectionMode>0</ErrorCorrectionMode>
  <FaxRateInBitsPerSecond>14400</FaxRateInBitsPerSecond>
  <FaxRelayFallBack>0</FaxRelayFallBack>
  <PayloadPacketRedundancy>0</PayloadPacketRedundancy>
  <SignalingPacketRedundancy>3</SignalingPacketRedundancy>
  <TrainingConfirmation>1</TrainingConfirmation>
 </faxcodecprofile>
</root>
  • No labels