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

​
Conceituação

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

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

​
Query Parameters

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

​
Response

​
200

​
archived
boolean
Indica se o chat está arquivado
​
pinned
boolean
Indica se o chat está fixado
​
phone
string
Número de telefone do contato
​
unread
string
Número de mensagens não lidas
​
name
string
Nome atribuído ao chat (retorna IDs para grupos/listas de transmissão)
​
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
​
isGroup
boolean
Indica se é um grupo
​
notes
object
Anotações do chat (disponível apenas para WhatsApp Business)
[
  {
    "archived": "false",
    "pinned": "true",
    "messagesUnread": 0,
    "phone": "5511999999999",
    "unread": "0",
    "name": "Z-API SUPORTE",
    "lastMessageTime": "1622991687",
    "isMuted": "0",
    "isMarkedSpam": "false",
    "isGroupAnnouncement": false,
    "isGroup": false
  },
  {
    "archived": "false",
    "pinned": "true",
    "messagesUnread": 0,
    "phone": "5511999999999",
    "unread": "0",
    "name": "Z-api - Team",
    "lastMessageTime": "1622990503",
    "muteEndTime": 1655953774000,
    "isMuted": "0",
    "isMarkedSpam": "false",
    "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”.