Paginação

A API de voz da Api4Com usa a paginação para retornar grandes conjuntos de dados em partes menores. Isso é útil quando você precisa lidar com grandes quantidades de dados e não quer sobrecarregar o servidor com uma única solicitação.

Como funciona a paginação

A paginação funciona dividindo os dados em páginas, onde cada página contém um número fixo de itens. Quando você faz uma solicitação à API de voz da Api4Com, a API retorna a primeira página de dados e as referências para a próxima página. Você pode usar esses dados para recuperar a próxima página de dados e assim por diante até que todos os dados tenham sido recuperados.

Parâmetros de paginação

A API de voz da Api4Com usa os seguintes parâmetros de paginação:

Parâmetros de solicitação

• page: O número da página que você deseja recuperar. O padrão é 1.
• limit: O número máximo de itens por página. O padrão é 100. O valor máximo é 1000.

Parâmetros de resposta

• totalItemCount: O número total de itens disponíveis.
• totalPageCount: O número total de páginas disponíveis.
• itemsPerPage: O número de itens por página.
• currentPage: O número da página atual.
• nextPage: O número da próxima página.
• previousPage: O número da página anterior.

Quando o parametro nextPage não é retornado na resposta, significa que você está na última página.

Exemplo de solicitação com paginação

Você pode especificar os parâmetros de paginação na URL da solicitação, da seguinte maneira:

const axios = require('axios');
const token = '<token>';
const url = 'https://api.api4com.com/api/v1/calls';
const config = {
  headers: {
    Authorization: token
  },
  params: {
    page: 1,
    filter: {
      limit: 100
    }
  }
};
axios.get(url, config).then(response => {
  console.log(response.data);
}).catch(error => {
  console.error(error);
});

Substitua <token> pelo token de API que você obteve ao realizar o Login.

Resposta de sucesso:

{
  "data": [
    {
      "id": "3b46c0c6-5acc-4dfb-9ceb-14e37f1d3040",
      "domain": "user.api4com.com",
      "call_type": "outbound",
      "started_at": "2025-01-01T00:00:00.000Z",
      "ended_at": "2025-01-01T00:01:00.000Z",
      "from": "1000",
      "to": "4833328530",
      "duration": 60,
      "hangup_cause": "NORMAL_CLEARING",
      "record_url": "https://listener.api4com.com/files/listen/2cde1761-93c3-45da-94b4-910177dc7dc0.mp3",
      "email": "user@domain.com",
      "first_name": "User",
      "last_name": "Name",
      "BINA": "4833328530",
      "minute_price": 0.08,
      "call_price": 0.08,
      "metadata": {}
    },
    ...
  ],
  "meta": {
    "totalItemCount": 300,
    "totalPageCount": 3,
    "itemsPerPage": 100,
    "currentPage": 2,
    "nextPage": 3,
    "previousPage": 1
  }
}

Considerações finais

A paginação é uma técnica eficaz para lidar com grandes conjuntos de dados. Ao usar a paginação, você pode recuperar grandes quantidades de dados de forma eficiente e sem sobrecarregar o servidor. A API de voz da Api4Com suporta a paginação para facilitar o acesso aos dados e melhorar o desempenho das solicitações.