AddGroupParticipant#

Метод добавляет участника в групповой чат.

Важно

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

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

Запрос#

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

POST

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

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

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

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

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

Добавление участника в групповой чат:

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

Ответ#

Поля ответа#

Поле	Тип	Описание
`addParticipant`	boolean	Флаг добавления участника в групповой чат

Почему ответ запроса false?

Ответ на запрос или значение addParticipant может быть false по трём причинам:

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

Некоторые номера могут добавляться в группу и без сохранения в телефонную книгу.
Тем не менее, для обеспечения успешного добавления участника в группу рекомендуется всегда предварительно сохранять номер телефона участника в списке контактов.

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

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

{
    "addParticipant": true
}

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

status code 200

{
    "addParticipant": false
}

Ошибки AddGroupParticipant#

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

Код HTTP	Идентификатор ошибки	Описание
200	`"addParticipant": false`	Указанный номер уже состоит в группе
200	`"addParticipant": false`	Вы не состоите в группе
200	`"addParticipant": false`	Неверно указан `participantChatId`
400	`Bad Request` `Validation failed`	Ошибка валидации

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

PythoncURLJava - SpringJava - UnirestVBA

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/addGroupParticipant/{{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}}/waInstance{{idInstance}}/addGroupParticipant/{{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("/addGroupParticipant/")
    .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("/addGroupParticipant/")
    .append({{apiTokenInstance}});

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

System.out.println(response);

Sub AddGroupParticipant()
    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}}/addGroupParticipant/{{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