Saltar a la navegación
Referencia de la APICampañas

Crear una campaña saliente

Crea una campaña saliente que llama o envía mensajes a cada destinatario mediante el agente, dentro de las franjas de llamada de la política, con los reintentos y seguimientos que esta permita. Devuelve 201 para una campaña nueva. Una solicitud repetida, identificada mediante idempotency_key o, de lo contrario, por su cuerpo, devuelve la campaña existente con created en false.

Encabezados

xi-api-keystringOpcional

Solicitud

This endpoint expects an object.
call_namestringRequerido1-256 characters

El nombre de la campaña.

agent_idstringRequerido1-256 characters
El agente que realiza las llamadas.
recipientslist of objectsRequerido

A quién llamar. Cada destinatario se convierte en un lead de la campaña.

channel_configobjectRequerido
scheduled_time_unixintegerOpcional>=0

Cuándo empezar a llamar; omítelo para empezar ahora. Las llamadas seguirán esperando a la siguiente franja horaria de llamadas.

timezonestringOpcional

Zona horaria IANA en la que interpretar las franjas de llamada, anulando la de la política.

branch_idstringOpcional<=256 characters

La rama del agente con la que se llamará.

environmentstringOpcional<=256 characters
El entorno en el que resolver las variables de entorno del agente.
target_concurrency_limitintegerOpcional>=1

El número máximo de llamadas que se pueden realizar a la vez.

idempotency_keystringOpcional1-256 characters

Permite reintentar la solicitud con seguridad: una repetición con la misma clave devuelve la campaña que creó.

outcomeobjectOpcional

El resultado que se considera exitoso para las llamadas de la campaña.

policyobjectOpcional

Política que se guardará como instantánea en la campaña. Cuando se establece, prevalece sobre el valor predeterminado del espacio de trabajo y cualquier anulación por agente; cuando se omite, debe existir la configuración del espacio de trabajo, que proporciona la política.

variantenumOpcional

simple realiza un intento por destinatario, con franjas de llamada siempre activas y sin recopilar datos, y no se puede combinar con policy. advanced usa policy o la configuración del espacio de trabajo, y es la opción predeterminada para campañas telefónicas.

Valores permitidos:

Respuesta

Respuesta correcta.
campaignobject
createdboolean

False cuando la solicitud repite una anterior y devuelve su campaña.

within_calling_windowboolean
Si las llamadas empiezan de inmediato en lugar de en la siguiente franja horaria de llamadas.

Errores

422
Outbound Campaigns Create Request Unprocessable Entity Error