Cancel batch calling job

Cancel a running batch call and set all recipients to cancelled status.

Path parameters

batch_idstringRequired

Headers

xi-api-keystringRequired

Response

Successful Response
idstring
phone_number_idstring or null
phone_providerenum or null
Allowed values:
whatsapp_paramsobject or null
namestring
agent_idstring
created_at_unixinteger
scheduled_time_unixinteger
total_calls_dispatchedintegerDefaults to 0
total_calls_scheduledintegerDefaults to 0
total_calls_finishedintegerDefaults to 0
last_updated_at_unixinteger
statusenum
Allowed values:
retry_countintegerDefaults to 0
agent_namestring

Errors