REST API Method: POST /rest/tonetable/{identifier}/toneprofile/{identifier}

Modifies a Tone Profile Entry given a specific Table Entry ID in a given Tone Table.

URL:

https://192.168.0.111/rest/tonetable/{identifier}/toneprofile/{identifier}

HTTP Method

POST

Requires Authentication:

true

toneprofile - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ToneProfileTypeNoNoEnum1Possible values:
  • 0 - tptUnknown
  • 1 - tptRingback
  • 2 - tptDial
  • 3 - tptBusy
  • 4 - tptCongestion
  • 5 - tptCallWaiting
  • 6 - tptDisconnect
  • 7 - tptConfirmation
  • 8 - tptMaxTone
This setting controls the tone profile type.
Frequency1YesNoint440Possible values:
  • 100 - Minimum
  • 3400 - Maximum
Specifies the first frequency in Hertz (Hz).
Frequency2NoNoint480Possible values:
  • 0 - Minimum
  • 3400 - Maximum
 Specifies a second frequency in Hertz (Hz). The configuration of a second frequency is optional.

This field needs to be set only if Frequency2 is to be configured. Set this to 0 if Frequency2 is not to be configured. If Frequency2 is to be configured, valid values are from 10-3400

Amplitude1YesNoint-19Possible values:
  • -40 - Minimum
  • 0 - Maximum
Specifies the amplitude in decibles per milliwatt (dBm) for the first frequency.
Amplitude2NoNoint-19Possible values:
  • -40 - Minimum
  • 0 - Maximum
 Specifies the amplitude in decibles per milliwatt (dBm) for the second frequency.

This field is available when Configure Frequency 2 is set to Yes.

CadenceOnYesNoint2000Possible values:
  • 0 - Minimum
  • 20000 - Maximum
 Specifies the cadence on time in milliseconds. 0 means not set else the range can be 50-20000

This field is available when Continuous Tone is set to Cadence.

CadenceOffNoNoint4000Possible values:
  • 0 - Minimum
  • 20000 - Maximum
 Specifies the cadence off time in milliseconds. 0 means not set else the range can be 50-20000

This field is available when Continuous Tone is set to Cadence.

Cadence2OnNoNoint0Possible values:
  • 0 - Minimum
  • 20000 - Maximum
 Specifies the second cadence on time in milliseconds. 0 means not set else the range can be 50-20000

This field is available when Double Cadence is set to Yes.

Cadence2OffNoNoint0Possible values:
  • 0 - Minimum
  • 20000 - Maximum
 Specifies the second cadence off time in milliseconds. 0 means not set else the range can be 50-20000

This field is available when Double Cadence is set to Yes.

Helpful Tip

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

  • No labels