Pular para o conteúdo principal
GET
/
api
/
instances
/
{instanceId}
/
chats
Listar conversas
curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/chats \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "[email protected]",
    "timestamp": 1707350400,
    "unreadCount": 3,
    "name": "John Doe"
  }
]

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
instanceId
string<uuid>
obrigatório

UUID da instância WhatsApp

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Parâmetros de consulta

​
limit
number

Máximo de resultados (padrão 50)

​
offset
number

Deslocamento para paginação

Resposta

List of chats

​
id
string
obrigatório

ID da conversa ([email protected] para DMs, [email protected] para grupos)

Exemplo:

"[email protected]"

​
timestamp
number
obrigatório

Timestamp da última atividade (segundos epoch)

Exemplo:

1707350400

​
unreadCount
number
obrigatório

Número de mensagens não lidas

Exemplo:

3

​
name
string

Nome do contato ou grupo

Exemplo:

"John Doe"