Hang up a conference member
hangup_conference_memberEnds a conference member's call so they leave the room and their call hangs up. Use to drop a participant completely; set confirm to true.
Instructions
End the calls of members in a live Vobiz conference (DELETE /Conference/{name}/Member/{id}/): they leave the room and their call hangs up. Use it to drop a participant completely; to keep their call going after they leave, use kick_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 hang up this member's call. | |
| 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 | How to confirm the members actually left. | |
| hung_up | No | Always true: the hang-up was accepted. | |
| 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). | |
| conference_name | No | Room the action was applied to. |