Skip to main content
DELETE
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
Delete all conferences
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  --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/
This API lets you hang up all ongoing conferences running on your account at once. All participants across all conferences 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
Warning: This is a destructive operation that affects ALL active conferences in your account. All participants in every conference will be disconnected immediately and cannot rejoin. This action cannot be undone.
Use Cases: System maintenance, emergency shutdown, end-of-day cleanup, security incidents, platform-wide service termination, testing/development environment resets.

​
Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour Vobiz account ID (e.g., {auth_id})
No request body needed. Simply use the DELETE method on the base conference endpoint to terminate all conferences.

​
Request Body

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

​
Response

Returns a success status code indicating all conferences have been terminated.
Response - 204 No Content
HTTP Status Code: 204
What Happens:
  1. All active conferences across your account are terminated simultaneously
  2. Every participant in every conference is immediately disconnected
  3. All conference rooms are closed and cannot be rejoined
  4. Any ongoing recordings across all conferences are stopped and finalized
  5. The conferences list becomes empty
Success: A 204 status code indicates all conferences were successfully terminated. If there were no active conferences, this still returns 204.

​
Example Request

​
Hang Up All Conferences

cURL Request
curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"
Common Use Cases:
  • System maintenance: Clear all conferences before scheduled maintenance window
  • Emergency shutdown: Immediately terminate all services during critical incidents
  • End of day cleanup: Automatically close all conferences at business closing time
  • Testing environment: Reset test environment by clearing all active conferences
  • Security response: Terminate all conferences during security breach response
  • Resource management: Force-close abandoned conferences consuming resources
Important Warnings:
  • No undo: This operation cannot be reversed - terminated conferences cannot be restored
  • No selective termination: ALL conferences are affected, not just specific ones
  • Immediate effect: Disconnection happens instantly without warning to participants
  • Production caution: Use extreme caution in production environments
  • No participant notification: Participants receive no advance notice
Best Practices:
  • List first: Call List All Conferences before terminating to know what will be affected
  • Notify participants: Send announcements to conferences before terminating (if time allows)
  • Implement confirmation: Require double-confirmation in UI before executing
  • Log operations: Always log when this endpoint is called and by whom
  • Restrict access: Limit this API call to admin-level accounts only
  • Schedule carefully: Use during off-peak hours when possible
  • Alternative approach: Consider terminating conferences individually when selective control is needed

​
Example: Safe Implementation with Confirmation

JavaScript with Confirmation
async function hangUpAllConferences() {
  // Step 1: Get list of active conferences
  const listResponse = await fetch(
    'https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/',
    {
      headers: {
        'Authorization': 'Bearer {access_token}',
        'X-Auth-ID': '{auth_id}'
      }
    }
  );

  const { conferences } = await listResponse.json();

  // Step 2: Show confirmation
  if (conferences.length === 0) {
    console.log('No active conferences to terminate');
    return;
  }

  const confirmed = confirm(
    `WARNING: This will terminate ${conferences.length} active conferences.\n` +
    `Conferences: ${conferences.join(', ')}\n\n` +
    'All participants will be disconnected immediately.\n' +
    'This action cannot be undone.\n\n' +
    'Are you sure you want to continue?'
  );

  if (!confirmed) {
    console.log('Operation cancelled by user');
    return;
  }

  // Step 3: Log the operation
  console.log('Terminating all conferences:', conferences);

  // Step 4: Execute termination
  const response = await fetch(
    'https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/',
    {
      method: 'DELETE',
      headers: {
        'Authorization': 'Bearer {access_token}',
        'X-Auth-ID': '{auth_id}'
      }
    }
  );

  if (response.status === 204) {
    console.log(`Successfully terminated ${conferences.length} conferences`);
  }
}

// Usage: Call with extreme caution
// hangUpAllConferences();
Alternative: Selective TerminationIf you need more control, consider terminating conferences individually using the Hang Up a Conference endpoint. This allows you to selectively terminate specific conferences while leaving others active.

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"

Response

204

All conferences terminated