Hang Up All Conferences

DELETE

api

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

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/

This endpoint requests termination of all ongoing conferences for your account in one operation.

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 conference instances in your account. The current conference instances end and their members disconnect. A later call using <Conference> with the same name can create a new conference instance.

The conference list can omit active rooms. Do not use an empty conferences array as a safety check before calling this endpoint. Maintain your own room registry when you need to review the affected conferences.

Use Cases: System maintenance, emergency shutdown, end-of-day cleanup, security incidents, platform-wide service termination, testing/development environment resets.

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your 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

The endpoint acknowledges the account-wide termination request with an empty response.

Response - 204 No Content

HTTP Status Code: 204

Request scope:

The request targets every active conference in the account.
It does not support selecting individual room names.
Participants do not receive an advance notification from this endpoint.

A 204 No Content response acknowledges the request. Confirm the result using your own room and call-state tracking.

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:

Current instances end: Members disconnect, but a later call using <Conference> with the same name can create a new conference instance
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:

Track rooms independently: Use your application’s room registry to determine what may 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: Confirmation with application-tracked rooms

Pass room names from your application’s state. Do not populate this list from the conference list endpoint immediately before deletion because that endpoint may omit active rooms.

JavaScript with Confirmation

async function hangUpAllConferences(conferences) {
  // Step 1: Use room names tracked by your application
  // 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' +
    'The current conference instances will end.\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: {
        'X-Auth-ID': '{auth_id}',
        'X-Auth-Token': 'YOUR_AUTH_TOKEN'
      }
    }
  );

  if (response.status === 204) {
    console.log(`Termination request accepted for ${conferences.length} tracked conferences`);
  }
}

// Usage: Call with room names from your application state
// hangUpAllConferences(['TEAM_ROOM', 'SUPPORT_ROOM']);

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

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

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Path parameters

​Request Body

​Response

​Example Request

​Hang Up All Conferences

​Example: Confirmation with application-tracked rooms

Authorizations

Path Parameters

Response

Path parameters

Request Body

Response

Example Request

Hang Up All Conferences

Example: Confirmation with application-tracked rooms