Pular para o conteúdo principal
GET
Pegar contatos

Conceituação

Este método é responsável por retornar todos os contatos do WhatsApp.

Atributos

instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
token
string
obrigatório
Token da sua instância Z-API.

Query Parameters

page
integer
obrigatório
Utilizado para paginação, você deve informar aqui a página de contatos que quer buscar
pageSize
integer
obrigatório
Especifica o tamanho do retorno de contatos por página

Response

200

phone
string
Phone do contato
name
string
Nome e sobrenome do contato, só vai retornar preenchido caso você tenha o número em seus contatos
short
string
Nome do contato, só vai retornar preenchido caso você tenha o número em seus contatos
vname
string
Nome do contato caso você tenha ele como contato
notify
string
Nome informado nas configurações de nome do WhatsApp

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.