Skip to main content
POST
/
api
/
audiogateway
/
getConfig
Get audio gateway config
curl --request POST \
  --url https://api2.rhombussystems.com/api/audiogateway/getConfig \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "audioGatewayUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "config": {
    "ai_license_invalid": true,
    "audio_aec_via_software": true,
    "audio_ai_disabled": true,
    "audio_analysis_enabled": true,
    "audio_analysis_params": {
      "expressions": [
        {
          "category": "SOUND_LOUD",
          "confidence_min": 123,
          "expression": "<string>",
          "loudness_min": 123
        }
      ],
      "significant_loudness_min": 123
    },
    "audio_external_mic_boost": 123,
    "audio_external_mic_volume": 123,
    "audio_external_speaker_volume": 123,
    "audio_internal_mic_aec_enabled": true,
    "audio_internal_mic_boost": 123,
    "audio_internal_mic_volume": 123,
    "audio_internal_speaker_volume": 123,
    "audio_min_echo_amplitude": 123,
    "audio_playback_gain_percent": 123,
    "audio_record": true,
    "audio_supported": true,
    "audio_use_external_mic": true,
    "audio_use_external_speaker": true,
    "audio_use_internal_speaker": true,
    "bandwidth_reports_disabled": true,
    "cloud_archive_days": 123,
    "cloud_archive_target": "0",
    "cloud_archive_upload_schedule": [
      {
        "minuteOfWeekStart": 123,
        "minuteOfWeekStop": 123
      }
    ],
    "cloud_archive_upload_schedule_inverted": true,
    "cloud_archive_upload_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "device_mic_enabled": true,
    "device_near_audio_silenced": true,
    "device_speaker_enabled": true,
    "event_clip_upload_target": "0",
    "firmware_dev_settings": {},
    "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,
    "lastModified": 123,
    "led_mode_blink_period_ms": 123,
    "led_mode_when_active": "LED_OFF",
    "led_mode_when_inactive": "LED_OFF",
    "led_stealth_mode": true,
    "lightweight_detection_disabled": true,
    "live_license_invalid": true,
    "max_event_duration_ms": 123,
    "media_ttl_minutes": 123,
    "on_demand_license_invalid": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "snapshot_upload_target": "0",
    "splice_clip_upload_target": "0",
    "storage_target_free_megabytes": 123,
    "storage_target_free_space_permyriad": 123,
    "thumbstrip_upload_target": "0"
  },
  "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 get configuration for an audio gateway.

audioGatewayUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response containing configuration for an audio gateway.

config
object

Audio gateway configuration settings

error
boolean | null
errorMsg
string | null
warningMsg
string | null