Get group information

Gets information about the group chat

Function GetGroupInformation(Val AccessParameters, Val ChatID) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
ChatID	--chat	String	✔	Group chat ID

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

tip

Method at API documentation: GetGroupData

1C:Enterprise/OneScript code example

    ApiUrl           = "https://3100.api.green-api.com/v3";
    MediaUrl         = "https://3100.api.green-api.com/v3";
    IdInstance       = "31003...";
    ApiTokenInstance = "17915d8e0b4b4975a183478da...";

    ChatID = 12345678;
    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.GetGroupInformation(AccessParameters, ChatID);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenmax GetGroupInformation \
     --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
     --chat "-68929070366805"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenmax GetGroupInformation ^
     --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ^
     --chat "-68929070366805"

Result

{
 "chatId": "***",
 "owner": "39888725",
 "subject": "New group",
 "description": "",
 "creation": 1761913346,
 "groupInviteLink": "https://max.ru/join/5QdgsEYpoZ1mmnYRkFQaYhhrH5BCuuqINhoPJdGeCgA",
 "allowParticipantsAddMembers": true,
 "allowParticipantsEditGroupSettings": true,
 "allowParticipantsPinMessages": true,
 "size": 2,
 "participants": [
  {
   "chatId": "***",
   "isAdmin": true,
   "isSuperAdmin": true
  },
  {
   "chatId": "***",
   "isAdmin": false,
   "isSuperAdmin": false
  }
 ]
}