Get Group Information
Endpoint ini memungkinkan Anda untuk mengambil daftar semua grup WhatsApp yang terkait dengan Device tertentu.
Endpoint
POST /agent/groups
Request Headers
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | string | Ya | Bearer token perusahaan Anda |
| Content-Type | string | Ya | Harus diisi application/json |
Request Body
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| deviceID | string | Ya | ID Device yang ingin Anda ambil informasi grupnya |
Contoh Request
curl -X POST "http://localhost:8080/agent/groups" \
-H "Authorization: Bearer YOUR_COMPANY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"deviceID": "YOUR_DEVICE_ID"}'
Response
Success Response (200 OK)
{
"success": true,
"message": "Successfully retrieved 3 groups",
"deviceID": "device-123",
"groups": [
{
"jid": "120363123456789012@g.us",
"name": "Family Group",
"topic": "Family chat"
},
{
"jid": "120363987654321098@g.us",
"name": "Work Team",
"topic": "Work discussions"
},
{
"jid": "120363555666777888@g.us",
"name": "Friends",
"topic": "Hangout plans"
}
]
}
Response Fields
| Field | Tipe | Deskripsi |
|---|---|---|
| success | boolean | Status keberhasilan request |
| message | string | Pesan deskriptif tentang hasil operasi |
| deviceID | string | ID Device yang diminta |
| groups | array | Array objek grup yang ditemukan |
| groups[].jid | string | ID unik grup WhatsApp (JID) |
| groups[].name | string | Nama grup |
| groups[].topic | string | Topik/deskripsi grup |
Error Response (400 Bad Request)
{
"success": false,
"message": "deviceID is required"
}
Error Response (401 Unauthorized)
{
"success": false,
"message": "Invalid or missing authorization token"
}
Error Response (404 Not Found)
{
"success": false,
"message": "Device not found"
}
Catatan Penting
- Device harus dalam status Connected untuk dapat mengambil informasi grup
- Response hanya menampilkan grup yang Device Anda ikuti
- Field
topicmungkin kosong jika grup tidak memiliki deskripsi - JID (Jabber ID) grup selalu diakhiri dengan
@g.us - Jumlah grup yang dikembalikan tergantung pada berapa banyak grup yang diikuti Device
Use Case
API ini berguna untuk:
- Mengambil daftar grup untuk keperluan broadcast message
- Monitoring grup yang diikuti oleh Device
- Integrasi dengan sistem manajemen grup
- Analisis aktivitas grup
- Validasi grup sebelum mengirim pesan
Rate Limiting
- Endpoint ini dibatasi hingga 60 request per menit per Device
- Jika melebihi batas, Anda akan menerima response
429 Too Many Requests
Troubleshooting
| Masalah | Solusi |
|---|---|
| Device tidak ditemukan | Pastikan deviceID valid dan Device sudah dibuat |
| Array groups kosong | Device mungkin belum bergabung dengan grup manapun |
| Unauthorized error | Periksa kembali company token Anda |
| Device offline | Pastikan Device dalam status Connected |
Untuk bantuan lebih lanjut, hubungi support@satuconnect.my.id