AudioPlayback Webservice

Play audio upload

Play an uploaded audio clip through an audio device

post/api/audioplayback/playAudioUpload

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/audioplayback/playAudioUpload
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

audioGatewayUuidsstring[] nullable

List of audio gateway device UUIDs to play audio through

audioUploadUuidstring RUUID nullable

base 64 (url-safe) uuid string

loopDurationSecinteger nullable

Duration in seconds to loop the audio playback

playCountinteger nullable

Number of times to play the audio clip

Example request

{
  "audioGatewayUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "audioUploadUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "loopDurationSec": 30,
  "playCount": 1
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
successboolean nullable

Indicates if audio playback was successful

warningMsgstring nullable

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.