Conference Members
Hang up a member
Terminate a conference member’s call via DELETE - disconnect one participant, a list of IDs, or all members from a Vobiz multi-party voice call globally.
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
/
{conference_name}
/
Member
/
{member_id}
/
Hang up a member
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/ \
--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}/"
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}/', 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}/
Authentication required:
X-Auth-ID, X-Auth-Token, Content-Type: application/jsonReused-member-ID edge case: If a member is kicked, continues its XML flow, and rejoins with the same numeric member ID, a later hang-up request can return
204 No Content without removing the rejoined leg. Use the most recent enter callback, make cleanup idempotent, and confirm removal through an exit or call hangup callback.Kick a Member is not a direct replacement for hang up. Kick removes the member from the room but continues the participant’s XML flow after
<Conference>; hang up ends the call.Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your Vobiz account ID |
conference_name | string | Yes | Name of the conference |
member_id | string | Yes | Member ID, comma-separated list of IDs, or all |
Request body
No request body required.Examples
curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/ \
-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/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
Response
204 No Content
HTTP Status Code: 204
204 No Content is followed by a conference exit callback and call termination. In the reused-member-ID edge case described above, confirm the final state through callbacks.Was this page helpful?
⌘I
Hang up a member
curl --request DELETE \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/ \
--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}/"
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}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));