How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rhombus Systems AudioGateway Webservice API

The AudioGateway Webservice API from Rhombus Systems — 10 operation(s) for audiogateway webservice.

Rhombus Systems AudioGateway Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AudioGateway Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

10 operations 10 paths 41 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rhombus Systems AudioGateway Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

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

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 10 POST. Each is listed below with its method, path, parameters, and response codes.

AudioGateway Webservice 10
POST
/api/audiogateway/delete
Delete audio gateway
deleteAudioGateway 1 param body → 200
POST
/api/audiogateway/getAudioSeekpoints
Get audio seek points
getAudioSeekpoints 1 param body → 200
POST
/api/audiogateway/getConfig
Get audio gateway config
getAudioGatewayConfig 1 param body → 200
POST
/api/audiogateway/getFullAudioGatewayState
Get full audio gateway state
getFullAudioGatewayState 1 param body → 200
POST
/api/audiogateway/getMediaUris
Get media URIs for audio gateway
getAudioGatewayMediaUris 1 param body → 200
POST
/api/audiogateway/getMinimalAudioGatewayStateList
Get minimal audio gateway state list
getMinimalAudioGatewayStateList 1 param body → 200
POST
/api/audiogateway/getPresenceWindows
Get audio gateway presence windows
getAudioGatewayPresenceWindows 1 param body → 200
POST
/api/audiogateway/getUptimeWindows
Get audio gateway uptime windows
getAudioGatewayUptimeWindows 1 param body → 200
POST
/api/audiogateway/updateConfig
Update audio gateway config
updateAudioGatewayConfig 1 param body → 200
POST
/api/audiogateway/updateDetails
Update audio gateway details
updateAudioGatewayDetails 1 param body → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are IAudioUserConfig (55 properties), FullDeviceStateType (44 properties), MinimalAudioGatewayStateType (36 properties), FootageSeekPointV2Type (27 properties). Each schema is shown below with its type and property counts.

LEDModeEnum
string
Common_devices_GetUptimeWindowsWSResponse
object
Response containing uptime information for a device.
4 properties
Common_devices_GetPresenceWindowsWSResponse
object
Response containing stored video information for a device.
4 properties
Audiogateway_DeleteAudioGatewayWSResponse
object
Response indicating the result of deleting an audio gateway.
4 properties
Audiogateway_GetFullAudioGatewayStateWSRequest
object
Request to get detailed information about the state of a specified audio gateway.
2 properties
MinimalAudioGatewayStateType
object
List of minimal audio gateway state information
36 properties
Audiogateway_UpdateAudioGatewayDetailsWSRequest
object
Request to update details for an audio gateway. Note: uuid is a required field.
21 properties
DeviceStatusEnum
string
Audiogateway_GetMinimalAudioGatewayStatesWSResponse
object
Response containing basic state information for all audio gateways.
4 properties
DeviceFacetEnum
string
facet information for media
Audiogateway_GetAudioGatewayConfigWSRequest
object
Request to get configuration for an audio gateway.
1 property
Audiogateway_GetMinimalAudioGatewayStatesWSRequest
object
Request to get basic state information for all audio gateways.
IAudioUserConfig
object
Audio gateway configuration settings
55 properties
Audiogateway_GetAudioGatewayConfigWSResponse
object
Response containing configuration for an audio gateway.
4 properties
Audiogateway_GetMediaUrisWSResponse
object
Response containing media URIs for audio gateway footage retrieval.
10 properties
Audiogateway_GetAudioSeekpointsWSResponse
object
Response containing audio seek points for an audio gateway.
4 properties
Audiogateway_UpdateAudioGatewayConfigWSRequest
object
Request to update configuration for an audio gateway.
20 properties
Audiogateway_GetFullAudioGatewayStateWSResponse
object
Response containing detailed information about the state of a specified audio gateway.
4 properties
Audiogateway_GetAudioSeekpointsWSRequest
object
Request to get audio seek points for an audio gateway.
3 properties
WeeklyMinuteIntervalType
object
2 properties
Audiogateway_GetMediaUrisWSRequest
object
Request to get media URIs for an audio gateway to retrieve footage.
1 property
Audiogateway_UpdateAudioGatewayDetailsWSResponse
object
Response indicating the result of updating audio gateway details.
3 properties
WebResponseStatusEnum
string
Status of the unregister operation
SensorValType
object
3 properties
Common_devices_GetUptimeWindowsWSRequest
object
Request to get uptime information for a device.
3 properties
UploadTargetEnum
string
HardwareVariationEnum
string
FootageSeekPointV2Type
object
List of shared footage seekpoints (deprecated)
27 properties 2 required
ActivityEnum
string
Audiogateway_DeleteAudioGatewayWSRequest
object
Request to remove an audio gateway from organization.
2 properties
ToastOrderIdType
object
5 properties
FootageSeekPointColorEnum
string
AudioParamConfig
object
Audio analysis parameters
2 properties
FrontendEqualizerSettings
object
3 properties
Common_devices_GetPresenceWindowsWSRequest
object
Request to get stored video information for a device.
3 properties
ToastCheckInfo
object
1 property
TimeWindowSeconds
object
List of uptime windows for the device
2 properties
Audiogateway_UpdateAudioGatewayConfigWSResponse
object
Response indicating the result of updating audio gateway configuration.
3 properties
DeviceHealthStatusDetailsEnum
string
FullDeviceStateType
object
Detailed state information for the specified NVR
44 properties
AudioExpressionDetectionConfig
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-audiogateway-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Rhombus Systems Climate Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems AudioGateway Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.