Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Members

Play Audio to a Member

Play audio files to specific conference members without other participants hearing.

This API allows you to play an audio file to one or more members of a conference. Only the specified members will hear the audio, while other participants remain unaffected.

Authentication Required:

  • • X-Auth-ID: Your account ID (e.g., {Auth_ID})
  • • X-Auth-Token: Your account Auth Token
  • • Content-Type: application/json

Privacy: Audio is played exclusively to the targeted member(s). Other conference participants will not hear the audio being played.

Supported Formats: MP3, WAV. Audio files must be accessible via HTTPS URL.

HTTP Request

POST/api/v1/account/{auth_id}/conference/{conference_name}/member/{member_id}/play/

The member_id can be: a specific member_id, comma-separated list, or "all" to play audio to all members.

Request Parameters

Request Parameters

NameTypeDescription
urlRequired
stringURL of the audio file to play. Must be accessible via HTTPS. Supported formats: MP3, WAV.

Response

Response - 200 OK
{
  "message": "play started",
  "api_id": "7a5e9f0a-58c4-11e1-86da-adf28403fe48",
  "member_id": ["10"]
}

Examples

Play Audio to Specific Member

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/Play/ \
                  -H "X-Auth-ID: YOUR_AUTH_ID" \
                  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
                  -H "Content-Type: application/json" \
                  -d '{"url":"https://example.com/audio/welcome.mp3"}'

Play Audio to Multiple Members

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10,15,22/Play/ \
                  -H "X-Auth-ID: YOUR_AUTH_ID" \
                  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
                  -H "Content-Type: application/json" \
                  -d '{"url":"https://example.com/audio/announcement.mp3"}'

Play Audio to All Members

cURL Request
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/all/Play/ \
                  -H "X-Auth-ID: YOUR_AUTH_ID" \
                  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
                  -H "Content-Type: application/json" \
                  -d '{"url":"https://example.com/audio/broadcast.mp3"}'

Common Use Cases:

  • • Play hold music while waiting
  • • Deliver private announcements to specific members
  • • Play instructions or prompts during the conference
  • • Broadcast alerts or notifications to all participants
Undeaf a Member
Stop Playing Audio to a Member