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 tres campos son obligatorios; el resto es opcional y enriquece la gestión. Una gestión describe hasta tres cosas independientes: si el mensaje llegó (entrega), qué
camino tomó la interacción (camino) y qué se obtuvo de ella (resultado). Son ejes
separados: una entrega fallida puede aun así traer un resultado (alguien contesta y dice que
no es la persona buscada), y una entrega correcta a menudo no trae ninguno.
string
required
Id de la cuenta contactada. Debe pertenecer al workspace de las credenciales.
string
required
Canal de la gestión. Uno de
SMS, VOICE_PRERECORDED, VOICE_AI, EMAIL, WHATSAPP.string
required
Momento del contacto, como cadena de fecha-hora ISO.
string
default:"DISPATCHED"
Si el intento llegó al dispositivo o buzón de la cuenta. Uno de
DISPATCHED (enviado, aun
sin confirmación), DELIVERED o FAILED. Si se omite, la gestión se registra como
DISPATCHED.string
Por qué falló la entrega. Obligatorio cuando
entrega es FAILED, y no se admite en
ningún otro caso. Uno de NO_ANSWER, BUSY, UNREACHABLE, PROVIDER_ERROR,
CHANNEL_UNSUPPORTED, INVALID_DESTINATION, REJECTED.string
Qué camino tomó la interacción una vez entregada. Uno de
ENGAGED, ABANDONED,
VOICEMAIL. Se omite cuando no hubo interacción observable.string
Qué se obtuvo de la interacción. Uno de
PAYMENT_PROMISE, NEW_TERMS, PAID,
CALLBACK_REQUESTED, DISPUTE_RAISED, INFORMATION_REQUEST, REFUSED, OPT_OUT,
WRONG_PARTY, RESOLVED. Se omite cuando la gestión no produjo ninguno, que es lo
habitual.SMS y VOICE_PRERECORDED no tienen canal de vuelta, así que solo admiten entrega.
Enviar camino o resultado en esos canales se rechaza con 400.string
Campaña a la que pertenece la gestión, si proviene de una campaña.
string
Plantilla de agente usada en la gestión.
string
Promesa de pago concreta sobre la que es un seguimiento esta gestión.
number
Duración del contacto en segundos (para gestiones de voz).
string
Notas libres sobre la gestión.
number
Importe adeudado en el momento de la gestión.
string
Resumen de la conversación generado por IA.
string
Sentimiento detectado. Uno de
POSITIVE, NEUTRAL, NEGATIVE, HOSTILE.string
Motivo de la deuda inferido por IA.
string
Resultado de la conversación según la IA.
string
Próximo paso sugerido por la IA.
string
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
Una respuesta de validación tiene la misma forma estructurada que el resto de la API:
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.