SetGroupPicture#

Метод устанавливает аватар группы.

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

Запрос#

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

POST

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

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

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

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

Ответ#

Поля ответа#

Поле	Тип	Описание
`setGroupPicture`	boolean	флаг результата установки аватара группы
`urlAvatar`	string	url на установленное изображение
`reason`	string	причина почему аватар не был установлен

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

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

{
    "reason": "",
    "urlAvatar": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotBPGJiDHPpKQP3fE_vh2BE1holGE_adbUwUqCIPQgiOI",
    "setGroupPicture": true
}

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

status code 200

{
    "reason": "",
    "urlAvatar": "",
    "setGroupPicture": false
}

Ошибки SetGroupPicture#

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

Код HTTP	Идентификатор ошибки	Описание
200	`{` `"reason": "Timed Out",` `"urlAvatar": null,` `"setGroupPicture": false` `}`	Некорректный тип данных поля `chatId` либо некорректный `chatId`
400	`Bad Request` `Validation failed`	Ошибка валидации
400	`File is empty`	Пустой файл
400	`Unsupported media type`	Неподдерживаемый формат файла

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

PythoncURLJava - SpringJava - Unirest

import requests

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

payload = {(
    "chatId": "-10000000000000")
}
files=[
  ('file',('{{file}}.jpeg',open('C:/{{file}}.jpeg','rb'),'image/jpeg'))
]
headers = {}

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

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

curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/setGroupPicture/{{apiTokenInstance}}' \
--form 'file=@"/E:/GreenApi_docs/green-api-logo.png"' \
--form 'chatId="-10000000000000"'

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

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

var form = new LinkedMultiValueMap<>();
form.add("file", new FileSystemResource(new File("/E:/GreenApi_docs/green-api-logo.png")));
form.add("chatId", -10000000000000);

var requestEntity = new HttpEntity<>(form, 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("/setGroupPicture/")
    .append({{apiTokenInstance}});

var form = new HashMap<String, Object>();
    form.put("file", new File("/E:/GreenApi_docs/green-api-logo.png"));
    form.put("chatId", dto.getchatId("-10000000000000");

var response = var response = Unirest.post(requestUrl.toString())
    .fields(form)
    .asString();
System.out.println(response);