Перейти к содержанию

UpdateGroupSettings#

Бета-версия

Функциональность находится в стадии бета-тестирования. Функции могут быть изменены, а также могут работать нестабильно.

Test Postman Apidog

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

Запрос#

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

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

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

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

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

Примечание

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

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

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

{
    "groupId": "1234567890123@g.us",
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsSendMessages": true 
}

Ответ#

Поля ответа#

Поле Тип Описание
idMessage string Идентификатор отправленного сообщения

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Ошибки UpdateGroupSettings#

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

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

import requests

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

payload = {
    "groupId": "1234567890123@g.us",
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsSendMessages": true
}
headers = {
    'Content-Type': 'application/json'
}

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => '/waInstance%7B%7BidInstance%7D%7D/updateGroupSettings/%7B%7BapiTokenInstance%7D%7D',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
    "groupId": "1234567890123@g.us",
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsSendMessages": true
}',
CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

curl --location -g --request POST '/waInstance{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupId": "1234567890123@g.us",
    "allowParticipantsEditGroupSettings": true,
    "allowParticipantsSendMessages": true
}'

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("/waInstance{{idInstance}}/updateGroupSettings/{{apiTokenInstance}}")
.header("Content-Type", "application/json")
.body("{\r\n    \"groupId\": \"1234567890123@g.us\",\r\n    \"allowParticipantsEditGroupSettings\": true,\r\n  \"allowParticipantsSendMessages\": true\r\n}")
.asString();

package main

import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)

func main() {

url := "/waInstance%7B%7BidInstance%7D%7D/updateGroupSettings/%7B%7BapiTokenInstance%7D%7D"
method := "POST"

payload := strings.NewReader(`{`+"
"+`
    "groupId": "1234567890123@g.us",`+"
"+`
    "allowParticipantsEditGroupSettings": true`+"
"+`
    "allowParticipantsSendMessages": true`+"
"+`
}`)

client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)

if err != nil {
    fmt.Println(err)
    return
}
req.Header.Add("Content-Type", "application/json")

res, err := client.Do(req)
if err != nil {
    fmt.Println(err)
    return
}
defer res.Body.Close()

body, err := ioutil.ReadAll(res.Body)
if err != nil {
    fmt.Println(err)
    return
}
fmt.Println(string(body))
}