Get media URIs for audio gateway

Get media uris for audio gateway to retrieve footage

POST /api/audiogateway/getMediaUris

Get media URIs for audio gateway

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/audiogateway/getMediaUris \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "gatewayUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "lanCheckUrls": [
    "<string>"
  ],
  "lanLiveMpdUris": [
    "<string>"
  ],
  "lanLiveOpusUris": [
    "<string>"
  ],
  "lanVodMpdUrisTemplates": [
    "<string>"
  ],
  "wanLiveMpdUri": "<string>",
  "wanLiveOpusUri": "<string>",
  "wanVodMpdUriTemplate": "<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 get media URIs for an audio gateway to retrieve footage.

gatewayUuid · string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

Response

200 - application/json

OK

Response containing media URIs for audio gateway footage retrieval.

error · boolean | null

errorMsg · string | null

lanCheckUrls · (string | null)[] | null

List of LAN check URLs to verify device availability on local network

List of LAN check URLs to verify device availability on local network

lanLiveMpdUris · (string | null)[] | null

List of LAN live MPD URIs for local network media streaming

List of LAN live MPD URIs for local network media streaming

lanLiveOpusUris · (string | null)[] | null

List of LAN live Opus URIs for local network audio streaming

List of LAN live Opus URIs for local network audio streaming

lanVodMpdUrisTemplates · (string | null)[] | null

List of LAN VOD MPD URI templates for local network video on demand

List of LAN VOD MPD URI templates for local network video on demand

wanLiveMpdUri · string | null

WAN live MPD URI for real-time media streaming

wanLiveOpusUri · string | null

WAN live Opus URI for real-time audio streaming

wanVodMpdUriTemplate · string | null

WAN VOD MPD URI template for video on demand content

warningMsg · string | null