Cancel a call
curl --request POST \
--url https://api.topcalls.ai/v1/calls/{call_id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.topcalls.ai/v1/calls/{call_id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topcalls.ai/v1/calls/{call_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topcalls.ai/v1/calls/{call_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.topcalls.ai/v1/calls/{call_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.topcalls.ai/v1/calls/{call_id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topcalls.ai/v1/calls/{call_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true
}{
"status": 400,
"title": "Cannot cancel call",
"detail": "Call is completed. Can only cancel queued or in_progress calls."
}{
"status": 401,
"title": "Unauthorized",
"detail": "Invalid API key"
}{
"status": 403,
"title": "Forbidden",
"detail": "Missing required scope(s): calls:write"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"status": 409,
"title": "Conflict: request in-flight",
"detail": "Another request with the same Idempotency-Key is currently being processed. Retry once it completes."
}Calls
Cancel a call
Same as /stop, with a bare { "ok": true } response. Only a queued or in_progress call can be cancelled.
POST
/
v1
/
calls
/
{call_id}
/
cancel
Cancel a call
curl --request POST \
--url https://api.topcalls.ai/v1/calls/{call_id}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.topcalls.ai/v1/calls/{call_id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.topcalls.ai/v1/calls/{call_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topcalls.ai/v1/calls/{call_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.topcalls.ai/v1/calls/{call_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.topcalls.ai/v1/calls/{call_id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topcalls.ai/v1/calls/{call_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ok": true
}{
"status": 400,
"title": "Cannot cancel call",
"detail": "Call is completed. Can only cancel queued or in_progress calls."
}{
"status": 401,
"title": "Unauthorized",
"detail": "Invalid API key"
}{
"status": 403,
"title": "Forbidden",
"detail": "Missing required scope(s): calls:write"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"code": "<string>",
"instance": "<string>",
"errors": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"status": 409,
"title": "Conflict: request in-flight",
"detail": "Another request with the same Idempotency-Key is currently being processed. Retry once it completes."
}Authorizations
Use Authorization: Bearer tc_live_xxxxx
Headers
Makes a retry safe. A 2xx response is stored for 24 hours per account, and a retry with the same key gets it back with Idempotent-Replay: true instead of running again. Errors aren't stored, so a retry after one runs fresh. The key isn't tied to a path or body: use a new key for every different request. A malformed key gets 400.
Required string length:
8 - 255Pattern:
^[A-Za-z0-9_-]+$Example:
"a1b2c3d4-e5f6-7890-abcd-ef0123456789"
Path Parameters
Call UUID
Response
Cancel requested. A live call gets its final status when the line closes.
Example:
true
⌘I