Skip to main content
GET
Retorna lista de contatos do WhatsApp

Autorizações

token
string
header
obrigatório

Parâmetros de consulta

contactScope
enum<string>
padrão:address_book

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

Opções disponíveis:
address_book,
outside_address_book,
all

Resposta

Lista de contatos retornada com sucesso

jid
string

ID único do contato no WhatsApp (formato: número@s.whatsapp.net)

Exemplo:

"5511999999999@s.whatsapp.net"

contact_name
string

Nome completo do contato

Exemplo:

"Contato Exemplo"

contact_FirstName
string

Primeiro nome do contato

Exemplo:

"Contato"