Langsung ke konten utama

​
Label

Label adalah fitur WhatsApp Business yang memungkinkan Anda mengkategorikan dan mengorganisir chat Anda. Melalui Wappfy API, Anda dapat membuat label kustom, menetapkannya ke chat, dan mengambil chat berdasarkan label.
Label hanya tersedia pada akun WhatsApp Business. Akun WhatsApp personal tidak mendukung label.
Semua endpoint label terikat pada instance tertentu: 
/api/instances/{instanceId}/labels/...

​
Membuat Label

Buat label baru dengan nama dan warna. 
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
  }'
Respons: 
{
  "data": {
    "id": "1",
    "name": "VIP Customer",
    "color": 1
  }
}

​
Warna Label

WhatsApp Business mendukung set warna label tetap yang diidentifikasi dengan nomor:
ID WarnaWarna
0Abu-abu muda
1Hijau
2Biru
3Kuning
4Merah muda/Merah

​
Melihat Daftar Label

Ambil semua label untuk instance tersebut. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "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 }
  ]
}

​
Memperbarui Label

Perbarui nama atau warna label yang sudah ada. 
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
  }'

​
Menghapus Label

Hapus label secara permanen. Ini menghapus label dari semua chat yang ditetapkan. 
curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/labels/2 \
  -H "X-Api-Key: YOUR_API_KEY"
Menghapus label menghapusnya dari semua chat terkait. Tindakan ini tidak dapat dibatalkan.

​
Label Chat

​
Mendapatkan Label untuk Chat

Ambil semua label yang ditetapkan ke chat tertentu. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels/chats/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "data": [
    { "id": "1", "name": "New Customer", "color": 0 },
    { "id": "3", "name": "Pending Payment", "color": 3 }
  ]
}

​
Menetapkan Label pada Chat

Tetapkan satu atau beberapa label ke chat. Ini menggantikan label yang sudah ada pada chat tersebut. 
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"]
  }'
Untuk menghapus semua label dari chat, kirim array kosong: {"label_ids": []}.

​
Mendapatkan Chat berdasarkan Label

Ambil semua chat yang memiliki label tertentu. 
curl https://api.wappfy.io/api/instances/inst_abc123/labels/2/chats \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "data": [
    {
      "chat_id": "[email protected]",
      "name": "Maria Silva"
    },
    {
      "chat_id": "[email protected]",
      "name": "Carlos Oliveira"
    }
  ]
}

​
Kasus Penggunaan Umum

Gunakan webhook untuk mendengarkan event message.received. Saat pesan datang dari kontak yang tidak dikenal, tetapkan label “New Lead” melalui API. Ini membantu tim Anda dengan cepat mengidentifikasi dan memprioritaskan percakapan baru.
Buat label seperti “Open”, “In Progress”, dan “Resolved”. Perbarui label saat tim Anda menyelesaikan permintaan dukungan. Gunakan endpoint “Mendapatkan Chat berdasarkan Label” untuk membangun antrian dukungan sederhana.
Beri label pelanggan berdasarkan kategori (misalnya, “VIP”, “Wholesale”, “Retail”). Saat mengirim pesan broadcast, ambil semua chat untuk sebuah label dan kirim pesan secara berulang.

​
Referensi Endpoint

MethodEndpointDeskripsi
POST/api/instances/{id}/labelsMembuat label baru
GET/api/instances/{id}/labelsMelihat daftar semua label
PUT/api/instances/{id}/labels/{labelId}Memperbarui label
DELETE/api/instances/{id}/labels/{labelId}Menghapus label
GET/api/instances/{id}/labels/chats/{chatId}Mendapatkan label untuk chat
PUT/api/instances/{id}/labels/chats/{chatId}Menetapkan label pada chat
GET/api/instances/{id}/labels/{labelId}/chatsMendapatkan chat berdasarkan label

​
Penanganan Error

Kode StatusDeskripsi
400Warna label tidak valid atau field wajib tidak ada.
404Label atau chat tidak ditemukan.
409Label dengan nama yang sama sudah ada.
422Format chat ID tidak valid.