Ставит фото группы. Файл передаётся формой multipart/form-data, только в JPEG.
| Запрос | POST /waInstance{idInstance}/setGroupPicture/{apiTokenInstance} |
| Тело | multipart/form-data |
| Каналы | MAX, Telegram, WhatsApp |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | id группы. Принимается и groupId |
file |
файл | да | фото в JPEG. Тип Gratio определяет по содержимому файла, а не по имени |
Пример запроса
Логотип школы на группу в MAX:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/setGroupPicture/$GRATIO_TOKEN" \
-F 'chatId=-80040066617372' \
-F 'file=@logo.jpg;type=image/jpeg'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/setGroupPicture/{TOKEN}"
fields = {"chatId": "-80040066617372"}
with open("logo.jpg", "rb") as f:
files = {"file": ("logo.jpg", f, "image/jpeg")}
response = requests.post(url, data=fields, files=files, timeout=120)
print(response.status_code, response.json())
Node.js
import { readFile } from "node:fs/promises";
const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;
const url = `${base}/setGroupPicture/${GRATIO_TOKEN}`;
const form = new FormData();
form.append("chatId", "-80040066617372");
const file = new Blob([await readFile("logo.jpg")], { type: "image/jpeg" });
form.append("file", file, "logo.jpg");
const response = await fetch(url, { method: "POST", body: form });
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/setGroupPicture/' . getenv('GRATIO_TOKEN');
$form = [
'chatId' => '-80040066617372',
'file' => new CURLFile('logo.jpg', 'image/jpeg', 'logo.jpg'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $form,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 120,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK:
{"setGroupPicture": true, "urlAvatar": "https://i.oneme.ru/i?r=…", "reason": ""}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
setGroupPicture |
boolean | фото поставлено |
urlAvatar |
string, null | MAX — ссылка на новое фото; Telegram — ""; WhatsApp — id фото WhatsApp, а не ссылка. При отказе — null |
reason |
string | причина отказа; "" при успехе |
Ссылку на фото в любом канале дают getAvatar и getGroupData.
Если площадка отказала
Как у Green API, отказ площадки — тоже 200 OK, но с флагом false. В reason здесь только код причины, без текста. Номер канала — не админ группы в MAX:
{"setGroupPicture": false, "urlAvatar": null, "reason": "admin_required"}
Код в reason |
Когда |
|---|---|
admin_required |
MAX, Telegram: у номера канала нет прав |
not_admin |
WhatsApp: номер канала — не админ |
not_a_group, bad_group |
chatId — не группа |
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId или поля file в форме |
передать форму с файлом |
400 |
file_empty |
файл пустой | проверить файл |
400 |
unsupported_media |
файл не JPEG | перевести картинку в JPEG |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
402 |
payment_required |
канал на паузе за неоплату | продлить канал в кабинете |
501 |
not_supported |
канал «Почта» | — |
Общие правила — в статье Ответы и ошибки.
Особенности каналов
- Только JPEG во всех каналах: MAX другие форматы для фото группы не принимает. PNG и WebP переведите в JPEG у себя.
- События. В MAX и Telegram придёт уведомление groupEvent с
groupPhotoChanged.
Что дальше
- getAvatar — ссылка на фото группы.
- updateGroupName — название группы.
- Файлы и ссылки на них — типы файлов и пределы.
