Langsung ke konten utama

​
Grup

Kelola grup WhatsApp melalui Wappfy API. Anda dapat membuat grup, mengelola peserta, menangani link undangan, dan lainnya. Semua endpoint grup terikat pada instance tertentu: 
/api/instances/{instanceId}/groups/...

​
Membuat Grup

Buat grup WhatsApp baru dengan peserta awal. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Project Alpha",
    "participants": [
      "[email protected]",
      "[email protected]"
    ]
  }'
Respons: 
{
  "data": {
    "group_id": "[email protected]",
    "name": "Project Alpha",
    "participants": [
      {
        "id": "[email protected]",
        "is_admin": false
      },
      {
        "id": "[email protected]",
        "is_admin": false
      }
    ]
  }
}

​
Melihat Daftar Grup

Ambil semua grup yang diikuti instance. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "data": [
    {
      "group_id": "[email protected]",
      "name": "Project Alpha",
      "participant_count": 5
    },
    {
      "group_id": "[email protected]",
      "name": "Support Team",
      "participant_count": 12
    }
  ]
}

​
Mendapatkan Info Grup

Ambil informasi detail tentang grup tertentu. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "data": {
    "group_id": "[email protected]",
    "name": "Project Alpha",
    "description": "Team workspace for Project Alpha",
    "owner": "[email protected]",
    "created_at": "2026-01-15T10:00:00Z",
    "participants": [
      {
        "id": "[email protected]",
        "is_admin": true,
        "is_super_admin": true
      },
      {
        "id": "[email protected]",
        "is_admin": false,
        "is_super_admin": false
      }
    ]
  }
}

​
Memperbarui Grup

Perbarui nama atau deskripsi grup. Anda harus menjadi admin grup untuk melakukan tindakan ini. 
curl -X PATCH https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected] \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Project Alpha v2",
    "description": "Updated workspace for Project Alpha"
  }'
Hanya admin grup yang dapat memperbarui nama dan deskripsi grup. Jika instance bukan admin, ini akan mengembalikan error 403.

​
Keluar dari Grup

Keluarkan instance dari grup. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/leave \
  -H "X-Api-Key: YOUR_API_KEY"
Setelah keluar dari grup, Anda memerlukan link undangan atau admin lain untuk menambahkan Anda kembali.

​
Peserta

​
Melihat Daftar Peserta

Dapatkan semua peserta dari sebuah grup. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "data": [
    {
      "id": "[email protected]",
      "is_admin": true,
      "is_super_admin": true
    },
    {
      "id": "[email protected]",
      "is_admin": false,
      "is_super_admin": false
    },
    {
      "id": "[email protected]",
      "is_admin": true,
      "is_super_admin": false
    }
  ]
}

​
Menambahkan Peserta

Tambahkan satu atau beberapa peserta ke grup. Anda harus menjadi admin grup. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "[email protected]",
      "[email protected]"
    ]
  }'

​
Menghapus Peserta

Hapus satu atau beberapa peserta dari grup. Anda harus menjadi admin grup. 
curl -X DELETE https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/participants \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": [
      "[email protected]"
    ]
  }'

​
Kode Undangan

​
Mendapatkan Kode Undangan

Hasilkan atau ambil link undangan grup. Anda harus menjadi admin grup. 
curl https://api.wappfy.io/api/instances/inst_abc123/groups/[email protected]/invite-code \
  -H "X-Api-Key: YOUR_API_KEY"
Respons: 
{
  "data": {
    "invite_code": "https://chat.whatsapp.com/AbCdEfGhIjKlMn"
  }
}

​
Bergabung melalui Kode Undangan

Bergabung ke grup menggunakan kode undangan. 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/groups/join \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invite_code": "AbCdEfGhIjKlMn"
  }'
Kirimkan hanya bagian kode, bukan URL lengkap. Untuk https://chat.whatsapp.com/AbCdEfGhIjKlMn, kirimkan AbCdEfGhIjKlMn.

​
Mengirim Pesan ke Grup

Untuk mengirim pesan ke grup, gunakan endpoint standar kirim pesan dengan chat ID grup: 
curl -X POST https://api.wappfy.io/api/instances/inst_abc123/messages/send \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chat_id": "[email protected]",
    "type": "text",
    "text": "Hello team!"
  }'
Chat ID grup selalu diakhiri dengan @g.us.

​
Referensi Endpoint

MethodEndpointDeskripsi
POST/api/instances/{id}/groupsMembuat grup baru
GET/api/instances/{id}/groupsMelihat daftar semua grup
GET/api/instances/{id}/groups/{groupId}Mendapatkan info grup
PATCH/api/instances/{id}/groups/{groupId}Memperbarui nama/deskripsi grup
POST/api/instances/{id}/groups/{groupId}/leaveKeluar dari grup
GET/api/instances/{id}/groups/{groupId}/participantsMelihat daftar peserta
POST/api/instances/{id}/groups/{groupId}/participantsMenambahkan peserta
DELETE/api/instances/{id}/groups/{groupId}/participantsMenghapus peserta
GET/api/instances/{id}/groups/{groupId}/invite-codeMendapatkan kode undangan
POST/api/instances/{id}/groups/joinBergabung melalui kode undangan

​
Penanganan Error

Kode StatusDeskripsi
403Anda bukan admin grup ini.
404Grup tidak ditemukan atau instance bukan anggota.
409Peserta sudah ada dalam grup (saat menambahkan) atau tidak ada dalam grup (saat menghapus).
422Format peserta tidak valid. Gunakan {phone}@s.whatsapp.net.