Sign in

v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-06-11720209.3 KB
Group Controller

Find Group By Remote JID

Find group by remote JID

get/group/findGroupInfos/{instance}

Path parameters

instancestring required

ID of the instance to connect

Query parameters

groupJidstring required

Group remote JID

Response

Ok

idstring

The ID of the group.

subjectstring

The subject (name) of the group.

subjectOwnerstring

The ID of the user who set the subject.

subjectTimeinteger

The timestamp when the subject was set.

pictureUrlstring

URL of the group's profile picture.

sizeinteger

The number of participants in the group.

creationinteger

The timestamp when the group was created.

ownerstring

The ID of the group owner.

descstring

The description of the group.

descIdstring

The ID of the description message.

restrictboolean

Indicates if the group is restricted (only admins can send messages).

announceboolean

Indicates if the group is an announcement group (only admins can send messages).

Example response

{
  "id": "120363295648424210@g.us",
  "subject": "Example Group",
  "subjectOwner": "553198296801@s.whatsapp.net",
  "subjectTime": 1714769954,
  "pictureUrl": null,
  "size": 1,
  "creation": 1714769954,
  "owner": "553198296801@s.whatsapp.net",
  "desc": "optional",
  "descId": "BAE57E16498982ED",
  "restrict": false,
  "announce": false,
  "participants": [
    {
      "id": "553198296801@s.whatsapp.net",
      "admin": "superadmin"
    }
  ]
}