REST API Method: PUT /rest/faxcodecprofile/{identifier}
Page Tree |
---|
root | Resource - faxcodecprofile |
---|
|
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 |
---|
Description | No | No | string | none | 64 - Max Length | Identifies this profile so it can be easily recognized when selecting a codec. |
---|
FaxRelayFallBack | No | No | Enum | 0 | Possible values: - 0 - edtEnable
- 1 - edtDisable
| Specifies if the T.38 should fall back to Fax Passthrough if not supported by peer. |
---|
FaxRateInBitsPerSecond | No | No | int | 14400 | Possible values: - 2400 - Minimum
- 14400 - Maximum
| Specifies the maximum fax connection rate. Acceptable rate values are: - 2400
- 4800
- 7200
- 9600
- 14400
|
---|
SignalingPacketRedundancy | No | No | int | 3 | Possible values: | Specifies the number of redundant packets to be sent for each T.30 (signaling) message. |
---|
PayloadPacketRedundancy | No | No | int | 0 | Possible values: | Specifies the number of redundant packets to be sent for each packet containing page data. |
---|
ErrorCorrectionMode | No | No | Enum | 0 | Possible values: - 0 - edtEnable
- 1 - edtDisable
| Specifies the error correction mode (ECM) for fax calls. |
---|
TrainingConfirmation | No | No | Enum | 1 | Possible 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.
|
---|
Code Block |
---|
|
Put code example herecurl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44 -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:
Code Block |
---|
|
Put Code response here<?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>
|