Conference Members
Mute a Member
Silence outgoing audio for conference participants via POST - mute one member, a comma-separated list, or all members in a Vobiz multi-party call globally.
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
/
{conference_name}
/
Member
/
{member_id}
/
Mute
/
Mute a conference member
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/ \
--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}/Mute/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
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}/Mute/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "muted",
"member_id": [
"2"
],
"api_id": "API_REQUEST_ID"
}POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/
Authentication required:
X-Auth-ID- Your account ID (e.g.,{auth_id})X-Auth-Token- Your account Auth TokenContent-Type: application/json
Muted members can still hear other participants, but cannot be heard by others. To prevent a member from hearing, use the Deaf Member endpoint.
The
member_id can be a specific member ID, a comma-separated list, or all to mute all members.Request Body
JSON
{}
Response
Response - 202 Accepted
{
"message": "muted",
"member_id": ["10"],
"api_id": "API_REQUEST_ID"
}
Error responses
| Status | Meaning | How to handle |
|---|---|---|
401 Unauthorized | Missing/incorrect auth headers or a lowercase path. | Use both auth headers and the PascalCase path. |
404 Not Found | The conference does not exist, or the member_id is not in it (e.g. they already left). | Re-fetch members with Retrieve a Conference. URL-encode names with spaces. |
Examples
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/Mute/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json"
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/all/Mute/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json"
Common Use Cases:
- Mute all members during presenter mode
- Silence disruptive participants
- Temporary mute during announcements
- Q&A session control
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Member ID, comma-separated IDs, or all
Response
202 - application/json
Mute request accepted
Was this page helpful?
⌘I
Mute a conference member
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/ \
--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}/Mute/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
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}/Mute/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "muted",
"member_id": [
"2"
],
"api_id": "API_REQUEST_ID"
}