Exclude group member

Excludes a member from the group

Function ExcludeGroupMember(Val AccessParameters, Val GroupID, Val UserID) Export

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

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

tip

Method at API documentation: RemoveGroupParticipant

1C:Enterprise/OneScript code example

    ApiUrl           = "https://7105.api.greenapi.com";
    MediaUrl         = "https://7105.media.greenapi.com";
    IdInstance       = "71051...";
    ApiTokenInstance = "425010d90e114aa6b78f0969e...";

    GroupID = "120363421465100578@g.us";
    UserID  = "123123123@c.us";

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

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenapi ExcludeGroupMember \
     --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
     --group "120363423945947675@g.us" \
     --user "123123123@c.us"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenapi ExcludeGroupMember ^
     --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^
     --group "120363423945947675@g.us" ^
     --user "123123123@c.us"

Result

{
 "removeParticipant": true
}