Skip to main content

Groups

Create a new group​

Commandgroup_create.aspx
MethodPOST
Body
{ 
    "name": "My Group",
    "participants": "551199887766@s.whatsapp.net,551144332211@s.whatsapp.net" // list of participants separated by comma
}
Response

Group information:

{
    "success": true,
    "message": {
        "jid": "120362047289509991@g.us",
        "notify": "My Group",
        "short": "My Group",
        "name": "My Group",
        "OriginalPicture": "error",
        "Lastupdate": "2022-12-14T16:49:19.3388662-03:00",
        "LastMessageTime": 0,
        "LastPresenceTime": 0,
        "biz": false,
        "status": 200,
        "tag": null,
        "Count": 0,
        "Mute": false,
        "Spam": false,
        "Archive": false,
        "isGroup": true,
        "GroupInformation": "{\"participants\":[{\"isSuperAdmin\":false,\"isAdmin\":false},{\"isSuperAdmin\":false,\"isAdmin\":false},{\"isSuperAdmin\":false,\"isAdmin\":false}],\"subjectTime\":1671047358,\"subjectOwner\":\"555484339546@s.whatsapp.net\",\"creation\":1671047358,\"owner\":\"555484339546@s.whatsapp.net\",\"id\":\"120363047289502617@g.us\",\"subject\":\"Group AP\"}"
    }
}

Add contact to a Group​

Commandgroup_add.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us",
    "participants": "5511987654321@s.whatsapp.net"
}
Response
{
    "success": true,
    "message": {
        "jid": "120362047289509991@g.us",
        "notify": "My Group",
        "short": "My Group",
        "name": "My Group",
        "OriginalPicture": "error",
        "Lastupdate": "2022-12-14T16:49:19.3388662-03:00",
        "LastMessageTime": 0,
        "LastPresenceTime": 0,
        "biz": false,
        "status": 200,
        "tag": null,
        "Count": 0,
        "Mute": false,
        "Spam": false,
        "Archive": false,
        "isGroup": true,
        "GroupInformation": "{\"participants\":[{\"isSuperAdmin\":false,\"isAdmin\":false},{\"isSuperAdmin\":false,\"isAdmin\":false},{\"isSuperAdmin\":false,\"isAdmin\":false}],\"subjectTime\":1671047358,\"subjectOwner\":\"555484339546@s.whatsapp.net\",\"creation\":1671047358,\"owner\":\"555484339546@s.whatsapp.net\",\"id\":\"120363047289502617@g.us\",\"subject\":\"Group AP\"}"
    }
}

Remove contact from a Group​

Commandgroup_remove.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us",
    "participants": "5511987654321@s.whatsapp.net"
}
Response
{
    "success": true,
    "message": {
        // ... group information
    }
}

Get Group Information​

Commandgroup_info.aspx
MethodPOST
Body
{ 
    "jid": "120362047289509991@g.us",
    // or
    "code" : "F9yQ86a8ue803OZUwcHIm8" // group invite code
}
Response

Group information:

{
    "success": true,
    "message": {
        // ... group information
    }
}

Promote a contact to Admin​

Commandgroup_promote.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us",
    "participants": "5511987654321@s.whatsapp.net"
}
Response
{
    "success": true,
    "message": {
        // ... group information
    }
}

Remove Admin privilege from group​

Commandgroup_demote.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us",
    "participants": "5511987654321@s.whatsapp.net"
}
Response
{
    "success": true,
    "message": {
        // ... group information
    }
}

Join group by invite​

Commandgroup_join.aspx
MethodPOST
Body
{
    "code": "F9yQ86a8ue803OZUwcHIm8"
}
Response
{
    "success": true,
    "message": {
        "jid": "120362047289509991@g.us",
        // ... group information
    }
}

Leave a group​

Commandgroup_leave.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us"
}
Response
{
    "success": true,
    "message": "group 120362047289509991@g.us removed, 120362047289509991@g.us"
}

Group Settings​

Only admins can post​

Commandgroup_close.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us"
}
Response
{
    "success": true,
    "message": "announcement"
}

Everyone can post​

Commandgroup_open.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us"
}
Response
{
    "success": true,
    "message": "not_announcement"
}

Only Admins can edit group data​

Commandgroup_lock.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us"
}
Response
{
    "success": true,
    "message": "locked"
}

All participants can edit group data​

Commandgroup_unlock.aspx
MethodPOST
Body
{
    "jid": "120362047289509991@g.us"
}
Response
{
    "success": true,
    "message": "unlocked"
}