Hang Up a Conference

DELETE

api

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

import requests

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

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/{conference_name}/', 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/{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

The current conference instance ends and its members disconnect. A later call using <Conference> with the same name can create a new conference instance.

Use Cases: End scheduled meetings on time, terminate conferences due to emergencies, clean up abandoned conference rooms, administrative conference management.

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your Vobiz account ID (e.g., `{auth_id}`)
`conference_name`	string	Yes	Name 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:

All participants are immediately disconnected from the conference
The current conference instance ends. A later call using <Conference> with the same name can create a new conference instance
Vobiz sends exit callbacks for disconnected members when a callback URL is configured

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)
Track the room name in your application; the retrieve endpoint is not reliable for preflight checks
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

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

import requests

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

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/{conference_name}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Path parameters

​Request Body

​Response

​Example Request

​Hang Up Conference by Name

Authorizations

Path Parameters

Response

Path parameters

Request Body

Response

Example Request

Hang Up Conference by Name