Deaf a Member

POST

api

Account

{auth_id}

Conference

{conference_name}

Member

{member_id}

Deaf

Mute a member's audio

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Deaf/ \
  --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}/Deaf/"

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}/Deaf/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "deaf",
  "member_id": [
    "2"
  ],
  "api_id": "API_REQUEST_ID"
}

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

Use this endpoint to deafen members of a conference. When deafened, members cannot hear audio from other participants, but they remain connected to the conference and can still be heard by others.

Deaf vs Mute:

Deaf: Member cannot hear others (incoming audio blocked)
Mute: Others cannot hear the member (outgoing audio blocked)

Authentication required:

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

Deafened members can still speak and be heard by others. To prevent them from being heard, use the Mute Member endpoint.

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

Request Body

JSON

{}

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

Response

Response - 202 Accepted

{
  "message": "deaf",
  "member_id": ["10"],
  "api_id": "API_REQUEST_ID"
}

Examples

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/Deaf/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/all/Deaf/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Common Use Cases:

Create listen-only mode for webinar attendees
Prevent feedback loops during audio playback
Isolate members for private whisper conversations
Testing scenarios where member should not hear conference

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

202 - application/json

Deaf request accepted

Mute a member's audio

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Deaf/ \
  --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}/Deaf/"

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}/Deaf/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "deaf",
  "member_id": [
    "2"
  ],
  "api_id": "API_REQUEST_ID"
}

​Request Body

​Response

​Examples

Authorizations

Path Parameters

Response

Request Body

Response

Examples