Autenticación
El endpoint usa HTTP Basic, donde el usuario es la credencial del workspace (suaccessKeyId) y la contraseña es su secreto. La cuenta referenciada por
portfolioAccountId debe pertenecer a ese mismo workspace; si no, la petición se rechaza con
401.
Cuerpo de la petición
Solo cuatro campos son obligatorios; el resto es opcional y enriquece la gestión.Id de la cuenta contactada. Debe pertenecer al workspace de las credenciales.
Canal de la gestión. Uno de
SMS, VOICE_PRERECORDED, VOICE_AI, EMAIL, WHATSAPP.Momento del contacto, como cadena de fecha-hora ISO.
Resultado de la gestión. Uno de
DELIVERED, NOT_DELIVERED, NO_ANSWER,
PAYMENT_PROMISE, PARTIAL_PAYMENT_AGREED, NEW_TERMS, CALLBACK_REQUESTED,
DISPUTE_RAISED, INFORMATION_REQUEST, RESOLVED, PAID, WRONG_NUMBER, OPT_OUT,
REFUSED, OTHER.Campaña a la que pertenece la gestión, si proviene de una campaña.
Plantilla de agente usada en la gestión.
Promesa de pago concreta sobre la que es un seguimiento esta gestión.
Duración del contacto en segundos (para gestiones de voz).
Notas libres sobre la gestión.
Importe adeudado en el momento de la gestión.
Resumen de la conversación generado por IA.
Sentimiento detectado. Uno de
POSITIVE, NEUTRAL, NEGATIVE, HOSTILE.Motivo de la deuda inferido por IA.
Resultado de la conversación según la IA.
Próximo paso sugerido por la IA.
Referencia del proveedor para este intento (ref de la llamada o sid del mensaje). Cuando se
envía, la gestión se asocia a ese intento en lugar de duplicarse.
Respuesta
En éxito, el endpoint responde201 Created con la gestión registrada.
Errores
| Código | Cuándo |
|---|---|
400 | El cuerpo no pasa la validación, o portfolioAccountId no existe. La respuesta incluye el detalle por campo. |
401 | Faltan las credenciales de workspace, son inválidas, o no están acotadas al workspace de la cuenta. |
500 | No se pudo registrar la gestión. |
Siguientes pasos
Autenticación y API keys
Credenciales de workspace y autenticación de la API.
Canales
Los canales por los que QCobro contacta a las cuentas.