Conference Members
Kick a member
Remove a conference participant via POST while continuing their XML flow - play a post-disconnect message or redirect them across Vobiz’s global voice network.
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
/
{conference_name}
/
Member
/
{member_id}
/
Kick
/
Kick a conference member
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Kick/ \
--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}/Kick/"
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}/Kick/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "kicked",
"member_id": [
"2"
],
"api_id": "API_REQUEST_ID"
}POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Kick/
Authentication required:
X-Auth-ID, X-Auth-Token, Content-Type: application/jsonKick vs Hang Up: Use Kick when you want to remove a member but play them an announcement or redirect them via XML after disconnect. Use Hang Up to terminate the call completely.
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 |
XML continuation example
When a member is kicked, Vobiz executes the next element in the XML. For example:<Response>
<Conference enterSound="beep:1">MyConference</Conference>
<Speak>You have been disconnected from the conference</Speak>
</Response>
Request body
No request body required. Send an empty JSON object{}.
Examples
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Member/10/Kick/ \
-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/Kick/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
Response
202 Accepted
{
"message": "kicked",
"member_id": ["10"],
"api_id": "API_REQUEST_ID"
}
<Conference> in the participant’s XML response. A later join may reuse the same member ID.Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Response
202 - application/json
Kick request accepted
Was this page helpful?
⌘I
Kick a conference member
curl --request POST \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Kick/ \
--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}/Kick/"
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}/Kick/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "kicked",
"member_id": [
"2"
],
"api_id": "API_REQUEST_ID"
}