Contatos

Pegar contatos

Lista a agenda sincronizada do WhatsApp com paginação por página.

GET

/instances/{INSTANCE_TOKEN}/contacts

Atributos

Cabeçalho

Client-Tokenstringobrigatório

Token da conta. Envie o valor puro, sem o prefixo Bearer.

Query

pageintegerobrigatório

Número da página, começando em 1.

pageSizeintegerobrigatório

Contatos por página, de 1 a 100.

Resposta

200Veja o corpo de exemplo na referência.

Pegar contatos

curl --request GET \
  --url https://api.hypeconversa.com/instances/{INSTANCE_TOKEN}/contacts \
  --header 'Client-Token: SEU_TOKEN_DE_CONTA'

200

json

[
  {
    "phone": "5511999999999",
    "name": "Nome completo",
    "short": "Nome",
    "vname": "Nome verificado",
    "notify": "Nome no WhatsApp"
  }
]