Vobiz
Console
DocumentationAI IntegrationsSolutionsSIP Trunking APIsVoice XML APIWhatsApp BusinessPartner
← Back to Conference

Hang Up a Conference

Terminate a specific conference and disconnect all participants.

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.

HTTP Request

DELETEhttps://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/

Path Parameters

auth_idstringRequired

Your Vobiz account ID (e.g., {Auth_ID})

conference_namestringRequired

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

Note: If the conference has already ended or doesn't 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"

Remember to URL-encode conference names with 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 Conferences

If you need to terminate all conferences at once (e.g., for system maintenance), use theHang Up All Conferences endpoint instead.

Retrieve a Conference
List All Conferences