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

SetGroupAdmin#

Test Postman Apidog

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

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

Запрос#

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

POST 
{{apiUrl}}/v3/waInstance{{idInstance}}/setGroupAdmin/{{apiTokenInstance}}

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

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

Параметр Тип Обязательный Описание
chatId string Да Идентификатор группового чата
participantChatId string Да Идентификатор участника группы, назначаемого в качестве администратора

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

Назначение участника группового чата администратором: 

{
    "chatId": "-10000000000000",
    "participantChatId": "10000000"
}

Ответ#

Поля ответа#

Поле Тип Описание
setGroupAdmin boolean Флаг назначения участника группы администратором

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

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

{
    "setGroupAdmin": true
}

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

status code 200 

{
    "setGroupAdmin": false,
    "error": "participant not found"
}

Ошибки SetGroupAdmin#

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

Код HTTP Идентификатор ошибки Описание
200 failed to set group admin Не удалось назначить участника администратором.
Возможные причины:
- Неверно указан chatId
- Номер, привязанный к инстансу, не является администратором
- Участник группы уже является администратором
200 participant not found Указанный номер не состоит в группе
400 Bad Request
Validation failed		 Ошибка валидации

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

import requests

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

payload = {(
    "chatId": "-10000000000000",
    "participantChatId": "10000000")
}
headers = {
  'Content-Type': 'application/json'
}

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

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

curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/setGroupAdmin/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "-10000000000000",
    "participantChatId": "10000000"
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/setGroupAdmin/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\"chatId\": \"-10000000000000\",\"participantChatId\": \"10000000\"}";

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("/setGroupAdmin/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\"chatId\": \"-10000000000000\",\"participantChatId\": \"10000000\"}")
    .asString();

System.out.println(response);

Sub SetGroupAdmin()
    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}}/setGroupAdmin/{{apiTokenInstance}}"

    RequestBody = "{""chatId"":""-10000000000000"",""participantChatId"":""10000000""}"

    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