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

AddGroupParticipant#

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

Запрос#

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

POST {{APIUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}

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

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

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

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

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

{
    "groupId": "120363043968066561@g.us",
    "participantChatId": "79001234565@c.us"
}

Ответ#

Поля ответа#

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

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

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

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

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

Также рекомендуем ознакомится со статьей "Почему участники не добавляются в группу?".

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

{
    "addParticipant": true
}

Ошибки AddGroupParticipant#

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

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

import requests

url = "{{APIUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}"

payload = "{\r\n\t\"groupId\": \"120363043968066561@g.us\",\r\n\t\"participantChatId\": \"79001234568@c.us\"\r\n}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
curl --location '{{APIUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupId": "111111112222222333333@g.us",
    "participantChatId": "12345678910@c.us"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/addGroupParticipant/")
    .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("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/addGroupParticipant/")
    .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 AddGroupParticipant()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The idInstance and apiTokenInstance values are available in your account, double brackets must be removed
    url = "{{APIUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}"

    ' groupId - group chat identifier, participantChatId - identifier of the participant added to the group chat
    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