Enviar uma solicitação de chamada em lote.

POST

/v1/convai/batch-calling/submit

POST

/v1/convai/batch-calling/submit

curl -X POST https://api.elevenlabs.io/v1/convai/batch-calling/submit \
     -H "Content-Type: application/json" \
     -d '{
  "call_name": "string",
  "agent_id": "string",
  "recipients": [
    {}
  ]
}'

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

Envia uma solicitação de chamadas em lote para agendar chamadas para vários destinatários.

Solicitação

This endpoint expects an object.

call_namestringObrigatório

agent_idstringObrigatório

recipientslist of objectsObrigatório

scheduled_time_unixinteger or nullOpcional

agent_phone_number_idstring or nullOpcional

whatsapp_paramsobject or nullOpcional

timezonestring or nullOpcional

branch_idstring or nullOpcional

environmentstring or nullOpcional

telephony_call_configobjectOpcional

target_concurrency_limitinteger or nullOpcional>=1

Número máximo de chamadas simultâneas para este lote. Quando definido, o envio é controlado por esse limite, em vez das porcentagens de capacidade do espaço de trabalho/agente.

Resposta

Resposta bem-sucedida

idstring

phone_number_idstring or null

phone_providerenum or null

Valores permitidos:

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_dispatchedintegerPadrão é 0

total_calls_scheduledintegerPadrão é 0

total_calls_finishedintegerPadrão é 0

last_updated_at_unixinteger

statusenum

Valores permitidos:

retry_countintegerPadrão é 0

telephony_call_configobject

target_concurrency_limitinteger or null>=1

Número máximo de chamadas simultâneas para este lote. Quando definido, o envio é controlado por esse limite, em vez das porcentagens de capacidade do espaço de trabalho/agente.

agent_namestring

branch_namestring or null

Erros

422

Unprocessable Entity Error

Cabeçalhos

Solicitação

Resposta

Erros