Skip to main content

Leave group

Logs the current account out of group chat

Function LeaveGroup(Val AccessParameters, Val GroupID) Export

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValueAccess parameters. See FormAccessParameters
GroupID--groupStringGroup chat identifier

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


tip

Method at API documentation: LeaveGroup


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

GroupID = "120363418084188864@g.us";

AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenAPI.LeaveGroup(AccessParameters, GroupID);
    # JSON data can also be passed as a path to a .json file

oint greenapi LeaveGroup \
--access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
--group "120363416469007868@g.us"
Result
{
"removeAdmin": true
}