Skip to main content

Groups

Manage and interact with WhatsApp groups.

List Groups​

Get all groups the session is part of.

GET /api/v1/sessions/{session_id}/groups

Response​

{
  "groups": [
    {
      "jid": "123456789-1234567890@g.us",
      "name": "My Group",
      "participant_count": 25
    }
  ],
  "total": 1
}

Get Group​

Get basic group information.

GET /api/v1/sessions/{session_id}/groups/{group_jid}

Response​

{
  "jid": "123456789-1234567890@g.us",
  "name": "My Group",
  "topic": "Group description",
  "participant_count": 25,
  "created_at": 1640000000
}

Get Group Info​

Get detailed group information including participants.

GET /api/v1/sessions/{session_id}/groups/{group_jid}/info

Response​

{
  "jid": "123456789-1234567890@g.us",
  "name": "My Group",
  "topic": "Group description",
  "owner": "628123456789@s.whatsapp.net",
  "created_at": 1640000000,
  "participants": [
    {
      "jid": "628123456789@s.whatsapp.net",
      "role": "admin"
    },
    {
      "jid": "628987654321@s.whatsapp.net",
      "role": "member"
    }
  ]
}

Participant Roles​

RoleDescription
superadminGroup creator
adminGroup admin
memberRegular member

Sending Messages to Groups​

Use the same message endpoints with group JID:

curl -X POST http://localhost:3000/api/v1/sessions/my-session/messages/text \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "123456789-1234567890@g.us",
    "text": "Hello group!"
  }'