取消批量调用。

POST

/v1/convai/batch-calling/:batch_id/cancel

POST

/v1/convai/batch-calling/:batch_id/cancel

curl -X POST https://api.elevenlabs.io/v1/convai/batch-calling/batch_id/cancel

{
  "id": "string",
  "phone_number_id": "string",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "string",
    "whatsapp_call_permission_request_template_language_code": "string",
    "whatsapp_phone_number_id": "string"
  },
  "name": "string",
  "agent_id": "string",
  "branch_id": "string",
  "environment": "string",
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "timezone": "string",
  "total_calls_dispatched": 0,
  "total_calls_scheduled": 0,
  "total_calls_finished": 0,
  "last_updated_at_unix": 1,
  "status": "pending",
  "retry_count": 0,
  "telephony_call_config": {
    "ringing_timeout_secs": 60,
    "twilio_call_recording_enabled": false,
    "twilio_machine_detection": {
      "mode": "enable"
    }
  },
  "target_concurrency_limit": 1,
  "agent_name": "string",
  "branch_name": "string"
}

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

路径参数

batch_idstring必需

响应

成功响应

idstring

phone_number_idstring or null

phone_providerenum or null

允许的值:

whatsapp_paramsobject or null

namestring

agent_idstring

branch_idstring or null

environmentstring or null

created_at_unixinteger

scheduled_time_unixinteger

timezonestring or null

total_calls_dispatchedinteger默认为 0

total_calls_scheduledinteger默认为 0

total_calls_finishedinteger默认为 0

last_updated_at_unixinteger

statusenum

允许的值:

retry_countinteger默认为 0

telephony_call_configobject

target_concurrency_limitinteger or null>=1

此批次的最大同时通话数。设置后，调度将受此限制控制，而非工作区/智能体容量百分比。

agent_namestring

branch_namestring or null

错误

422

Unprocessable Entity Error

路径参数

请求头

响应

错误