Отдаёт ссылку на фото профиля собеседника или группы. Нужен, чтобы показать фото в карточке клиента или в списке чатов.
| Запрос | POST /waInstance{idInstance}/getAvatar/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp; у почты фото нет |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | собеседник или группа — id в этом канале |
Пример запроса
Фото Марии в MAX:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getAvatar/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"chatId": "8695836"}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/getAvatar/{TOKEN}"
payload = {"chatId": "8695836"}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())
Node.js
const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;
const url = `${base}/getAvatar/${GRATIO_TOKEN}`;
const payload = { chatId: "8695836" };
const response = await fetch(url, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(payload),
});
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getAvatar/' . getenv('GRATIO_TOKEN');
$payload = ['chatId' => '8695836'];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK:
{"urlAvatar": "https://i.oneme.ru/i?r=…", "available": true}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
urlAvatar |
string | ссылка на фото; "" — фото нет |
available |
boolean | true — фото есть, false — фото нет или его скрыли настройки приватности |
Ещё примеры
Группа в Telegram
У Telegram нет ссылок на фото: Gratio скачивает фото и отдаёт свою подписанную ссылку — как на файлы сообщений:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getAvatar/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"chatId": "-1001234567890"}'
Ответ 200 OK:
{"urlAvatar": "https://api.gratio.net/media/7100000001/-1001234567890/avatar/0/7c2e…", "available": true}
Фото нет
Нет фото или собеседник скрыл его настройками приватности:
{"urlAvatar": "", "available": false}
Особенности каналов
| Канал | Ссылка | Как часто обновляется |
|---|---|---|
| MAX | ссылка MAX на фото | собеседник — до часа, группа — до 15 минут |
| Telegram | подписанная ссылка Gratio, без токена | фото хранится 10 минут |
| подписанная ссылка Gratio, без токена | не чаще раза в 6 часов на собеседника | |
| Почта | — | всегда {"urlAvatar": "", "available": false} |
Та же ссылка приходит в avatar у getContactInfo и в urlAvatar у getGroupData.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId |
добавить поле |
400 |
not_found |
нет такого собеседника или группы | проверить chatId |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
Общие правила — в статье Ответы и ошибки.
Что дальше
- getContactInfo — профиль собеседника целиком.
- getGroupData — данные группы с фото.
- Файлы и ссылки на них — как устроены подписанные ссылки.
