Отримати групу за ID
GET/v1/groups/{identifier}2₽ за 2xx
Повертає інформацію про групу: заголовок, опис, число учасників, мови, адміністраторів, історію @username.
Авторизація
Section titled “Авторизація”Потрібен заголовок Api-Key.
Параметри шляху
Section titled “Параметри шляху”| Ім’я | Тип | Обов’язковий | Опис |
|---|---|---|---|
identifier |
string | так | Числовий ID групи або @username (наприклад example_group). |
Приклади
Section titled “Приклади”# За числовим IDcurl -H "Api-Key: $API_KEY" \ https://api.telesint.dev/v1/groups/12345
# За @usernamecurl -H "Api-Key: $API_KEY" \ https://api.telesint.dev/v1/groups/example_groupimport os, requests
def get_group(identifier: str | int) -> dict: response = requests.get( f"https://api.telesint.dev/v1/groups/{identifier}", headers={"Api-Key": os.environ["API_KEY"]}, timeout=10, ) response.raise_for_status() return response.json()["data"]
group = get_group("example_group")async function getGroup(identifier) { const res = await fetch( `https://api.telesint.dev/v1/groups/${identifier}`, { headers: { 'Api-Key': process.env.API_KEY } }, ); if (!res.ok) throw new Error(`HTTP ${res.status}`); const { data } = await res.json(); return data;}
const group = await getGroup('example_group');Відповідь — 200 OK
Section titled “Відповідь — 200 OK”{ "data": { "id": 12345, "url": "example_group", "h_url": [ { "value": "example_group_old", "update": "2021-01-01T00:00:00" }, { "value": "example_group_very_old", "update": "2020-06-01T00:00:00" } ], "title": "Example Group", "about": "Example Group About", "langs": [ { "lang_code": "ru", "name": "Russian" } ], "is_open": true, "users": 100, "admins": [ { "id": 12345, "is_creator": true, "role": "admin", "update": "2021-01-01T00:00:00" } ], "update": "2021-01-01T00:00:00", "create": "2021-01-01T00:00:00", "shadow": false }}Поля — data
Section titled “Поля — data”| Поле | Тип | Опис |
|---|---|---|
id |
integer | Незмінний ID групи. |
url |
string | null | Поточний @username. |
h_url |
масив history entry | Попередні @usernames. |
title |
string | Заголовок групи. |
about |
string | null | Опис групи. |
langs |
масив { lang_code, name } |
Мови групи. |
is_open |
boolean | true, якщо список учасників доступний у Telegram; false, якщо прихований. |
users |
integer | Число учасників. |
admins |
масив admin | Адміністратори групи. |
update |
string (date-time) | null | Останнє оновлення метаданих. |
create |
string (date-time) | null | Коли групу було додано до бази. |
shadow |
boolean | null | Вказує, чи прихований список учасників групи; null, якщо значення невідоме. |
History entry
Section titled “History entry”| Поле | Тип | Опис |
|---|---|---|
value |
string | Попереднє значення @username. |
update |
string (date-time) | null | Коли @username був змінений. |
| Поле | Тип | Опис |
|---|---|---|
id |
integer | ID користувача-адміна. Повний профіль — через GET /v1/users/{identifier}. |
role |
string | null | admin, owner тощо. |
is_creator |
boolean | null | true для творця групи. |
update |
string (date-time) | null | Коли запис про адміна підтвердили. |
Помилки
Section titled “Помилки”404— групу не знайдено.400— некоректнийidentifier.- Див. Помилки.
Пов’язані методи
Section titled “Пов’язані методи”- Схожі групи.
- Отримати користувача — резолв адмінів.