Vas a lograr entender los conceptos base que atraviesan toda la API pública antes de leer la referencia de cada endpoint.

​
Jerarquía de datos

Tu clave de API pertenece a una organización y ve todas sus carteras activas — no hace falta filtrar por organización en cada request, la clave ya lo hace. Cada recurso por debajo cuelga, directa o indirectamente, de una cartera (portfolioId).

​
Los recursos

  • Cartera (GET /v1/portfolios): un conjunto de deudores gestionado como unidad — típicamente un producto o una cesión de deuda. Tiene una moneda, una región y una zona horaria propias.
  • Deudor (GET /v1/debtors): la persona o empresa que debe. Vive dentro de una cartera; agrupa sus datos de contacto, consentimiento y las deudas, llamadas, pagos y promesas asociadas a él.
  • Deuda (GET /v1/debts): un monto adeudado concreto, con su moneda, fecha de vencimiento y estado de cobro.
  • Llamada (GET /v1/calls): un intento de contacto (voz) sobre un deudor, con su duración y, cuando ya fue analizada, un bloque analysis con el resumen y el resultado de la conversación.
  • Pago (GET /v1/payments): un pago registrado contra la deuda de un deudor.
  • Promesa de pago (GET /v1/promises, sólo lista en v1): un compromiso de pago futuro, tomado en una llamada o cargado manualmente.
  • Campaña (GET /v1/campaigns): una gestión de cobranza organizada sobre un grupo de deudores de una cartera, con sus propias métricas agregadas.

​
Qué significa cada estado

​
Estado del deudor (status)

​
Estado de la deuda (status)

​
Estado de la promesa (referencia interna)

Una promesa nace pending, y termina en fulfilled (se cumplió, y queda vinculada al pago que la cumplió vía paymentId), partial, broken (no se cumplió) o cancelled.

​
Estado de la campaña (status)

draft → scheduled → active → (paused ⇄ active) → completed, o archived en cualquier punto.

​
El análisis de una llamada

GET /v1/calls/:id incluye un bloque analysis con lo que produjo el análisis post-llamada: summary (resumen en texto), sentiment (un puntaje numérico), disposition (cómo terminó la conversación, en texto libre) y outcomes (una lista de etiquetas). Si la llamada todavía no fue analizada, analysis es null — no es un error, es un estado transitorio normal entre que la llamada termina y el análisis se completa.

​
Siguiente paso

Seguí con Paginación, errores y límites para saber cómo recorrer una lista completa y qué hacer con los errores.