Skip to main content
POST
/
api
/
audioplayback
/
playAudioUpload
Play audio upload
curl --request POST \
  --url https://api2.rhombussystems.com/api/audioplayback/playAudioUpload \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "audioGatewayUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "audioUploadUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "loopDurationSec": 30,
  "playCount": 1
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "success": true,
  "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 play an uploaded audio clip through audio devices.

​
audioGatewayUuids
(string<DeviceFacetUuid> | null)[] | null

List of audio gateway device UUIDs to play audio through

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
audioUploadUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
loopDurationSec
integer<int32> | null

Duration in seconds to loop the audio playback

Example:

30

​
playCount
integer<int32> | null

Number of times to play the audio clip

Example:

1

Response

200 - application/json

OK

Response from playing an uploaded audio clip.

​
error
boolean | null
​
errorMsg
string | null
​
success
boolean | null

Indicates if audio playback was successful

Example:

true

​
warningMsg
string | null