api:tools:realtime:kick
Table of Contents
API : Tools: Realtime : Clients : Kick
Introduction
This request will terminate the connection from a realtime client.
Request
| URL | https://api.telecomx.dk/tools/realtime/client/ID | ||
|---|---|---|---|
| Method | DELETE | ||
| Access level | Viewer, Manager, Reseller, ResellerAdmin and Admin | ||
| Params | ID | String | Id of connection to terminate |
Query example
DELETE https://api.telecomx.dk/tools/realtime/client/584ufh385ugh438ghfuvn
Response
| Field | Type | Description |
|---|---|---|
| succes | Boolean | True on success, false if client was not found. |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/tools/realtime/kick.txt · Last modified: 2022/11/22 19:49 by Per Møller