AudioGateway Webservice

Update audio gateway config

Update config for audio gateway

post/api/audiogateway/updateConfig

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/audiogateway/updateConfig
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

audioExternalMicBoostinteger nullable

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

audioExternalMicVolumeinteger nullable

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

audioExternalSpeakerVolumeinteger nullable

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

audioInternalMicAecEnabledboolean nullable

Enable acoustic echo cancellation for internal microphone

audioInternalMicBoostinteger nullable

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

audioInternalMicVolumeinteger nullable

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

audioInternalSpeakerVolumeinteger nullable

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

audioRecordboolean nullable

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

audioUseExternalMicboolean nullable

Use external microphone instead of internal

audioUseExternalSpeakerboolean nullable

Use external speaker instead of internal

deviceMicEnabledboolean nullable

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

deviceSpeakerEnabledboolean nullable

Enable/disable device speaker

frontendNoiseSuppressionboolean nullable

Enable frontend noise suppression

uuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

Example request

{
  "audioExternalMicBoost": 1,
  "audioExternalMicVolume": 32,
  "audioExternalSpeakerVolume": 64,
  "audioInternalMicAecEnabled": true,
  "audioInternalMicBoost": 1,
  "audioInternalMicVolume": 32,
  "audioInternalSpeakerVolume": 64,
  "audioRecord": true,
  "deviceMicEnabled": true,
  "deviceSpeakerEnabled": true,
  "frontendNoiseSuppression": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.