Skip to content
TriedDocs
Calls

Stop call

Hang up an ongoing call.

POSThttps://api.tried.com.au/v2/stop-call/{call_id}

Ends a call now. The room is torn down and the call ends with disconnection_reason: "manual_stopped". The call_ended webhook and post-call analysis follow as usual.

Request#

Path parameters#

Parameter Type Required Description
call_id string Yes The call to stop.

The endpoint takes no body.

Example request#

curl -X POST "https://api.tried.com.au/v2/stop-call/call_8d1e0f2a3b4c5d6e7f8a9b0c" \
  -H "Authorization: Bearer $TRIED_API_KEY"
const res = await fetch("https://api.tried.com.au/v2/stop-call/call_8d1e0f2a3b4c5d6e7f8a9b0c", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const data = await res.json();
import os, requests

res = requests.post(
    "https://api.tried.com.au/v2/stop-call/call_8d1e0f2a3b4c5d6e7f8a9b0c",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
data = res.json()

Response#

200 OK with the call object. Stopping a call that has already ended returns it unchanged.

Errors#

Status When
401 Missing or invalid API key.
403 The key's IP allowlist or scopes reject the request. This route needs the calls scope.
404 No call with this ID in the workspace.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.