curl --request POST 'https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/cancel' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16" \
--header "Content-Type: application/json" \
--data '{}'const response = await fetch("https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/cancel", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"POST",
"https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/cancel",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
json={},
)
print(response.status_code, response.json()){
"id": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"answer_status": "answered",
"contact_id": "con_demo_001",
"agent_id": "agt_demo_001",
"queued_at": "2026-07-20T01:00:00Z",
"created_at": "2026-07-20T01:00:00Z",
"updated_at": "2026-07-20T01:00:00Z",
"batch_id": "bat_demo_001",
"automation_run_id": "run_demo_001",
"outcome": "qualified",
"outcome_reason": "Requested a follow-up.",
"summary": "Customer requested a follow-up next week.",
"duration_seconds": 92,
"dialing_at": "2026-07-20T01:00:00Z",
"connected_at": "2026-07-20T01:00:00Z",
"ended_at": "2026-07-20T01:00:00Z",
"cancel_requested_at": "2026-07-20T01:00:00Z",
"cancelled_at": "2026-07-20T01:00:00Z"
}Cancel a call
Requests idempotent best-effort cancellation. Completion may win a terminal-state race. An optional Idempotency-Key makes the result replayable; the raw JSON body is limited to 1 MiB. Every response includes Brightalk-Version and X-Request-Id; rate-limited responses also expose the effective bucket counters.
curl --request POST 'https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/cancel' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16" \
--header "Content-Type: application/json" \
--data '{}'const response = await fetch("https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/cancel", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"POST",
"https://api.brightalk.ai/calls/11111111-1111-4111-8111-111111111111/cancel",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
"Content-Type": "application/json",
},
json={},
)
print(response.status_code, response.json()){
"id": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"answer_status": "answered",
"contact_id": "con_demo_001",
"agent_id": "agt_demo_001",
"queued_at": "2026-07-20T01:00:00Z",
"created_at": "2026-07-20T01:00:00Z",
"updated_at": "2026-07-20T01:00:00Z",
"batch_id": "bat_demo_001",
"automation_run_id": "run_demo_001",
"outcome": "qualified",
"outcome_reason": "Requested a follow-up.",
"summary": "Customer requested a follow-up next week.",
"duration_seconds": 92,
"dialing_at": "2026-07-20T01:00:00Z",
"connected_at": "2026-07-20T01:00:00Z",
"ended_at": "2026-07-20T01:00:00Z",
"cancel_requested_at": "2026-07-20T01:00:00Z",
"cancelled_at": "2026-07-20T01:00:00Z"
}Authorizations
Use a server-side Brightalk API key in the Authorization header.
Headers
Selects the date-based API version. Omission uses the organization’s pinned default.
"2026-07-16"A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.
64^[A-Za-z0-9._:-]{1,64}$Optionally makes this state transition replayable for 24 hours.
1 - 255^(?=.{1,255}$)[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$Path Parameters
The opaque Call identifier. An opaque resource identifier.
1 - 255"11111111-1111-4111-8111-111111111111"
Body
JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.
The body is of type object.
Response
Current Call resource returned.
An opaque resource identifier.
1 - 255"11111111-1111-4111-8111-111111111111"
queued, dialing, in_progress, completed, failed, cancelled answered, no_answer, busy, voicemail, unknown An opaque resource identifier.
1 - 255"con_demo_001"
An opaque resource identifier.
1 - 255"agt_demo_001"
When the call entered the durable queue.
"2026-07-20T01:00:00Z"
When the public Call resource was created.
"2026-07-20T01:00:00Z"
When the Call resource was last updated.
"2026-07-20T01:00:00Z"
An opaque resource identifier.
1 - 255"bat_demo_001"
An opaque resource identifier.
1 - 255"run_demo_001"
A normalized or configured business outcome.
"qualified"
A concise reason for the outcome.
"Requested a follow-up."
A concise call summary.
"Customer requested a follow-up next week."
x >= 092
When dialing began.
"2026-07-20T01:00:00Z"
When the call connected.
"2026-07-20T01:00:00Z"
When the call ended.
"2026-07-20T01:00:00Z"
When cancellation was requested.
"2026-07-20T01:00:00Z"
When cancellation won the terminal-state race.
"2026-07-20T01:00:00Z"