Versions Compared

Old Version 6

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

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

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

medialistprofile - REST API Methods
Page Tree
rootResource - medialistprofile

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

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/medialistprofile/{identifier}

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[medialistprofile - REST API Methods|Resource - medialistprofile]

Page Tree
root@parent

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.
DtlsProfileIDNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Identifies a DTLS profile ID used. If no DTLS 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

...

SBC

...

, 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. This is applicable only for the SBC 1000/2000 platforms.
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. This is applicable only for the SBC 1000/2000 platforms.
SilenceSuppressionNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
To turn on and off the Voice Activity Detection and send PT13 packets when on.

...

EnforceCodecPriorityNoNoEnum

...

1Possible values:
  • 0 -

...

  • edtEnable
  • 1 -

...

  • eRocRfc3711
    - compliant to RFC 3711.
  • eRocResetOnNewKey
    - reset ROC on new session key.
  • edtDisable
To turn on and off the configured Codec priority.
ComfortNoiseTDMNoNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
 Not used.
DigitRelayTypeYesNoEnum1Possible values:
  • 0 - drtVoice
  • 1 - drtRFC2833
  • 2 - drtSIPInfo
 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. This is applicable only for the SBC 1000/2000 platforms.
FaxRelayYesNoEnum0Possible values:
  • 0 - edtEnable
  • 1 - edtDisable
Specifies if fax passthrough is enabled when using the G.711 codec. This is applicable only for the SBC 1000/2000 platforms.
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. This is applicable only for the SBC 1000/2000 platforms.
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. This is applicable only for the SBC 1000/2000 platforms.
Info

This field is available when CNG Tone Detection is enabled.

FAXToneDetectionYesNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies if the system should detect fax(V.21 flag) tone. This tone is produced by the terminating side fax machine. This is enabled for SBC 1000/2000 and disabled for SWe Edge by default.
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. This is applicable only for the SBC 1000/2000 platforms.
DtmfSignalToNoiseYesNoint0Possible values:
  • -3 - Minimum
  • 6 - Maximum
 Controls the minimum Signal to Noise ratio threshold (in decibels) for the DTMF detector. This is applicable only for the SBC 1000/2000 platforms.
DtmfMinimumLevelYesNoint-38Possible values:
  • -48 - Minimum
  • -14 - Maximum
 Controls the minimum level (dBm0) for each of the received DTMF components. This is applicable only for the SBC 1000/2000 platforms.

Tip
titleHelpful Tip

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