UpdateGroupSettings#

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

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

Запрос#

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

POST

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

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

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

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор группового чата
`allowParticipantsSendMessages`	boolean	Нет	Разрешить участникам отправлять текстовые сообщения, `true` / `false`
`allowParticipantsSendMedia`	boolean	Нет	Разрешить участникам отправлять медиафайлы (фото, видео, документы, голосовые и видеосообщения), `true` / `false`
`allowParticipantsSendPolls`	boolean	Нет	Разрешить участникам отправлять опросы, `true` / `false`
`allowParticipantsSendOtherMessages`	boolean	Нет	Разрешить участникам отправлять прочие сообщения (стикеры, GIF-анимации и др.), `true` / `false`
`allowParticipantsAddWebPagePreviews`	boolean	Нет	Разрешить генерацию предпросмотра ссылок в сообщениях (Rich Link Previews), `true` / `false`
`allowParticipantsEditGroupSettings`	boolean	Нет	Разрешить участникам изменять настройки группы (название, фото, описание), `true` / `false`
`allowParticipantsAddMembers`	boolean	Нет	Разрешить участникам добавлять новых пользователей в группу, `true` / `false`
`allowParticipantsPinMessages`	boolean	Нет	Разрешить участникам закреплять сообщения в группе, `true` / `false`

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

{
    "chatId": "-1001234567890",
    "allowParticipantsSendMessages": true,
    "allowParticipantsSendMedia": true,
    "allowParticipantsSendPolls": false,
    "allowParticipantsSendOtherMessages": true,
    "allowParticipantsAddWebPagePreviews": true,
    "allowParticipantsEditGroupSettings": false,
    "allowParticipantsAddMembers": true,
    "allowParticipantsPinMessages": false
}

Ответ#

Поля ответа#

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

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

{
    "updateGroupSettings": true
}

Ошибки#

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

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

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

PythoncURLJava - Unirest

import requests

url = "{{apiUrl}}/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}}/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}}/waInstance/{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}")
.header("Content-Type", "application/json")
.body("{\r\n    \"chatId\": \"-10000000000000\",\r\n    \"allowParticipantsEditGroupSettings\": true,\r\n}")
.asString();