Skip to main content
GET
Pegar chats

Conceituação

Este método é responsável por retornar todos os chats.

Atributos

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

Query Parameters

integer
obrigatório
Utilizado para paginação, informe a página de chats que quer buscar
integer
obrigatório
Especifica o tamanho do retorno de chats por página

Response

200

boolean
Indica se o chat está arquivado
boolean
Indica se o chat está fixado
string
Número de telefone do contato
string
Número de mensagens não lidas
string
Nome atribuído ao chat (retorna IDs para grupos/listas de transmissão)
string
Timestamp da última interação
string
0 ou 1 indicando se o chat está silenciado
boolean
Indica se o chat está marcado como spam
boolean
Indica se é um grupo
object
Anotações do chat (disponível apenas para WhatsApp Business)

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”.