Skip to main content
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
/
{conference_name}
Delete a conference
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/
This endpoint terminates a specific conference identified by its name. All participants in the conference will be disconnected immediately.
Authentication required:
  • X-Auth-ID - Your account ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Important: This action immediately disconnects all participants and cannot be undone. The conference will end completely and cannot be resumed.
Use Cases: End scheduled meetings on time, terminate conferences due to emergencies, clean up abandoned conference rooms, administrative conference management.

​
Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour Vobiz account ID (e.g., {auth_id})
conference_namestringYesName of the conference to terminate
No request body needed. Simply use the DELETE method with the conference name in the URL path.

​
Request Body

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

​
Response

Returns an acknowledgment that the conference has been terminated.
Response - 204 No Content
HTTP Status Code: 204
What Happens:
  1. All participants are immediately disconnected from the conference
  2. The conference room is terminated and cannot be rejoined
  3. Any ongoing recordings are stopped and finalized
  4. The conference no longer appears in the active conferences list
If the conference has already ended or does not exist, you may receive an error response. Always handle 404 errors gracefully in your application.

​
Example Request

​
Hang Up Conference by Name

cURL Request
curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/My%20Conf%20Room/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"
URL-encode conference names that contain spaces or special characters.
Common Use Cases:
  • Scheduled end time: Automatically terminate meetings at their scheduled end time
  • Emergency termination: End conferences immediately due to security or policy violations
  • Admin control: Allow moderators to end conferences from admin panels
  • Cleanup: Terminate abandoned conference rooms to free resources
  • Time limits: Enforce maximum conference duration limits
  • Workflow triggers: End conference when specific conditions are met
Best Practices:
  • Notify participants before hanging up a conference (e.g., play announcement first)
  • Verify conference exists before attempting to hang up (use Retrieve Conference first)
  • Log conference terminations for audit trails and analytics
  • Implement confirmation dialogs in admin UIs before terminating active conferences
  • Handle errors gracefully - conference may have already ended naturally
  • Consider using Kick Member instead if you only need to remove specific participants
Alternative: Hang Up All ConferencesIf you need to terminate all conferences at once (e.g., for system maintenance), use the Hang Up All Conferences endpoint instead.

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

Response

204

Conference deleted