NODAPI

Contatos

Listar todos os contatos com paginacao

POST/contacts/list

Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.

Retorna uma lista paginada de contatos da conta do WhatsApp atualmente conectada. Use este endpoint (POST) para controlar limit e offset via corpo da requisicao. O campo contactScope permite escolher entre contatos da agenda, fora da agenda ou todos os contatos conhecidos. A rota GET /contacts continua disponivel para quem prefere a lista completa sem paginacao.

Corpo da requisição (JSON)

CampoTipoDescrição
limitinteger

Quantidade maxima de resultados por pagina (padrao 100, maximo 1000)

Exemplo: 100

offsetinteger

Deslocamento base zero para paginacao

Exemplo: 0

contactScopestring

Define se a busca retorna apenas contatos da agenda, apenas fora da agenda ou todos os contatos conhecidos.

Exemplo: address_book

* obrigatório

Respostas

  • 200Lista de contatos recuperada com sucesso
  • 401Token nao fornecido ou invalido
  • 500Erro interno do servidor ao recuperar contatos

Experimente

Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.

Cole a chave gerada no painel.