Skip to main content
POST
/
api
/
audiogateway
/
updateConfig
Update audio gateway config
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 '
{
  "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"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to update configuration for an audio gateway.

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
frontendEqualizerLowShelf
object
frontendEqualizerPeaking1
object
frontendEqualizerPeaking2
object
frontendEqualizerPeaking3
object
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