Skip to main content
The Ads integration lets you upload MP3 audio files — announcements, promotions, jingles — and send them to specific store locations or broadcast them across your entire network.

Core Concepts

External ID Mapping

Your External ID is your internal identifier for a location or store. Musique maps these to internal user IDs, so you always work with your own identifiers — no need to track Musique-internal IDs.
External ID    →    Musique User    →    Device
store_001      →    mp1             →    Raspberry Pi at Location A
store_042      →    mp2             →    Raspberry Pi at Location B

Targeted Send vs Broadcast

Send audio to specific locations by listing their External IDs:
POST /api/v1/integration/audio/{id}/send
{
  "externalIds": ["store_001", "store_042"]
}
Use this for regional campaigns or testing before a wider rollout.

Quick Start

Upload a file and send it to locations in two requests:
curl -X POST https://api.musique.app/api/v1/integration/audio \
  -H "X-API-Key: msk_prod_1234567890abcdef" \
  -F "file=@announcement.mp3"
Always test with a single externalId before broadcasting to all locations.

Endpoints

List Audio

Retrieve all audio files in your library.

Upload Audio

Upload a new MP3 file to your library.

Get Audio

Retrieve a specific audio file by ID.

Send Audio

Broadcast audio to devices by External ID.