CreateGroup#
Метод предназначен для создания группового чата.
Cоздавать группу рекомендуется не чаще чем 1 группу каждые 5 минут во избежание блокировки аккаунта.
Для метода используются ограничения на частоту запросов в секунду.
Запрос#
Для создания группового чата требуется выполнить запрос по адресу:
POST
{{apiUrl}}/v3/waInstance{{idInstance}}/createGroup/{{apiTokenInstance}} Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
groupName | string | Да | Наименование нового группового чата. Максимальная длина поля 100 символов |
chatIds | array | Да | Коллекция идентификаторов участников группы |
Пример тела запроса#
{ "groupName": "Group created by Green API", "chatIds": ["10000000", "10000001"] } Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
created | boolean | Флаг создания группы |
chatId | string | Идентификатор группового чата |
groupInviteLink | string | Ссылка приглашения в группу Если настройка "Приглашать по ссылке" в группе выключена, то поле будет пустым |
Пример тела ответа#
Успешное выполнение метода#
{ "created": true, "chatId": "-10000000000000", "groupInviteLink": "https://max.ru/join/oA25vH5ZOk3z-eaJfVFAZKZFArnTfNw2uigrUW2PPmk" } Выполнение метода с ошибкой#
status code 200
{ "created": false, "chatId": "", "groupInviteLink": "" } Ошибки CreateGroup#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
| Код HTTP | Идентификатор ошибки | Описание |
|---|---|---|
| 400 | Bad Request Validation failed | Ошибка валидации |
| 500 | Internal Server Error Timed Out | В качестве одного или нескольких элементов chatIds указана группа |
| 500 | Internal Server Error bad-request | В качестве одного или нескольких элементов chatIds указан номер, на котором нет аккаунта MAX |
Примеры кода#
import requests url = "{{apiUrl}}/v3/waInstance{{idInstance}}/createGroup/{{apiTokenInstance}}" payload = {( "groupName": "Group created by GREEN-API", "chatIds": ["10000000", "10000001"]) } headers = { 'Content-Type': 'application/json' } response = requests.post(url, json=payload) print(response.text.encode('utf8')) curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/createGroup/{{apiTokenInstance}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "groupName": "Group created by GREEN-API TEST", "chatIds": ["10000000", "10000001"] }' var restTemplate = new RestTemplate(); var requestUrl = new StringBuilder(); requestUrl .append({{apiUrl}}) .append("/waInstance").append({{idInstance}}) .append("/createGroup/") .append({{apiTokenInstance}}); var headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); var jsonBody = "{\"groupName\":\"Group created by GREEN-API TEST\",\"chatIds\":[\"10000000\",\"10000001\"]}"; var requestEntity = new HttpEntity<>(jsonBody, headers); var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class); System.out.println(response); var requestUrl = new StringBuilder(); requestUrl .append({{apiUrl}}) .append("/v3/waInstance").append({{idInstance}}) .append("/createGroup/") .append({{apiTokenInstance}}); var response = Unirest.post(requestUrl.toString()) .header("Content-Type", "application/json") .body("{\"groupName\":\"Group created by GREEN-API TEST\",\"chatIds\":[\"10000000\",\"10000001\"]}") .asString(); System.out.println(response); Sub CreateGroup() Dim url As String Dim RequestBody As String Dim http As Object Dim response As String ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed url = "{{apiUrl}}/v3/waInstance{{idInstance}}/createGroup/{{apiTokenInstance}}" ' groupName is the name of the new group chat, chatIds is a collection of group member IDs RequestBody = "{""groupName"":""Group created by GREEN-API"",""chatIds"":[""10000000"",""10000001""]}" Set http = CreateObject("MSXML2.XMLHTTP") With http .Open "POST", url, False .setRequestHeader "Content-Type", "application/json" .Send RequestBody End With response = http.responseText Debug.Print response ' Outputting the answer to the desired cell ' Range("A1").Value = response Set http = Nothing End Sub