Pular para o conteúdo principal
GET
Pegar metadata do chat

Conceituação

Este método é responsável por retornar as informações do metadata de um chat.

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.

Path

phone
string
obrigatório
Telefone do contato no formato DDI DDD NÚMERO. Ex: 551199999999

Response

200

phone
string
Telefone do contato
unread
string
Número de mensagens não lidas
lastMessageTime
string
Timestamp da última interação
isMuted
string
0 ou 1 indicando se o chat está silenciado
isMarkedSpam
boolean
Indica se o chat está marcado como spam
profileThumbnail
string
URL da foto do chat (apagada após 48h pelo WhatsApp)
isGroupAnnouncement
boolean
Indica se é um grupo de avisos
isGroup
boolean
Indica se é um grupo
about
string
Recado do perfil
notes
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”.