getChatPreview

Возвращает превью чата: название, описание, число участников, можно ли читать без вступления и нужна ли заявка. Аккаунт при этом в чат не вступает.

Параметры

Передайте link или chatId:

Пример запроса

Превью публичного канала Telegram по ссылке:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getChatPreview/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"link": "https://t.me/robo_school"}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/getChatPreview/{TOKEN}"
payload = {"link": "https://t.me/robo_school"}
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}/getChatPreview/${GRATIO_TOKEN}`;
const payload = { link: "https://t.me/robo_school" };
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 . '/getChatPreview/' . getenv('GRATIO_TOKEN');
$payload = ['link' => 'https://t.me/robo_school'];

$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:

{
  "chatId": "-1001987654321",
  "type": "channel",
  "title": "Робототехника для школьников",
  "username": "robo_school",
  "link": "https://t.me/robo_school",
  "description": "Конкурсы, наборы и идеи для занятий",
  "members": 2400,
  "joined": false,
  "joinRequest": false,
  "public": true,
  "verified": false,
  "warning": "",
  "hasAvatar": true,
  "linkedChatId": "-1001987654322"
}

Поля превью

Ещё примеры

По приглашению Telegram

Аккаунта в чате нет — chatId будет null, вступить можно по той же ссылке:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getChatPreview/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"link": "https://t.me/+AbCdEfGhIjKlMnOp"}'

{
  "chatId": null, "type": "group", "title": "Родители 3А", "username": "",
  "link": "https://t.me/+AbCdEfGhIjKlMnOp", "description": "", "members": 26,
  "joined": false, "joinRequest": true, "public": false, "verified": false,
  "warning": "", "hasAvatar": false, "linkedChatId": ""
}

В MAX

По приглашению MAX сразу отдаёт chatId и название:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getChatPreview/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"link": "https://max.ru/join/AbCdEfGhIjKl"}'

Ошибки

Особенности каналов

• Telegram. Приглашение, по которому Telegram разрешает смотреть чат до вступления, приходит с public: true. Проверка приглашений t.me/+… — не больше 10 в час; ответ хранится 5 минут, поэтому превью и следующее за ним вступление тратят одну проверку.
• MAX. warning и linkedChatId всегда пустые. У закрытой группы по приглашению members может быть null.

Что дальше

• joinChat — вступить по той же ссылке.
• getChatHistory — прочитать публичный чат без вступления.
• Поиск и вступление: правила и лимиты — лимиты и отличия площадок.