Skip to main content
GET
/
api
/
{session}
/
labels
/
{labelId}
/
chats
Obter conversas por etiqueta
curl --request GET \
  --url https://{host}/api/{session}/labels/{labelId}/chats \
  --header 'apikey: <api-key>'
{
  "labelId": "label123",
  "labelName": "Clientes VIP",
  "chats": [
    {
      "id": "[email protected]",
      "name": "João Silva",
      "lastMessage": "Olá!",
      "timestamp": 1699999999
    },
    {
      "id": "[email protected]",
      "name": "Maria Santos",
      "lastMessage": "Obrigada!",
      "timestamp": 1699999998
    }
  ]
}

​
Descrição

Este endpoint retorna todos os chats que possuem um rótulo específico aplicado, permitindo filtrar conversas por categoria.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp
​
labelId
string
required
ID do rótulo para filtrar os chats

​
Resposta

​
chats
array
Lista de chats que possuem o rótulo especificado
{
  "labelId": "label123",
  "labelName": "Clientes VIP",
  "chats": [
    {
      "id": "[email protected]",
      "name": "João Silva",
      "lastMessage": "Olá!",
      "timestamp": 1699999999
    },
    {
      "id": "[email protected]",
      "name": "Maria Santos",
      "lastMessage": "Obrigada!",
      "timestamp": 1699999998
    }
  ]
}

​
Códigos de Status

  • 200 - Chats retornados com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado
  • 404 - Rótulo não encontrado

​
Exemplo de Uso

curl -X GET https://api.wappfy.com.br/api/my-session/labels/label123/chats

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
labelId
string
required

Response

200 - undefined