Cancel batch calling job

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": "id",
  "name": "name",
  "agent_id": "agent_id",
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "total_calls_dispatched": 1,
  "total_calls_scheduled": 1,
  "total_calls_finished": 1,
  "last_updated_at_unix": 1,
  "status": "pending",
  "retry_count": 1,
  "telephony_call_config": {
    "ringing_timeout_secs": 1,
    "twilio_call_recording_enabled": true,
    "twilio_machine_detection": {
      "mode": "enable"
    }
  },
  "agent_name": "agent_name",
  "phone_number_id": "phone_number_id",
  "phone_provider": "twilio",
  "whatsapp_params": {
    "whatsapp_call_permission_request_template_name": "whatsapp_call_permission_request_template_name",
    "whatsapp_call_permission_request_template_language_code": "whatsapp_call_permission_request_template_language_code",
    "whatsapp_phone_number_id": "whatsapp_phone_number_id"
  },
  "branch_id": "branch_id",
  "environment": "environment",
  "timezone": "timezone",
  "target_concurrency_limit": 1,
  "branch_name": "branch_name"
}

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

Parámetros de ruta

batch_idstringRequerido

Respuesta

Successful Response

idstring

namestring

agent_idstring

created_at_unixinteger

scheduled_time_unixinteger

total_calls_dispatchedintegerValor predeterminado: 0

total_calls_scheduledintegerValor predeterminado: 0

total_calls_finishedintegerValor predeterminado: 0

last_updated_at_unixinteger

statusenum

Valores permitidos:

retry_countintegerValor predeterminado: 0

telephony_call_configobject

agent_namestring

phone_number_idstringOpcional

phone_providerenumOpcional

Valores permitidos:

whatsapp_paramsobjectOpcional

branch_idstringOpcional

environmentstringOpcional

timezonestringOpcional

target_concurrency_limitintegerOpcional>=1

Maximum number of simultaneous calls for this batch. When set, dispatch is governed by this limit rather than workspace/agent capacity percentages.

branch_namestringOpcional

Errores

422

Batch Calls Cancel Request Unprocessable Entity Error

Parámetros de ruta

Encabezados

Respuesta

Errores