Update audio gateway config

Update config for audio gateway

POST /api/audiogateway/updateConfig

Update audio gateway config

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/audiogateway/updateConfig \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "audioAnalysisParams": {
    "expressions": [
      {
        "confidence_min": 123,
        "expression": "<string>",
        "loudness_min": 123
      }
    ],
    "significant_loudness_min": 123
  },
  "audioExternalMicBoost": 1,
  "audioExternalMicVolume": 32,
  "audioExternalSpeakerVolume": 64,
  "audioInternalMicAecEnabled": true,
  "audioInternalMicBoost": 1,
  "audioInternalMicVolume": 32,
  "audioInternalSpeakerVolume": 64,
  "audioRecord": true,
  "audioUseExternalMic": false,
  "audioUseExternalSpeaker": false,
  "deviceMicEnabled": true,
  "deviceSpeakerEnabled": true,
  "frontendEqualizerHighShelf": {
    "frequency": 123,
    "gain": 123,
    "q": 123
  },
  "frontendEqualizerLowShelf": {
    "frequency": 123,
    "gain": 123,
    "q": 123
  },
  "frontendEqualizerPeaking1": {
    "frequency": 123,
    "gain": 123,
    "q": 123
  },
  "frontendEqualizerPeaking2": {
    "frequency": 123,
    "gain": 123,
    "q": 123
  },
  "frontendEqualizerPeaking3": {
    "frequency": 123,
    "gain": 123,
    "q": 123
  },
  "frontendNoiseSuppression": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request to update configuration for an audio gateway.

audioAnalysisParams · object

Audio analysis parameters

Show child attributes

audioExternalMicBoost · integer<int32> | null

Adjust boost for external mic. Integer between 0 and 3.

Example:

1

audioExternalMicVolume · integer<int32> | null

Adjust volume for external mic. Integer between 0 and 63.

Example:

32

audioExternalSpeakerVolume · integer<int32> | null

Adjust volume for external speaker. Integer between 0 and 127.

Example:

64

audioInternalMicAecEnabled · boolean | null

Enable acoustic echo cancellation for internal microphone

Example:

true

audioInternalMicBoost · integer<int32> | null

Adjust boost for internal mic. Integer between 0 and 3.

Example:

1

audioInternalMicVolume · integer<int32> | null

Adjust volume for internal mic. Integer between 0 and 63.

Example:

32

audioInternalSpeakerVolume · integer<int32> | null

Adjust volume for internal speaker. Integer between 0 and 127.

Example:

64

audioRecord · boolean | null

Enable/disable audio recording. Cannot set to true unless organization settings allow it

Example:

true

audioUseExternalMic · boolean | null

Use external microphone instead of internal

Example:

false

audioUseExternalSpeaker · boolean | null

Use external speaker instead of internal

Example:

false

deviceMicEnabled · boolean | null

Enable/disable device mic. Cannot set to true unless organization settings allow it

Example:

true

deviceSpeakerEnabled · boolean | null

Enable/disable device speaker

Example:

true

frontendEqualizerHighShelf · object

Show child attributes

frontendEqualizerLowShelf · object

Show child attributes

frontendEqualizerPeaking1 · object

Show child attributes

frontendEqualizerPeaking2 · object

Show child attributes

frontendEqualizerPeaking3 · object

Show child attributes

frontendNoiseSuppression · boolean | null

Enable frontend noise suppression

Example:

true

uuid · string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

Response

200 - application/json

OK

Response indicating the result of updating audio gateway configuration.

error · boolean | null

errorMsg · string | null

warningMsg · string | null