UpdateGroupSettings#

Метод предназначен для изменения настроек группы.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

Для изменения настроек группы требуется выполнить запрос по адресу:

POST

{{apiUrl}}/v3/waInstance{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор чата
`allowParticipantsEditGroupSettings`	boolean	Нет	Разрешить участникам изменять настройки группы. Сюда входят: название, картинка и описание группы, таймер исчезающих сообщений, а также настройки сохранения и закрепления сообщений. Возможные значения - `true` , `false`
`allowParticipantsPinMessages`	boolean	Нет	Разрешить участникам закреплять сообщения в группе Возможные значения - `true` , `false`
`allowParticipantsAddMembers`	boolean	Нет	Разрешить участникам добавлять участников в группу Возможные значения - `true` , `false`

Примечание

Если настройки группового чата уже установлены в нужное значение, то изменения настроек не произойдет.
Узнать об изменении настроек группового чата можно методом GetGroupData

Пример тела запроса#

Изменение настроек группы:

{
   "chatId": -10000000000000,
   "allowParticipantsEditGroupSettings": true,
   "allowParticipantsAddMembers": true,
   "allowParticipantsPinMessages": true
}

Ответ#

Поля ответа#

Параметр	Тип	Описание
`updateGroupSettings`	boolean	Флаг изменения настроек группы
`reason`	string	Причина ошибки запроса (появляется только при `updateGroupSettings == false`)

Пример тела ответа#

Успешное выполнение метода#

{
    "updateGroupSettings": true
}

Выполнение метода с ошибкой#

status code 200

{
    "updateGroupSettings": false,
    "reason": "FORBIDDEN"
}

Ошибки UpdateGroupSettings#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP	Идентификатор ошибки	Описание
200	`"updateGroupSettings" false`, `"reason": "NOT_ENOUGH_RIGHTS"`	Неправильное значение `chatId`
200	`"updateGroupSettings" false`, `"reason": "FORBIDDEN"`	Номер был исключен из группы
200	`"updateGroupSettings" false`, `"reason": "NOT_FOUND"`	Указанной группы нет в списке групп номера
200	`"updateGroupSettings" false`, `"reason": "NO_SETTINGS_TO_UPDATE"`	Не указаны поля `allowParticipantsEditGroupSettings`, `allowParticipantsPinMessages`, `allowParticipantsAddMembers`
400	Bad Request Validation failed	Неправильное значение `chatId`

Примеры кода#

PythoncURLJava - Unirest

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}"

payload = {
    "chatId": -10000000000000,
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsAddMembers": true,
    "allowParticipantsPinMessages": false,
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text.encode('utf8'))

curl --location -g --request POST '{{apiUrl}}/v3/waInstance{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": -10000000000000,
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsAddMembers": true,
    "allowParticipantsPinMessages": true
}'

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("{{apiUrl}}/v3/waInstance/{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}")
.header("Content-Type", "application/json")
.body("{\r\n    \"chatId\": \"-10000000000000\",\r\n    \"allowParticipantsEditGroupSettings\": true,\r\n}")
.asString();