Skip to main content

Get Group Information

Endpoint ini memungkinkan Anda untuk mengambil daftar semua grup WhatsApp yang terkait dengan Device tertentu.

Endpoint

POST /agent/groups

Request Headers

HeaderTipeWajibDeskripsi
AuthorizationstringYaBearer token perusahaan Anda
Content-TypestringYaHarus diisi application/json

Request Body

ParameterTipeWajibDeskripsi
deviceIDstringYaID 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

FieldTipeDeskripsi
successbooleanStatus keberhasilan request
messagestringPesan deskriptif tentang hasil operasi
deviceIDstringID Device yang diminta
groupsarrayArray objek grup yang ditemukan
groups[].jidstringID unik grup WhatsApp (JID)
groups[].namestringNama grup
groups[].topicstringTopik/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 topic mungkin 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

MasalahSolusi
Device tidak ditemukanPastikan deviceID valid dan Device sudah dibuat
Array groups kosongDevice mungkin belum bergabung dengan grup manapun
Unauthorized errorPeriksa kembali company token Anda
Device offlinePastikan Device dalam status Connected

Untuk bantuan lebih lanjut, hubungi support@satuconnect.my.id