Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 3

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

medialistprofile - REST API Methods
Page Tree
rootResource - medialistprofile

Creates a Media List Profile Table given a specific Table ID.

URL:

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

HTTP Method

PUT

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max LengthMeaningful name for the profile.
VoiceFaxProfileIDYesNostring1200 - Max LengthIdentifies a comma separated string of the Media Profile IDs to be used in this profile.
CryptoProfileIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Identifies a cryto profile ID used. If no crypto profile is used then this is set to 0.
DeadCallDetectionNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
To turn on and off the DCD feature based off of RTCP.
DSCPYesNoint46Possible values:
  • 0 - Minimum
  • 63 - Maximum
The DSCP value to be used in the IP header of media packets from the Sonus SBC 1000/2000, for calls that use this Media List
ReceiveGainYesNoint0Possible values:
  • -14 - Minimum
  • 6 - Maximum
Specifies the gain or loss in decibels to apply to received signals. Rx gain implies the gain of signal from Packet to PCM side.
TransmitGainYesNoint0Possible values:
  • -14 - Minimum
  • 6 - Maximum
Specifies the gain or loss in decibels to apply to transmitted signals. Tx gain implies the gain of signal from PCM to Packet side.
SilenceSuppressionNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
To turn on and off the Voice Activity Detection and send PT13 packets when on.
SrtpROCNoNoEnum0Possible values:
  • 0 - eRocRfc3711
  • 1 - eRocResetOnNewKey
 Specifies how the SG will handle SRTP ROC on new session key:
  • eRocRfc3711
    - compliant to RFC 3711.
  • eRocResetOnNewKey
    - reset ROC on new session key.
ComfortNoiseTDMNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
 Not used.
DigitRelayTypeYesNoEnum1Possible values:
  • 0 - drtVoice
  • 1 - drtRFC2833
 Specifies the digit relay type to use.
  • RFC 2833
    - When a DTMF digit is detected in the voice stream coming from the TDM side,the digit is removed from the voice stream (going to the IP network),and is sent out-of-band using the RFC 2833 mechanism.
  • As Voice
    - The DTMF digits are sent in the voice stream without any special treatment.
DigitRelayPayloadTypeYesNoint101Possible values:
  • 96 - Minimum
  • 127 - Maximum
 Specifies the payload type used for RFC 2833 packets.
Info

This field is available when Digit (DTMF) Relay Type is set to RFC 2833.

ModemRelayYesNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies if modem passthrough is enabled when using the G.711 codec.
FaxRelayYesNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies if fax passthrough is enabled when using the G.711 codec.
CNGToneDetectionYesNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies if the system should detect fax calling tones. This tone is produced by the origination side fax machine.
CNGNumberOfCyclesYesNoint2Possible values:
  • 1 - Minimum
  • 5 - Maximum
 Specifies the number of cycles that must be detected by the system before it considers the tone to be a valid CNG tone. 1 to 5 are valid values.
Info

This field is available when CNG Tone Detection is enabled.

MediaRTCPModeYesNoEnum0Possible values:
  • 0 - rtcptRTCP
  • 1 - rtcptRTCPXR
 Specifies if RTCP-XR packet type can be used in RTCP channel. If XR is chosen make sure the remote end can support XR RTCP frames.

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

Code Block
languagebash
curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44cuc2h83fqaispmu6m519sa5642 -s -k -i https://134.56.72.218/rest/medialistprofile/1 -X PUT --data "ConfigIEState=1&CNGNumberOfCycles=2&ModemRelay=0&MediaRTCPMode=0&DigitRelayPayloadType=101&FaxRelay=0&VoiceFaxProfileID=1&DSCP=46&CNGToneDetection=1&Description=Default Media List&SrtpROC=0&CryptoProfileID=0&SilenceSuppression=0&DeadCallDetection=1&TransmitGain=0&ReceiveGain=0&DigitRelayType=1&ComfortNoiseTDM=0"

Response:

Code Block
languagehtml/xml
<?xml version="1.0"?>
<root>
 <status>
  <http_code>200</http_code>
 </status>
 <medialistprofile id="1" href="https://134.56.72.218/rest/medialistprofile/1">
  <CNGNumberOfCycles>2</CNGNumberOfCycles>
  <CNGToneDetection>1</CNGToneDetection>
  <ComfortNoiseTDM>0</ComfortNoiseTDM>
  <CryptoProfileID>0</CryptoProfileID>
  <DSCP>46</DSCP>
  <DeadCallDetection>1</DeadCallDetection>
  <Description>Default Media List</Description>
  <DigitRelayPayloadType>101</DigitRelayPayloadType>
  <DigitRelayType>1</DigitRelayType>
  <FaxRelay>0</FaxRelay>
  <MediaRTCPMode>0</MediaRTCPMode>
  <ModemRelay>0</ModemRelay>
  <ReceiveGain>0</ReceiveGain>
  <SilenceSuppression>0</SilenceSuppression>
  <SrtpROC>0</SrtpROC>
  <TransmitGain>0</TransmitGain>
  <VoiceFaxProfileID count="1">
    <entry href="https://134.56.72.218/voicecodecprofile/1">1</entry>
  </VoiceFaxProfileID>
 </medialistprofile>
</root>