Listar Chamadas

O endpoint /api/calls permite listar todas as chamadas criadas em um projeto utilizando seu Token de API.

Requisição

Lista todas as chamadas do projeto com suporte a paginação.

Cabeçalhos:

{
  "Authorization": "Bearer {API_TOKEN}"
}

Parâmetros de consulta

• startDate: (string, obrigatório) Data inicial do período de busca no formato YYYY-MM-DD. Exemplo: 2025-10-01
• endDate: (string, obrigatório) Data final do período de busca no formato YYYY-MM-DD. Exemplo: 2025-10-31
• page: (number, opcional) Página de paginação. Padrão: 1
• limit: (number, opcional) Quantidade de itens a serem retornados por página. Padrão: 10

Exemplos de Implementação

curl -X GET "https://api.videochamada.com.br/api/calls?startDate=2025-10-01&endDate=2025-10-31&page=1&limit=20" \
  -H "Authorization: Bearer {API_TOKEN}"

import requests

response = requests.get(
    "https://api.videochamada.com.br/api/calls",
    headers={"Authorization": "Bearer {API_TOKEN}"},
    params={
        "startDate": "2025-10-01",
        "endDate": "2025-10-31",
        "page": 1,
        "limit": 20
    }
)
print(response.json())

const response = await fetch('https://api.videochamada.com.br/api/calls?startDate=2025-10-01&endDate=2025-10-31&page=1&limit=20', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {API_TOKEN}'
  }
});

const data = await response.json();
console.log(data);

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer {API_TOKEN}");
var response = await client.GetAsync("https://api.videochamada.com.br/api/calls?startDate=2025-10-01&endDate=2025-10-31&page=1&limit=20");
var content = await response.Content.ReadAsStringAsync();

Console.WriteLine(content);

Resposta

Exemplo de Resposta:

{
  "data": [
    {
      "id": "call_123",
      "status": "ended",
      "created": "2025-10-16T10:00:00Z",
      "started": "2025-10-16T10:05:00Z",
      "ended": "2025-10-16T10:35:00Z",
      "expiresAt": "2025-10-16T12:00:00Z",
      "totalBillableMinutes": "60.00",
      "url": "https://videochamada.com.br/calls/call_123"
    },
    {
      "id": "call_124",
      "status": "active",
      "created": "2025-10-16T11:00:00Z",
      "started": "2025-10-16T11:02:00Z",
      "ended": null,
      "expiresAt": "2025-10-16T13:00:00Z",
      "totalBillableMinutes": "15.50",
      "url": "https://videochamada.com.br/calls/call_124"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 156,
    "totalPages": 8
  }
}

Explicação dos Campos:

Objeto de Chamada:

• id: Identificador único da chamada
• status: Status atual da chamada (created, active, ended)
• created: Data e hora de criação da chamada
• started: Data e hora de início da chamada (quando primeiro participante entrou)
• ended: Data e hora de encerramento da chamada
• expiresAt: Data e hora de expiração do link da chamada
• totalBillableMinutes: Total de minutos faturáveis da chamada
• url: URL pública para acessar a chamada

Objeto de Paginação:

• page: Número da página atual
• limit: Quantidade de itens por página
• total: Total de chamadas disponíveis
• totalPages: Total de páginas

Boas Práticas

• Parâmetros Obrigatórios: Os parâmetros startDate e endDate são obrigatórios. Sem eles, a API retornará erro 400.
• Período de Busca: Use intervalos razoáveis para evitar sobrecarga. Recomenda-se buscar no máximo 90 dias por vez.
• Formato de Data: Use sempre o formato YYYY-MM-DD (exemplo: 2025-10-01).
• Paginação: Para grandes volumes de chamadas, sempre utilize paginação para otimizar o desempenho.
• Filtros: Esta listagem retorna todas as chamadas do projeto no período especificado. Para análises específicas, considere implementar filtros no lado do cliente.
• Dashboards: Use este endpoint para construir dashboards e relatórios de uso da plataforma.