RemoveGroupParticipant#
Метод удаляет участника из группового чата.
Запрос#
Для удаления участника из группового чата требуется выполнить запрос по адресу:
POST
{{apiUrl}}/waInstance{{idInstance}}/removeGroupParticipant/{{apiTokenInstance}}
Для получения параметров запроса apiUrl
, idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
groupId | string | Да | Идентификатор группового чата |
participantChatId | string | Да | Идентификатор участника, удаляемого из группы |
Пример тела запроса#
Удаление участника группового чата:
{
"groupId": "120363043968066561@g.us",
"participantChatId": "79001234565@c.us"
}
Ответ#
Поля ответа#
Поле | Тип | Описание |
---|---|---|
removeParticipant | boolean | Флаг удаления участника из группы |
Пример тела ответа#
{
"removeParticipant": true
}
Ошибки RemoveGroupParticipant#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Код HTTP | Идентификатор ошибки | Описание |
---|---|---|
200 | "removeParticipant": false | Неверно указан participantChatId |
200 | "removeParticipant": false | Номер не состоит в группе |
400 | Bad Request Validation failed | Ошибка валидации |
Примеры кода#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/removeGroupParticipant/{{apiTokenInstance}}"
payload = {(
"groupId": "11011234567@g.us",
"participantChatId":"79001234568@c.us")
}
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/removeGroupParticipant/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"groupId": "120363169960827018@g.us",
"participantChatId": "79851150769@c.us"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/removeGroupParticipant/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"groupId\": \"111111112222222333333@g.us\",\"participantChatId\": \"12345678910@c.us\"}";
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("/waInstance").append({{idInstance}})
.append("/removeGroupParticipant/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"groupId\": \"111111112222222333333@g.us\",\"participantChatId\": \"12345678910@c.us\"}")
.asString();
System.out.println(response);
Sub RemoveGroupParticipant()
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}}/waInstance{{idInstance}}/removeGroupParticipant/{{apiTokenInstance}}"
' groupId - group chat identifier, participantChatId - identifier of the participant to be removed from the group
RequestBody = "{""groupId"":""120123400367448864@g.us"",""participantChatId"":""70123456789@c.us""}"
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