Play Audio to a Member

POST

api

Account

{auth_id}

Conference

{conference_name}

Member

{member_id}

Play

Play audio to a member

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "url": "https://example.com/audio.mp3"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/"

payload = { "url": "https://example.com/audio.mp3" }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: 'https://example.com/audio.mp3'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "play queued into conference",
  "member_id": [
    "2"
  ],
  "api_id": "API_REQUEST_ID"
}

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/

Use this endpoint to queue an audio file for one or more conference members. Vobiz fetches the file from the supplied URL and targets the member IDs in the request path.

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.

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

Request Parameters

Field	Type	Required	Description
`url`	string	Yes	URL of the audio file to play. Must be accessible via HTTPS. Supported formats: MP3, WAV.

Response

Response - 202 Accepted

{
  "message": "play queued into conference",
  "api_id": "API_REQUEST_ID",
  "member_id": ["10"]
}

Examples

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"}'

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"}'

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

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

conference_name

string

required

member_id

string

required

Body

application/json

url

string

required

URL of the audio file to play

Example:

"https://example.com/audio.mp3"

Response

202 - application/json

Audio playback queued

Play audio to a member

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "url": "https://example.com/audio.mp3"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/"

payload = { "url": "https://example.com/audio.mp3" }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: 'https://example.com/audio.mp3'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "play queued into conference",
  "member_id": [
    "2"
  ],
  "api_id": "API_REQUEST_ID"
}

​Request Parameters

​Response

​Examples

Authorizations

Path Parameters

Body

Response

Request Parameters

Response

Examples