Pegar contatos

Método#

/contacts#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts

Header#

Key	Value
Client-Token	TOKEN DE SEGURANÇA DA CONTA

Conceituação#

Este método é responsável por retornar todos os contatos do WhatsApp. Lembre-se do que foi dito na introdução sobre número de contatos, caso tenho pulado esta parte, sugiro que você volte um passo e leia a nossa introdução sobre contatos.

Atributos#

Obrigatórios#

Atributos	Tipo	Descrição
page	integer	Utilizado para paginação você de informar aqui a pagina de contatos que quer buscar
pageSize	integer	Especifica o tamanho do retorno de contatos por pagina

Opcionais#

Atributos	Tipo	Descrição

Request Params#

URL exemplo#

Método

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts?page=1&pageSize=20

Response#

200#

Atributos	Tipo	Descrição
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

Exemplo

[
  {
    "name": "Nome e sobrenome do contato 1",
    "short": "Nome do contato 1",
    "notify": "Nome no WhatsApp 1",
    "vname": "Nome no vcard",
    "phone": "559999999999"
  }
]

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"