Przejdź do głównej treści

​
Etykiety

Etykiety to funkcja WhatsApp Business, ktora pozwala kategoryzowac i organizowac czaty. Za pomoca Wappfy API mozesz tworzyc niestandardowe etykiety, przypisywac je do czatow i pobierac czaty wedlug etykiet.
Etykiety sa dostepne tylko na kontach WhatsApp Business. Osobiste konta WhatsApp nie obsluguja etykiet.
Wszystkie endpointy etykiet sa przypisane do konkretnej instancji: 
/api/instances/{instanceId}/labels/...

​
Tworzenie etykiety

Utworz nowa etykiete z nazwa i kolorem. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/labels \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP Customer",
    "color": 1
  }'
Odpowiedz: 
{
  "data": {
    "id": "1",
    "name": "VIP Customer",
    "color": 1
  }
}

​
Kolory etykiet

WhatsApp Business obsluguje ustalony zestaw kolorow etykiet identyfikowanych numerem:
ID koloruKolor
0Jasnoszary
1Zielony
2Niebieski
3Zolty
4Rozowy/Czerwony

​
Lista etykiet

Pobierz wszystkie etykiety dla instancji. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels \
  -H "X-Api-Key: YOUR_API_KEY"
Odpowiedz: 
{
  "data": [
    { "id": "1", "name": "New Customer", "color": 0 },
    { "id": "2", "name": "VIP Customer", "color": 1 },
    { "id": "3", "name": "Pending Payment", "color": 3 },
    { "id": "4", "name": "Resolved", "color": 2 }
  ]
}

​
Aktualizacja etykiety

Zaktualizuj nazwe lub kolor istniejacej etykiety. 
curl -X PUT https://api.wappfy.io/api/instances/inst_abc123/labels/2 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Customer",
    "color": 2
  }'

​
Usuwanie etykiety

Trwale usun etykiete. Spowoduje to usuniecie etykiety ze wszystkich czatow, do ktorych byla przypisana. 
curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/labels/2 \
  -H "X-Api-Key: YOUR_API_KEY"
Usuniecie etykiety powoduje jej usuniecie ze wszystkich powiazanych czatow. Tej operacji nie mozna cofnac.

​
Etykiety czatow

​
Pobieranie etykiet czatu

Pobierz wszystkie etykiety przypisane do konkretnego czatu. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels/chats/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"
Odpowiedz: 
{
  "data": [
    { "id": "1", "name": "New Customer", "color": 0 },
    { "id": "3", "name": "Pending Payment", "color": 3 }
  ]
}

​
Ustawianie etykiet na czacie

Przypisz jedna lub wiecej etykiet do czatu. Zastepuje to wszystkie istniejace etykiety na czacie. 
curl -X PUT https://api.wappfy.io/api/instances/inst_abc123/labels/chats/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label_ids": ["1", "2"]
  }'
Aby usunac wszystkie etykiety z czatu, przekaz pusta tablice: {"label_ids": []}.

​
Pobieranie czatow wedlug etykiety

Pobierz wszystkie czaty, ktore maja przypisana konkretna etykiete. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels/2/chats \
  -H "X-Api-Key: YOUR_API_KEY"
Odpowiedz: 
{
  "data": [
    {
      "chat_id": "[email protected]",
      "name": "Maria Silva"
    },
    {
      "chat_id": "[email protected]",
      "name": "Carlos Oliveira"
    }
  ]
}

​
Typowe przypadki uzycia

Uzyj webhooka do nasluchiwania zdarzen message.received. Gdy wiadomosc pochodzi od nieznanego kontaktu, przypisz etykiete “Nowy lead” przez API. Pomaga to Twojemu zespolowi szybko identyfikowac i priorytetyzowac nowe rozmowy.
Utworz etykiety takie jak “Otwarte”, “W trakcie” i “Rozwiazane”. Aktualizuj etykiete w miare pracy zespolu nad zgloszeniami wsparcia. Uzyj endpointu “Pobieranie czatow wedlug etykiety”, aby zbudowac prosta kolejke wsparcia.
Oznacz klientow wedlug kategorii (np. “VIP”, “Hurt”, “Detal”). Przy wysylaniu masowych wiadomosci pobierz wszystkie czaty dla etykiety i wysylaj wiadomosci w petli.

​
Informacje o endpointach

MetodaEndpointOpis
POST/api/instances/{id}/labelsUtworz nowa etykiete
GET/api/instances/{id}/labelsLista wszystkich etykiet
PUT/api/instances/{id}/labels/{labelId}Zaktualizuj etykiete
DELETE/api/instances/{id}/labels/{labelId}Usun etykiete
GET/api/instances/{id}/labels/chats/{chatId}Pobierz etykiety czatu
PUT/api/instances/{id}/labels/chats/{chatId}Ustaw etykiety na czacie
GET/api/instances/{id}/labels/{labelId}/chatsPobierz czaty wedlug etykiety

​
Obsluga bledow

Kod statusuOpis
400Nieprawidlowy kolor etykiety lub brak wymaganych pol.
404Etykieta lub czat nie znaleziony.
409Etykieta o tej samej nazwie juz istnieje.
422Nieprawidlowy format identyfikatora czatu.