Skip to main content

Get group information

Gets group chat data

Function GetGroupInformation(Val AccessParameters, Val GroupID) Export

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValue✔Access parameters. See FormAccessParameters
GroupID--groupString✔Group chat identifier

Returns: Map Of KeyAndValue - serialized JSON response from Green API


tip

Method at API documentation: GetGroupData


1C:Enterprise/OneScript code example
    ApiUrl           = "https://7105.api.greenapi.com";
    MediaUrl         = "https://7105.media.greenapi.com";
    IdInstance       = "71051...";
    ApiTokenInstance = "425010d90e114aa6b78f0969e...";

    GroupID = "120363405536804960@g.us";

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenAPI.GetGroupInformation(AccessParameters, GroupID);
    # JSON data can also be passed as a path to a .json file
    
    oint greenapi GetGroupInformation \
     --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
     --group "120363423048654769@g.us"
Result
{
 "groupId": "120363421084000163@g.us",
 "owner": "***",
 "subject": "New group",
 "creation": 1761913279,
 "subjectTime": 1761913279,
 "subjectOwner": "375447830891@c.us",
 "groupInviteLink": "https://chat.whatsapp.com/JPo3obfZ4zDGF7hOTqlVY4",
 "ephemeralExpiration": 0,
 "allowParticipantsEditGroupSettings": true,
 "allowParticipantsSendMessages": true,
 "allowParticipantsAddMembers": false,
 "isCommunity": false,
 "isCommunityAnnounce": false,
 "size": 1,
 "participants": [
  {
   "id": "***",
   "lid": "78714469634134@lid",
   "isAdmin": true,
   "isSuperAdmin": true
  }
 ]
}