Pular para o conteúdo principal
Os endpoints de listagem retornam uma coleção e um cursor opcional. Envie esse cursor sem alterações para ler a próxima página. Continue seguindo os cursores até que o valor seja nulo ou esteja ausente.

Escolha a coleção

Os quatro endpoints abaixo aceitam limit de 1 a 100, com valor padrão 20. Use a consulta de contatos ou a consulta de usuários do Bridge quando precisar encontrar uma pessoa conhecida. Percorrer a lista inteira é uma tarefa diferente.

Exemplo no servidor

Este exemplo lê Contatos. Salve como list-contacts.mjs e defina BRIDGE_API_KEY e BRIDGE_WORKSPACE_ID no servidor. A proteção local maxPages evita uma execução ilimitada por engano; ela não é um limite da API Bridge. A proteção contra cursores repetidos interrompe a execução e informa o problema, em vez de retornar silenciosamente uma lista incompleta.
Use pages("conversations", "conversations", { status: "ACTIVE" }), pages("users", "users") ou pages("agents", "agents") com o contrato correspondente. Mantenha os mesmos filtros durante todo o percurso.

Não pare em uma página com poucos registros

Uma página com menos registros que limit ainda pode ter uma próxima página. O endpoint de Agentes documenta esse comportamento explicitamente. O sinal de continuação é o cursor retornado, não o tamanho da coleção. Trate o cursor como opaco. Não o decodifique, incremente ou crie por conta própria. O URL.searchParams do exemplo preserva seu valor por meio da codificação de URL.

Filtros e limites de requisições

  • Os filtros ownerEmail e search da lista de Contatos estão obsoletos. Para um e-mail ou telefone conhecido, use a consulta de contatos. Para filtrar um conjunto por ownerId, leia esse campo nas linhas retornadas e faça a filtragem no seu código.
  • Os filtros email e status da lista de usuários do Bridge estão obsoletos. Use a consulta para um e-mail conhecido ou examine o status de cada usuário retornado.
  • Cada requisição de página consome a cota compartilhada do workspace. Siga o guia de limites de requisições, incluindo Retry-After em respostas 429. Este exemplo mínimo para em respostas diferentes de 200, sem tentar novamente automaticamente.
Os contratos publicados não garantem uma visão transacionalmente consistente da lista enquanto os registros estão mudando. Não apresente esse percurso como uma exportação necessariamente consistente nem presuma um prazo de validade do cursor que não esteja documentado.

Referências