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

Compare with Current View Page History

« Previous Version 2 Next »

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

Creates a Voice Codec Profile given a specific Table ID.

Note

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

URL:

https://134.56.227.163/rest/voicecodecprofile/{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.
MediaTypeYesYesEnum3Possible values:
  • 0 - mcNone
  • 1 - mcUnknown
  • 2 - mcG711A
  • 3 - mcG711u
  • 4 - mcG723
  • 5 - mcG726
  • 6 - mcG729A
  • 7 - mcT38Fax
  • 8 - mcCN
  • 9 - mcEventSignal
  • 10 - mcRTPRedundancy
  • 11 - mcTransparent
  • 12 - mcFaxRelay
  • 13 - mcFaxRelayAlaw
  • 14 - mcFaxRelayUlaw
  • 15 - mcModemRelay
  • 16 - mcModemRelayAlaw
  • 17 - mcModemRelayUlaw
 Specifies the voice coding and encoding scheme used towards the IP side of a VoIP call. The chosen codec affects the audio quality and bandwidth consumption of VoIP calls to which you apply this Voice Codec Profile (in the Media List Profile).

Only the following codecs are currently supported:

  • mcG711A - 2
    - G.711 A-Law
  • mcG711u - 3
    - G.711 Mu-Law
  • mcG723 - 4
    - G.723.1
  • mcG726 - 5
    - G.726
  • mcG729A - 6
    - G.729

VoiceRateInBitsPerSecondNoNoint0Possible values:
  • 0 - Minimum
  • 40000 - Maximum
 Voice sampling rate in bits/sec to be used by the codec. This setting applies to G.723.1 and G.726 codecs only. For all other codecs, the voice sampling rate is fixed and defined in the appropriate specification for that codec.

This option is available when Codec is set to G.723.1 or G.726.

  • For G.723.1 - acceptable values are 5300 and 6300.
  • For G.726 - acceptable value is 32000

PayloadTypeNoNoint0Possible values:
  • 0 - Minimum
  • 127 - Maximum
 Specifies the payload type for this profile. Acceptable values for different codecs are as follows:
  • G.711 Mu-law: 0
  • G.711 A-law: 8
  • G.723.1: 4
  • G.729: 18
  • For G.726 : 2 and any number between 96-127. 2 is the payload at 32Kbps.

This option is available when Codec is G.726.

The Payload Type selected for G.726 must not conflict with that selected for Digit Relay (in Media List Profile).

PTimeInMilliSecondsNoNoint0Possible values:
  • 0 - Minimum
  • 90 - Maximum
Real-Time Transport Protocol (RTP) packet payload size in milliseconds. Smaller payload sizes decrease audio transport latency at the expense of higher bandwidth consumption.

Valid values for the different media types are:

  • G.711 A-law: 10, 20, 30, 40, 50, 60 ms
  • G.711 Mu-law: 10, 20, 30, 40, 50, 60 ms
  • G.723.1: 30, 60, 90 ms
  • G.729: 10, 20, 30, 40, 50, 60, 70, 80 ms
  • G.726: 10, 20, 30, 40, 50, 60 ms

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

curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44 -s -k -i https://134.56.72.218/rest/voicecodecprofile/1 -X PUT --data "ConfigIEState=1&Description=Default G711u&MediaType=3&PTimeInMilliSeconds=20&PayloadType=0&VoiceRateInBitsPerSecond=0"

Response:

<?xml version="1.0"?>
<root>
 <status>
  <http_code>200</http_code>
 </status>
 <voicecodecprofile id="1" href="https://134.56.72.218/rest/voicecodecprofile/1">
  <Description>Default G711u</Description>
  <MediaType>3</MediaType>
  <PTimeInMilliSeconds>20</PTimeInMilliSeconds>
  <PayloadType>0</PayloadType>
  <VoiceRateInBitsPerSecond>0</VoiceRateInBitsPerSecond>
 </voicecodecprofile>
</root>
  • No labels