Skip to main content
POST
/
v1
/
voiceai
/
batch-calling
/
{batch_id}
/
cancel
Cancel A Batch Call
curl --request POST \
  --url https://api.threetone.in/v1/voiceai/batch-calling/{batch_id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "agent_id": "<string>",
  "created_at_unix": 123,
  "scheduled_time_unix": 123,
  "last_updated_at_unix": 123,
  "agent_name": "<string>",
  "phone_number_id": "<string>",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "<string>",
    "whatsapp_call_permission_request_template_language_code": "<string>",
    "whatsapp_phone_number_id": "<string>"
  },
  "total_calls_dispatched": 0,
  "total_calls_scheduled": 0,
  "total_calls_finished": 0,
  "retry_count": 0
}

Authorizations

​
x-api-key
string
header
required

API key for programmatic access

Path Parameters

​
batch_id
string
required

Response

Successful Response

Response model for a single batch call job.

​
id
string
required

Unique batch call ID

​
name
string
required

Name of the batch call job

​
agent_id
string
required

Agent ID to use for calls

​
created_at_unix
integer
required

Unix timestamp when created

​
scheduled_time_unix
integer
required

Unix timestamp when scheduled to start

​
last_updated_at_unix
integer
required

Unix timestamp of last update

​
status
enum<string>
required

Current status of the batch job

Available options:
pending,
in_progress,
completed,
failed,
cancelled
​
agent_name
string
required

Name of the agent

​
phone_number_id
string | null

Caller phone number ID

​
phone_provider
enum<string> | null

Telephony provider for batch calls.

Available options:
twilio,
vobiz,
sip_trunk
​
whatsapp_params
BatchCallWhatsAppParams · object

WhatsApp parameters for batch calls (future support).

​
total_calls_dispatched
integer
default:0

Number of calls dispatched

​
total_calls_scheduled
integer
default:0

Number of calls scheduled

​
total_calls_finished
integer
default:0

Number of calls finished (completed + failed)

​
retry_count
integer
default:0

Number of retries attempted