AudioPlayback Webservice

Cancel looping audio playback

Cancel any currently playing looping audio for an audio device

post/api/audioplayback/cancelLoopingAudioPlayback

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/audioplayback/cancelLoopingAudioPlayback
  • 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

audioDevicesstring[] nullable

List of audio device UUIDs to cancel looping playback on

Example request

{
  "audioDevices": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ]
}

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
successMapobject nullable

Map of audio device UUIDs to success status for canceling playback

warningMsgstring nullable

Changes

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