Create group

Creates a new group chat with the specified name

Parameters

Function CreateGroup(Val AccessParameters, Val Name, Val Members) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
Name	--name	String	✔	Group name
Members	--members	Array Of String, String	✔	Array of group member IDs or a single ID

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: CreateGroup

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...";

    UserID = 87654321;
    Name   = "New group";

    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.CreateGroup(AccessParameters, Name, UserID);

Bash

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

CMD/Bat

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

Result

{
 "created": true,
 "chatId": "***",
 "groupInviteLink": "***"
}