बैच कॉल रद्द करें।

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"
}

चल रही बैच कॉल रद्द करें और सभी प्राप्तकर्ताओं का स्टेटस cancelled पर सेट करें।

पाथ पैरामीटर

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

पाथ पैरामीटर

हेडर

रिस्पॉन्स

त्रुटियाँ