Kick a conference member
kick_conference_memberRemove members from a live conference while keeping their call active, then play a message or route them elsewhere.
Instructions
Remove members from a live Vobiz conference while keeping their call up (POST /Conference/{name}/Member/{id}/Kick/): their call continues with the next VobizXML element after , so you can play them a message or route them elsewhere. To end their call instead, use hangup_conference_member. Requires confirm: true. A room that is not running, or a member who already left, returns the not_found error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly asked to remove this member from the conference. | |
| member_id | Yes | ConferenceMemberID from the ConferenceEnter callback (or get_conference), a comma-separated list such as 17,45,82, or `all` for every member. | |
| conference_name | Yes | Conference room name, exactly as used in the <Conference> XML element. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success; false when the result is an error (then error, message and retryable are set). | |
| note | No | What happens to the members' calls next. | |
| kicked | No | Always true: the members left the room. | |
| member_id | No | Members the action was applied to: the literal "all", or the list of member IDs as Vobiz echoed them (or as requested). | |
| http_status | No | HTTP status Vobiz answered with (202 = accepted, 204 = done). | |
| backend_message | No | Vobiz's own status message, or null. | |
| conference_name | No | Room the action was applied to. |