Play audio upload

Play an uploaded audio clip through an audio device

POST /api/audioplayback/playAudioUpload

Play audio upload

cURL

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
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "success": true,
  "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 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