Saltar a la navegación

Enviar una solicitud de llamada por lotes.

Envía una solicitud de llamadas por lote para programar llamadas para varios destinatarios.

Encabezados

xi-api-keystringOpcional

Solicitud

This endpoint expects an object.
call_namestringRequerido
agent_idstringRequerido
recipientslist of objectsRequerido
scheduled_time_unixintegerOpcional
agent_phone_number_idstringOpcional
whatsapp_paramsobjectOpcional
timezonestringOpcional
branch_idstringOpcional
environmentstringOpcional
telephony_call_configobjectOpcional
target_concurrency_limitintegerOpcional>=1

Número máximo de llamadas simultáneas para este lote. Cuando se establece, el envío se rige por este límite en lugar de por los porcentajes de capacidad del espacio de trabajo o agente.

Respuesta

Respuesta correcta.
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

Número máximo de llamadas simultáneas para este lote. Cuando se establece, el envío se rige por este límite en lugar de por los porcentajes de capacidad del espacio de trabajo o agente.

branch_namestringOpcional

Errores

422
Batch Calls Create Request Unprocessable Entity Error