Al recuperar datos mediante la Aircall API, los endpoints de listado devuelven los resultados utilizando paginación. Este enfoque ayuda a gestionar grandes volúmenes de datos dividiendo las respuestas en varias páginas y proporcionando detalles de navegación para cada una.

Conceptos básicos de la paginación

Los detalles de paginación se incluyen en el objeto meta de la respuesta de la API. Este objeto proporciona información clave sobre el conjunto de datos actual y la navegación:

  • count: Número de elementos en la página actual

  • total: Número total de elementos que coinciden con la consulta

  • current_page: Número de la página actual

  • per_page: Número de elementos devueltos por página

  • next_page_link / previous_page_link: Enlaces para navegar entre páginas

Puedes controlar la paginación mediante los siguientes parámetros de consulta:

  • page: Número de página (valor predeterminado: 1)

  • per_page: Número de resultados por página (valor predeterminado: 20, máximo: 50)

Ejemplo

GET /v1/calls?page=2&per_page=50

Límite de 10.000 registros

Por motivos de rendimiento, los endpoints de listado de la Aircall API están limitados a un máximo de 10.000 registros por consulta, incluso cuando se utiliza la paginación.

Este límite se aplica a los endpoints que devuelven colecciones de recursos, incluidos:

  • Listar todas las llamadas

  • Listar todos los contactos

  • Otros endpoints de listado similares

Si más de 10.000 registros coinciden con una solicitud, la API solo devolverá los primeros 10.000 resultados. Las páginas que superen este rango no son accesibles.

Importante: Los parámetros de paginación como page y per_page no permiten superar el límite de 10.000 registros.

Recuperar más de 10.000 registros

Para recuperar conjuntos de datos más grandes, divide tus solicitudes utilizando los filtros disponibles, como los parámetros basados en el tiempo.

Por ejemplo, el endpoint /v1/calls admite:

  • from: Fecha mínima de creación de la llamada (marca de tiempo UNIX)

  • to: Fecha máxima de creación de la llamada (marca de tiempo UNIX)

Al consultar intervalos de tiempo más pequeños, como periodos semanales o mensuales, cada solicitud puede mantenerse por debajo del límite de 10.000 registros y aun así permitir la recuperación completa de los datos.

Ejemplo

GET /v1/calls?from=<timestamp>&to=<timestamp>
Consejo: Divide las consultas grandes en intervalos de tiempo más pequeños para garantizar que cada solicitud se mantenga dentro del límite de 10.000 registros.

Notas adicionales

  • El valor máximo de per_page es 50.

  • Los parámetros de paginación no permiten acceder a más de 10.000 registros.

  • Algunos endpoints, como los de llamadas, pueden incluir restricciones adicionales, como una disponibilidad histórica limitada.