Delete SIP endpoint
delete_sip_endpointPermanently delete a Vobiz SIP endpoint, disconnecting devices and freeing its username. This cannot be undone; to block temporarily, use update_sip_endpoint.
Instructions
Permanently delete a Vobiz SIP endpoint; this cannot be undone. Devices registered with it disconnect immediately and its SIP URI stops working; the username becomes free for a new endpoint. To block a device temporarily, change its password with update_sip_endpoint instead. An unknown endpoint_id raises not_found. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly approved: deleting this SIP endpoint. | |
| endpoint_id | Yes | Numeric SIP endpoint ID (4-25 digits): endpoint_id from list_sip_endpoints or create_sip_endpoint. Unknown ids raise not_found. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| deleted | No | ||
| endpoint_id | No | The endpoint that was deleted. | |
| http_status | No | HTTP status Vobiz answered with. |