Stop Playing Audio to a Member

DELETE

api

Account

{auth_id}

Conference

{conference_name}

Member

{member_id}

Play

Stop audio for a member

curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

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

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

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));

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

Use this endpoint to stop audio currently playing to one or more members of a conference. This is useful for interrupting audio playback before it completes naturally.

Authentication required:

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

If no audio is currently playing to the specified member(s), this call has no effect but still returns success.

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

Request Body

JSON

{}

No request body parameters required. Send an empty JSON object.

Response

A successful stop returns 204 No Content with an empty body.

Response - 204 No Content

HTTP Status Code: 204

Examples

curl -X DELETE 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"

curl -X DELETE 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"

curl -X DELETE 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"

Common Use Cases:

Stop hold music when participant becomes active
Interrupt announcements for urgent updates
Cancel audio playback when member presses DTMF key
Stop broadcast messages early

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

Response

204

Playback stopped

Stop audio for a member

curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

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

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

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));

​Request Body

​Response

​Examples

Authorizations

Path Parameters

Response

Request Body

Response

Examples