Leave group

Logs the current account out of group chat

Parameters

Function LeaveGroup(Val AccessParameters, Val GroupID) Export

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

Returns

Map Of KeyAndValue - serialized JSON response from Green API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

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 = "120363421084000163@g.us";

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenAPI.LeaveGroup(AccessParameters, GroupID);

Bash

    # 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 "120363426993098836@g.us"

CMD/Bat

    :: 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 "120363426993098836@g.us"

Result

{
 "removeAdmin": true
}