Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
chats
/
{phone}
Pegar metadata do chat
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/chats/{phone} \
  --header 'Client-Token: <api-key>'
{
  "phone": "<string>",
  "unread": "<string>",
  "lastMessageTime": "<string>",
  "isMuted": "<string>",
  "isMarkedSpam": true,
  "profileThumbnail": "<string>",
  "isGroupAnnouncement": true,
  "isGroup": true,
  "about": "<string>",
  "notes": {}
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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)
{
  "phone": "5511999999999",
  "unread": "0",
  "lastMessageTime": "1619461666",
  "isMuted": "0",
  "isMarkedSpam": "false",
  "profileThumbnail": "https://pps.whatsapp.net/...",
  "messagesUnread": 0,
  "about": "Recado do perfil",
  "isGroupAnnouncement": false,
  "isGroup": false,
  "notes": {
    "id": "KlesU6f4f/Qd5d6VuAbvOMi31rg/F92owVe/xDYad1C=",
    "content": "texto da anotação",
    "createdAt": 1655953774000,
    "lastUpdateAt": 1655953774000
  }
}

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