Skip to main content
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>'
{
  "message": "Member kicked from conference"
}
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Kick/
Disconnect a member from a conference. Unlike Hang Up, kicking a member continues their XML execution - so you can play them a message or redirect them after they leave.
Authentication required: X-Auth-ID, X-Auth-Token, Content-Type: application/json
Kick 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

ParameterTypeRequiredDescription
auth_idstringYesYour Vobiz account ID
conference_namestringYesName of the conference
member_idstringYesMember 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 '{}'

​
Response

200 OK
{
  "message": "kicked",
  "member_id": "10",
  "api_id": "2867b6e2-58c3-11e1-86da-adf28403fe48"
}

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

200 - application/json

Member kicked