Перейти до вмісту

Пошук доступний лише у виробничих збірках. Спробуйте зібрати та переглянути сайт, щоби протестувати його локально

Отримати групу за ID

GET/v1/groups/{identifier}2₽ за 2xx

Повертає інформацію про групу: заголовок, опис, число учасників, мови, адміністраторів, історію @username.

Потрібен заголовок Api-Key.

Ім’я Тип Обов’язковий Опис
identifier string так Числовий ID групи або @username (наприклад example_group).
Terminal window
# За числовим ID
curl -H "Api-Key: $API_KEY" \
https://api.telesint.dev/v1/groups/12345
# За @username
curl -H "Api-Key: $API_KEY" \
https://api.telesint.dev/v1/groups/example_group
{
"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
}
}
Поле Тип Опис
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, якщо значення невідоме.
Поле Тип Опис
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 Коли запис про адміна підтвердили.
  • 404 — групу не знайдено.
  • 400 — некоректний identifier.
  • Див. Помилки.