The Play Audio API lets you play audio files to participants in an ongoing call. Common uses include hold music, automated notifications, IVR prompts, and announcements while maintaining the call connection.Documentation Index
Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt
Use this file to discover all available pages before exploring further.
Supported formats: Vobiz supports
.mp3 and .wav audio files. Files must be accessible via public HTTP/HTTPS URLs.Key features
Multiple audio files
Play multiple audio files in sequence by providing comma-separated URLs.
Call leg selection
Choose which participants hear the audio: caller (A leg), callee (B leg), or both.
Loop playback
Play audio indefinitely for hold music or continuous announcements.
Audio mixing
Mix playback with call audio, or mute participants during playback.
Duration control
Limit playback duration to control costs and user experience.
Stop anytime
Stop audio playback programmatically whenever needed.
Available operations
Play audio
POST - Play an audio file or multiple files during an active call.Stop audio
DELETE - Stop audio currently being played on a call.Common use cases
- Hold music - Play music while customers wait on hold or during call transfers.
- IVR prompts - Play menu options, instructions, or navigation prompts in interactive voice systems.
- Announcements - Deliver pre-recorded announcements, promotions, or important information.
- Queue notifications - Inform callers of their position in queue or estimated wait time.
- Call recording disclaimer - Play legal disclaimers about call recording or monitoring.
Best practices
Optimize audio length - Keep files concise. Use the
length parameter to limit playback duration and avoid lengthy hold times.