Pegar metadata do Chat
Método#
/chat/{phone}#
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats/{phone}
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Este método é reponsavel por retornar as informações do metadata de um chat.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Telefone do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
Request Params#
URL exemplo#
Método
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats/5511999999999
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Phone do contato |
| unread | string | indica o número de mensagens não lidas em um chat |
| lastMessageTime | string | Timestamp com a data e hora da ultima ingeração com o chat |
| isMuted | string | 0 ou 1 indica se você silênciou ou não este chat |
| isMarkedSpam | boolean | true ou false indica se você marcou este chat como spam |
| profileThumbnail | string | URL da foto do chat o Whatsapp apaga após 48h |
| isGroupAnnouncement | boolean | true ou false indica se o chat é um grupo de avisos |
| isGroup | boolean | true ou false indica se o chat é um grupo |
| notes | object (Note) | Anotações atribuidas ao chat (somente whatsapp business) |
| messagesUnread | integer | descontinuado |
| about | string | Recado do perfil |
Object (Note)
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | Id da anotação |
| content | string | Texto da anotação |
| createdAt | number | Timestamp da criação da anotação |
| lastUpdateAt | number | Timestamp da ultima atualização da anotação |
Exemplo
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"