Kick a Member

Disconnect a member from a conference while allowing XML flow continuation.

This method lets you disconnect a member in a conference. When the member is disconnected, the next action to be performed depends on the next element in the XML.

Authentication Required:

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

XML Example: If the XML code below starts the conference, Vobiz will play the text in the Speak tag after the member is disconnected.

XML Example

<Response>
    <Conference enterSound="beep:1">MyConference</Conference>
    <Speak>You have been disconnected from the conference</Speak>
</Response>

Difference from Hang Up: Kick allows XML continuation, while Hang Up terminates the call completely.

HTTP Request

POST/api/v1/account/{auth_id}/conference/{conference_name}/member/{member_id}/kick/

The member_id can be: a specific member_id, comma-separated list, or "all" to kick all members.

Request Body

JSON

{}

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

Response

Response - 200 OK

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

Examples

Kick Specific Member

cURL Request

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 '{}'

Kick All Members

cURL Request

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 '{}'

Use Case: Kick is useful when you want to remove a member but play them an announcement or redirect them to another action via XML.

Hang Up a Member

Mute a Member