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

Довідник API поки що доступний лише російською. Назви методів, шляхи й приклади однакові для всіх мов.

Справочник методов

Все 349 методов Client API, собранные прямо из кода сервера: путь, вход, CSRF, параметры строки запроса и поля тела с ограничениями.
Содержание

Как читать#

  • Вход — метод требует сессию (вход). «Необязателен» — без сессии ответ публичный, с ней — дополнен данными о вас.
  • CSRF — нужен заголовок x-csrf-token (как получить).
  • {name} в пути — параметр пути. Поля тела — JSON, если не указано multipart. Вложенные поля записаны через точку.
  • Ответ всегда в конверте {success, data}; поля data зависят от метода.

Вход и сессии#

GET/api/auth/accounts

List the accounts available to switch to on this device (Telegram-style multi-account).

Вход: нужен

POST/api/auth/accounts/remove

Remove a (non-active) account from this device and revoke its session here.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
userIdstringДаот 5, до 64 симв.
POST/api/auth/accounts/switch

Swap the active session to another pooled account without re-logging-in.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
userIdstringДаот 5, до 64 симв.
GET/api/auth/csrf

Вход: не нужен

POST/api/auth/forgot-password

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
emailstring (email)Нет
identifierstringНетот 1, до 254 симв.
POST/api/auth/login

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
emailstring (email)Да
passwordstringДаот 8, до 72 симв.
twoFactorCodestringНетровно 6 симв.
captchaTokenstringНетдо 2048 симв.
POST/api/auth/logout

Вход: не нужен · CSRF

GET/api/auth/me

Вход: не нужен

POST/api/auth/place/authorize

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
tokenstringДаот 16, до 256 симв.
POST/api/auth/qr/approve

Phone: confirm the login for the currently signed-in account.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
tokenobjectДа
POST/api/auth/qr/claim

PC: once the phone has approved, consume the session and receive auth cookies.

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
tokenobjectДа
POST/api/auth/qr/inspect

Phone: preview which device is asking to log in, before confirming.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
tokenobjectДа
POST/api/auth/qr/start

PC: open a pending QR-login session.

Вход: не нужен · CSRF

GET/api/auth/qr/status

PC: poll the session state.

Вход: не нужен

Параметры запроса: token

POST/api/auth/register

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
emailstring (email)Да
passwordstringДаот 8, до 72 симв.
captchaTokenstringНетдо 2048 симв.
referralCodestringНетдо 64 симв.
POST/api/auth/resend-verification

Вход: нужен · CSRF

POST/api/auth/resend-verification-code

Re-send the registration code (unauthenticated — the user isn't signed in yet).

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
emailstring (email)Да
POST/api/auth/reset-password

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
tokenstringНетот 10
identifierstringНетот 1, до 254 симв.
codestringНетровно 6 симв.
passwordstringДаот 8, до 72 симв.
GET/api/auth/sessions

Вход: нужен

DELETE/api/auth/sessions/{id}

Revoke a single device session by id (the service verifies it belongs to the caller).

Вход: нужен · CSRF

POST/api/auth/sessions/logout-others

"Log out all other devices" — revokes every session except the caller's current one.

Вход: нужен · CSRF

POST/api/auth/telegram/claim

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
tokenobjectДа
POST/api/auth/telegram/start

Вход: не нужен · CSRF

GET/api/auth/telegram/status

Вход: не нужен

Параметры запроса: token

POST/api/auth/verify-email

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
tokenstringДаот 10
POST/api/auth/verify-email-code

Confirm the 6-digit registration code.

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
emailstring (email)Да
codestringДаровно 6 симв.

Аккаунт#

GET/api/account/activity

Вход: нужен

POST/api/account/delete

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
passwordstringДаот 1, до 72 симв.
POST/api/account/emoji-status

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
emojistringДадо 64 симв., может быть null
POST/api/account/onboarding

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
displayNamestringДаот 2, до 40 симв.
usernameobjectДа
avatarUrlstringНетдо 2048 симв.
interestsstring[]Нетдо 12 эл.
followUserIdsstring[]Нетдо 9 эл.
GET/api/account/onboarding/suggestions

Кандидаты для шага «на кого подписаться».

Вход: нужен

Параметры запроса: interests

POST/api/account/password

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
currentPasswordstringДаот 1, до 72 симв.
newPasswordstringДаот 8, до 72 симв.
PATCH/api/account/privacy

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
showOnlineStatusbooleanНет
languageobjectДа
screenshotAlertEnabledbooleanНет
isPrivatebooleanНет
groupInvitePolicy"EVERYONE" | "FOLLOWING" | "NOBODY"Нет
PATCH/api/account/profile

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
usernameobjectДа
displayNamestringДаот 2, до 40 симв.
biostringНетдо 560 симв.
locationstringНетдо 100 симв.
websitestringНетдо 2048 симв.
birthDatestringНет
avatarUrlstringНетдо 2048 симв.
coverUrlstringНетдо 2048 симв.
usernameAliasesobject[]Нетдо 10 эл.
interestsstring[]Нетдо 20 эл.
selfBadgesstring[]Нетдо 20 эл.
verificationBadge"NONE" | "BLUE" | "GOLD" | "GRAY" | "PINK" | "VERIFIED" | "MAJOR"Нет
profilePalette"DEFAULT" | "CHAMPAGNE" | "ICE_BLUE" | "BLUE" | "VIOLET" | "CYAN" | "EMERALD" | "PINK" | "ORANGE" | "GOLD" | "PLATINUM" | "RED"Нет
languageobjectДа
profileMusicobjectНетможет быть null
profileMusic.idstringДаот 1, до 256 симв.
profileMusic.titlestringДаот 1, до 160 симв.
profileMusic.artiststringДаот 1, до 160 симв.
profileMusic.durationnumberДадо 86400
profileMusic.audioUrlstringДаот 1, до 2048 симв.
profileMusic.coverUrlstringНетдо 2048 симв., может быть null
profileMusic.provider"internal" | "soundcloud" | "tiktok" | "itunes" | "mock"Да
profileMusic.fragmentStartnumberДадо 86400
profileMusic.fragmentDurationnumberДадо 60
profileVibeobjectНетможет быть null
profileVibe.emojistringДаот 1, до 8 симв.
profileVibe.labelstringДаот 1, до 32 симв.
profileVibe.textstringНетдо 80 симв., по умолчанию ""
profileVibe.accent"cyan" | "violet" | "rose" | "amber" | "emerald" | "blue"Да
profileVibe.intensitynumberНетот 0, до 100, по умолчанию 70
profileVibe.updatedAtstringДа
profileVibe.expiresAtstringНетможет быть null
profileVibe.musicobjectНетможет быть null
profileVibe.music.idstringДаот 1, до 256 симв.
profileVibe.music.titlestringДаот 1, до 160 симв.
profileVibe.music.artiststringДаот 1, до 160 симв.
profileVibe.music.durationnumberДадо 86400
profileVibe.music.audioUrlstringДаот 1, до 2048 симв.
profileVibe.music.coverUrlstringНетдо 2048 симв., может быть null
profileVibe.music.provider"internal" | "soundcloud" | "tiktok" | "itunes" | "mock"Да
profileVibe.music.fragmentStartnumberДадо 86400
profileVibe.music.fragmentDurationnumberДадо 60
profileCoverobjectНетможет быть null
profileStyleobjectНетможет быть null
profileStyle.fontenumНет
profileStyle.frameenumНет
profileStyle.cardThemeenumНет
profileStyle.nameplateenumНет
profileStyle.effectenumНет
linksobject[]Нетдо 6 эл.
links[].urlstringДадо 2048 симв.
links[].labelstringНетдо 40 симв., может быть null
personalChannelsstring[]Нетдо 3 эл.
POST/api/account/profile-gifts-showcase

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
giftInstanceIdsstring[]Дадо 8 эл.
GET/api/account/sessions

Вход: нужен

POST/api/account/sessions/revoke

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
sessionIdstringДаот 10
POST/api/account/sessions/revoke-others

Вход: нужен · CSRF

POST/api/account/telegram/link

Start linking: mint a one-time code + t.me deep link the user taps to open (and auto-link in) the bot.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
purpose"BOT" | "AUTH"Нетпо умолчанию "BOT"
POST/api/account/two-factor/disable

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
passwordstringДаот 1
POST/api/account/two-factor/email/enable

Confirm the emailed code and switch the account to email 2FA.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
codestringДаровно 6 симв.
POST/api/account/two-factor/email/setup

Email a confirmation code before enabling email 2FA.

Вход: нужен · CSRF

POST/api/account/two-factor/enable

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
codestringДаровно 6 симв.
GET/api/account/two-factor/setup

Вход: нужен

GET/api/account/two-factor/telegram

Что доступно для Telegram-двухфакторки: настроен ли бот, привязан ли чат, есть ли анонимный номер.

Вход: нужен

POST/api/account/two-factor/telegram/enable

Подтвердить код из Telegram и включить второй фактор (по аккаунту или по анонимному номеру).

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
codestringДаровно 6 симв.
method"telegram" | "number"Нетпо умолчанию "telegram"
POST/api/account/two-factor/telegram/setup

Отправить код подтверждения в Telegram перед включением второго фактора.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
method"telegram" | "number"Нетпо умолчанию "telegram"
POST/api/account/upload

Вход: нужен · CSRF · multipart/form-data

GET/api/account/username/check

Свободен ли ник — вопрос, который редактор профиля задаёт по мере набора.

Вход: нужен

Параметры запроса: value

Пользователи#

GET/api/social/users/{username}

Вход: нужен

POST/api/social/users/{username}/block

Вход: нужен · CSRF

DELETE/api/social/users/{username}/block

Вход: нужен · CSRF

GET/api/social/users/{username}/collections

Вход: нужен

POST/api/social/users/{username}/collections

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
namestringДаот 1, до 64 симв.
PATCH/api/social/users/{username}/collections/{collectionId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
namestringНетот 1, до 64 симв.
giftIdsstring[]Нетдо 500 эл.
DELETE/api/social/users/{username}/collections/{collectionId}

Вход: нужен · CSRF

POST/api/social/users/{username}/follow

Вход: нужен · CSRF

GET/api/social/users/{username}/followers

Вход: нужен

GET/api/social/users/{username}/following

Вход: нужен

GET/api/social/users/{username}/gifts

Вход: нужен

Параметры запроса: limit, page, collection

GET/api/social/users/{username}/gifts/marketplace

Вход: нужен

POST/api/social/users/{username}/gifts/send

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
variantIdstringДаот 5
messagestringНетдо 280 симв., может быть null
isAnonymousbooleanНет
GET/api/social/users/{username}/media

Вход: нужен

Параметры запроса: cursor, limit

POST/api/social/users/{username}/message

Вход: нужен · CSRF

GET/api/social/users/{username}/posts

Вход: нужен

Параметры запроса: cursor, limit

GET/api/social/users/{username}/profile-gifts-showcase

Вход: нужен

GET/api/social/users/{username}/profile-views

Вход: нужен

Параметры запроса: limit

GET/api/social/users/{username}/replies

Вход: нужен

Параметры запроса: cursor, limit

GET/api/social/users/{username}/resolve

Does this handle belong to anyone, and what is its canonical form?

Вход: нужен

GET/api/social/users/{username}/stories

Вход: нужен

GET/api/social/users/{username}/verification

The two facts the verification popover shows: which badge, and when it was granted.

Вход: нужен

Посты#

POST/api/social/posts

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringНетдо 1200 симв., по умолчанию ""
imageUrlsstring[]Нетдо 10 эл., по умолчанию []
videoUrlstringНетдо 2048 симв., может быть null
pollobjectНет
poll.optionsstring[]Даот 2, до 4 эл.
poll.durationDaysunionДа
audience"EVERYONE" | "SUBSCRIBERS"Нетпо умолчанию "EVERYONE"
isNsfwbooleanНетпо умолчанию false
attachmentsobject[]Нетдо 4 эл., по умолчанию []
attachments[].urlstringДадо 2048 симв.
attachments[].namestringДаот 1, до 255 симв.
attachments[].sizeintegerНетдо 200000000, может быть null
attachments[].mimeTypestringНетдо 127 симв., может быть null
musicobjectНетможет быть null
clientPostIdstringНетдо 64 симв., может быть null
GET/api/social/posts/{postId}

Вход: нужен

PATCH/api/social/posts/{postId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringНетдо 1200 симв., по умолчанию ""
DELETE/api/social/posts/{postId}

Вход: нужен · CSRF

POST/api/social/posts/{postId}/bookmark

Вход: нужен · CSRF

POST/api/social/posts/{postId}/boost

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
tierIdstringДаот 1, до 64 симв.
GET/api/social/posts/{postId}/comments

Вход: нужен

Параметры запроса: cursor, parentCommentId, limit, sort

POST/api/social/posts/{postId}/comments

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringНетдо 280 симв., по умолчанию ""
parentCommentIdstringНетот 10, может быть null
replyToIdstringНетот 10, может быть null
imageUrlobjectДа
voiceUrlobjectДа
voiceDurationMsintegerНетот 0, до 1000 * 60 * 30, может быть null
videoUrlobjectДа
videoDurationMsintegerНетот 0, до 1000 * 60, может быть null
GET/api/social/posts/{postId}/donate

Вход: нужен

POST/api/social/posts/{postId}/donate

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
amountintegerДаот 1, до 1000000
messagestringНетдо 200 симв., может быть null
POST/api/social/posts/{postId}/like

Вход: нужен · CSRF

POST/api/social/posts/{postId}/mute-notifications

Переключает «Отключить уведомления об этом посте» для ТЕКУЩЕГО пользователя.

Вход: нужен · CSRF

POST/api/social/posts/{postId}/not-interested

«Не интересно»: убрать пост из выдачи этому зрителю и записать скрытие как сигнал ранжирования.

Вход: нужен · CSRF

POST/api/social/posts/{postId}/pin

Вход: нужен · CSRF

POST/api/social/posts/{postId}/poll-votes

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
optionIdstringДаот 1
POST/api/social/posts/{postId}/reactions

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
emojistringНетдо 16 симв., может быть null
GET/api/social/posts/{postId}/replies

Вход: не нужен

POST/api/social/posts/{postId}/replies

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringДаот 1, до 280 симв.
POST/api/social/posts/{postId}/repost

Вход: нужен · CSRF

POST/api/social/posts/{postId}/share

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
targetsobject[]Даот 1, до 10 эл.
targets[].kind"conversation" | "user" | "channel"Да
targets[].idstringДаот 1, до 64 симв.
commentstringНетдо 1000 симв., по умолчанию ""
POST/api/social/posts/{postId}/view

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
dwellMsintegerНетот 2000
visibleRationumberНетот 0.5, до 1
GET/api/social/posts/{postId}/viewers

Вход: нужен

Параметры запроса: limit

Лента#

GET/api/social/feed

Вход: нужен

Параметры запроса: cursor, limit, following

GET/api/social/feed/by-ids

Вход: нужен

Параметры запроса: ids

POST/api/social/feed/signal

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
eventsobject[]Даот 1, до 60 эл.
events[].postIdstringДаот 1, до 64 симв.
events[].dwellMsintegerДаот 0, до 600000
events[].visibleRationumberНетот 0, до 1
events[].completedbooleanНет
events[].returnedbooleanНет

Комментарии#

PATCH/api/social/comments/{commentId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringДаот 1, до COMMENT_MAX_LENGTH + 1 симв.
DELETE/api/social/comments/{commentId}

Вход: нужен · CSRF

POST/api/social/comments/{commentId}/like

Вход: нужен · CSRF

GET/api/social/comments/{commentId}/replies

Вход: нужен

Параметры запроса: cursor, limit

Сообщения и чаты#

GET/api/social/messages

Вход: нужен

GET/api/social/messages/{conversationId}

Вход: нужен

Параметры запроса: before, limit

POST/api/social/messages/{conversationId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringНетдо 2000 симв., по умолчанию ""
clientMessageIdstringНетот 1, до 64 симв., может быть null
libunixobjectНетможет быть null
libunix.senderDeviceIdintegerДаот 1
libunix.envelopesobject[]Даот 1, до 64 эл.
replyToIdstringНетот 1, до 64 симв., может быть null
mediaobjectНетможет быть null
media.type"image" | "voice" | "video" | "file" | "sticker"Да
media.urlstring (url)Дадо 2048 симв.
media.namestringНетдо 255 симв., может быть null
media.durationMsintegerНетдо 86400000, может быть null
media.widthintegerНетдо 10000, может быть null
media.heightintegerНетдо 10000, может быть null
media.groupIdstringНетможет быть null
media.spoilerbooleanНетможет быть null
media.sizeBytesintegerНетдо 4294967295, может быть null
media.mimestringНетдо 100 симв., может быть null
media.waveformstringНетдо 512 симв., может быть null
pollobjectНетможет быть null
poll.questionstringДаот 1, до 255 симв.
poll.optionsstring[]Даот 2, до 10 эл.
poll.anonymousbooleanНетпо умолчанию true
poll.multipleChoicebooleanНетпо умолчанию false
poll.quizbooleanНетпо умолчанию false
poll.correctOptionintegerНетот 0, до 9, может быть null
poll.solutionstringНетдо 200 симв., может быть null
poll.closePeriodSecintegerНетот 60, до 7 * 24 * 3600, может быть null
diceobjectНетможет быть null
dice.emoticonenumДа
scheduledAtstringНетможет быть null
scheduleRepeat"DAILY" | "WEEKLY" | "MONTHLY"Нетможет быть null
effectIdstringНетдо 32 симв., может быть null
replyQuotestringНетот 1, до 1024 симв., может быть null
captionAbovebooleanНет
silentbooleanНет
venueobjectНетможет быть null
venue.latnumberДаот -90, до 90
venue.lngnumberДаот -180, до 180
venue.titlestringДаот 1, до 120 симв.
venue.addressstringНетдо 180 симв.
storyobjectНетможет быть null
story.storyIdstringДаот 1, до 64 симв.
paidStarsintegerНетот 1, до 10000, может быть null
todoobjectНетможет быть null
todo.titlestringДаот 1, до 255 симв.
todo.itemsstring[]Даот 1, до 10 эл.
todo.othersCanCompletebooleanНетпо умолчанию true
giveawayobjectНетможет быть null
giveaway.starsPerWinnerintegerДаот 1, до 100000
giveaway.winnersCountintegerДаот 1, до 10
giveaway.prizeDescriptionstringНетдо 200 симв., может быть null
giveaway.untilDatestringДа
PATCH/api/social/messages/{conversationId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
typingbooleanНет
typingAction"typing" | "voice" | "photo"Нет
heartbeatbooleanНет
PATCH/api/social/messages/{conversationId}/auto-delete

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
secondsintegerДадо 2592000
POST/api/social/messages/{conversationId}/callback

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
datastringДадо 64 симв.
GET/api/social/messages/{conversationId}/channel

Карточка канала: описание, ссылка, подписчики, права зрителя.

Вход: нужен

PATCH/api/social/messages/{conversationId}/channel

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
titlestringНетот 1, до 128 симв.
descriptionstringНетдо 255 симв., может быть null
avatarUrlstring (url)Нетдо 2048 симв., может быть null
usernamestringНетдо 32 симв., может быть null
signMessagesbooleanНет
reactionsMode"all" | "some" | "none"Нет
allowedReactionsstring[]Нетдо 100 эл.
DELETE/api/social/messages/{conversationId}/channel

«Удалить канал» — только владелец.

Вход: нужен · CSRF

PUT/api/social/messages/{conversationId}/channel/admins/{userId}

Назначить админа / изменить права.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
rightsenum[]Дадо CHANNEL_ADMIN_RIGHTS.length эл.
rankstringНетдо 16 симв., может быть null
DELETE/api/social/messages/{conversationId}/channel/admins/{userId}

«Снять права администратора».

Вход: нужен · CSRF

GET/api/social/messages/{conversationId}/channel/discussion

«Обсуждение»: привязанная группа и свои группы-кандидаты.

Вход: нужен

PUT/api/social/messages/{conversationId}/channel/discussion

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
groupIdstringНетот 1, может быть null
createbooleanНет
DELETE/api/social/messages/{conversationId}/channel/discussion

Выключить комментарии — отвязать группу.

Вход: нужен · CSRF

POST/api/social/messages/{conversationId}/channel/invite

Ссылка-приглашение, revoke: true — «Сбросить ссылку».

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
revokebooleanНет
POST/api/social/messages/{conversationId}/channel/join

«Подписаться» из открытого публичного канала.

Вход: нужен · CSRF

GET/api/social/messages/{conversationId}/channel/participants

Подписчики / админы: ?filter=subscribers|admins&q=&cursor=.

Вход: нужен

Параметры запроса: filter, q, cursor

POST/api/social/messages/{conversationId}/channel/participants

«Добавить подписчиков».

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
userIdsstring[]Даот 1, до 200 эл.
DELETE/api/social/messages/{conversationId}/channel/participants/{userId}

«Удалить из канала».

Вход: нужен · CSRF

POST/api/social/messages/{conversationId}/clear

Вход: нужен · CSRF

GET/api/social/messages/{conversationId}/comments/{postId}

Комментарии к посту канала: ?before=<id> — страница выше.

Вход: нужен

Параметры запроса: before

POST/api/social/messages/{conversationId}/comments/{postId}

Оставить комментарий к посту.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringНетдо 2000 симв., по умолчанию ""
replyToIdstringНетот 1, может быть null
clientMessageIdstringНетот 1, до 64 симв., может быть null
mediaobjectНетможет быть null
media.type"image" | "voice" | "video" | "file" | "sticker"Да
media.urlstring (url)Дадо 2048 симв.
media.namestringНетдо 255 симв., может быть null
media.durationMsintegerНетможет быть null
media.widthintegerНетможет быть null
media.heightintegerНетможет быть null
media.sizeBytesintegerНетможет быть null
media.mimestringНетдо 100 симв., может быть null
media.waveformstringНетможет быть null
PATCH/api/social/messages/{conversationId}/comments/{postId}/{commentId}

Изменить свой комментарий.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringДаот 1, до 2000 симв.
DELETE/api/social/messages/{conversationId}/comments/{postId}/{commentId}

Удалить комментарий: свой — автору, любой — админу канала с delete_messages.

Вход: нужен · CSRF

POST/api/social/messages/{conversationId}/comments/{postId}/{commentId}/reactions

Поставить или снять реакцию на комментарий.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
emojistringДаот 1, до 16 симв.
POST/api/social/messages/{conversationId}/delete

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdsstring[]Даот 1, до 100 эл.
forAllbooleanНетпо умолчанию true
POST/api/social/messages/{conversationId}/edit

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
contentstringДаот 1, до 2000 симв.
PATCH/api/social/messages/{conversationId}/fact-check

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
textstringДадо 1024 симв.
GET/api/social/messages/{conversationId}/group

Вход: нужен

PATCH/api/social/messages/{conversationId}/group

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
titlestringНетот 1, до 128 симв.
avatarUrlstring (url)Нетдо 2048 симв., может быть null
POST/api/social/messages/{conversationId}/invite

Вход: нужен · CSRF

POST/api/social/messages/{conversationId}/invoice

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
POST/api/social/messages/{conversationId}/leave

Вход: нужен · CSRF

GET/api/social/messages/{conversationId}/media

Вход: нужен

POST/api/social/messages/{conversationId}/members

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
memberIdsstring[]Даот 1, до 200 эл.
PATCH/api/social/messages/{conversationId}/members/{userId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
role"ADMIN" | "MEMBER"Да
DELETE/api/social/messages/{conversationId}/members/{userId}

Вход: нужен · CSRF

POST/api/social/messages/{conversationId}/paid-media

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
POST/api/social/messages/{conversationId}/pin

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
pinnedbooleanДа
GET/api/social/messages/{conversationId}/pinned

The conversation's pinned messages — asked for separately from the history page, because the plate must stay on screen no matter how far the reader has scrolled.

Вход: нужен

POST/api/social/messages/{conversationId}/poll-votes

Vote in a chat poll (single option for regular/quiz, a set for «несколько ответов»).

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
optionIdsstring[]Даот 1, до 10 эл.
POST/api/social/messages/{conversationId}/reactions

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1
emojistringДаот 1, до 4 симв.
POST/api/social/messages/{conversationId}/read

Вход: нужен · CSRF

GET/api/social/messages/{conversationId}/read-by

«Просмотрели» — who has read the viewer's own message (Telegram read participants).

Вход: нужен

Параметры запроса: messageId

GET/api/social/messages/{conversationId}/scheduled

The viewer's pending «Отправить позже» messages for this conversation.

Вход: нужен

POST/api/social/messages/{conversationId}/scheduled

«Отправить сейчас» / «Удалить» a scheduled message.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
action"send-now" | "cancel"Да
PATCH/api/social/messages/{conversationId}/state

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
pinnedbooleanНет
archivedbooleanНет
markedUnreadbooleanНет
mutedbooleanНет
folderIdstringНетот 1, до 64 симв., может быть null
draftstringНетдо 4096 симв., может быть null
DELETE/api/social/messages/{conversationId}/state

Вход: нужен · CSRF

POST/api/social/messages/{conversationId}/todo-toggle

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
optionIdstringДаот 1, до 64 симв.
completedbooleanДа
POST/api/social/messages/{conversationId}/views

Просмотры постов канала: засчитывает показ и отдаёт свежие счётчики.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdsstring[]Даот 1, до 100 эл.
POST/api/social/messages/{conversationId}/webapp

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdstringДаот 1, до 64 симв.
urlstring (url)Дадо 512 симв.
GET/api/social/messages/folders

Вход: нужен

POST/api/social/messages/folders

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
namestringДаот 1, до 64 симв.
PATCH/api/social/messages/folders/{folderId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
namestringДаот 1, до 64 симв.
DELETE/api/social/messages/folders/{folderId}

Вход: нужен · CSRF

PATCH/api/social/messages/folders/reorder

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
folderIdsstring[]Даот 1, до 64 эл.
POST/api/social/messages/forward

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
fromConversationIdstringДаот 1, до 64 симв.
toConversationIdstringДаот 1, до 64 симв.
messageIdsstring[]Даот 1, до 30 эл.
dropAuthorbooleanНетпо умолчанию false
dropCaptionsbooleanНетпо умолчанию false
POST/api/social/messages/group

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
titlestringДаот 1, до 128 симв.
memberIdsstring[]Даот 1, до 200 эл.
avatarUrlstring (url)Нетдо 2048 симв., может быть null
POST/api/social/messages/import/telegram

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
chatsobject[]Даот 1, до 50 эл.
chats[].tgChatIdstringДаот 1, до 64 симв.
chats[].namestringДадо 256 симв.
chats[].typestringДадо 64 симв.
chats[].messagesobject[]Дадо 2000 эл.
chats[].messages[].tgIdstringДаот 1, до 64 симв.
chats[].messages[].unixtimeintegerДа
chats[].messages[].outgoingbooleanДа
chats[].messages[].fromNamestringНетдо 120 симв., может быть null
chats[].messages[].textstringДадо 8192 симв.
chats[].messages[].replyToTgIdstringНетдо 64 симв., может быть null
chats[].messages[].forwardedFromstringНетдо 120 симв., может быть null
chats[].messages[].isServicebooleanНет
GET/api/social/messages/join/{token}

Preview before joining (title, picture, members)

Вход: нужен

POST/api/social/messages/join/{token}

Вход: нужен · CSRF

PATCH/api/social/messages/pin-order

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
conversationIdsstring[]Дадо 100 эл.
GET/api/social/messages/saved

Returns (creating if needed) the user's private "Saved Messages" self-chat id.

Вход: нужен

GET/api/social/messages/unread-count

Вход: нужен

Каналы#

POST/api/social/channels

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
titlestringДаот 1, до 128 симв.
descriptionstringНетдо 255 симв., может быть null
avatarUrlstring (url)Нетдо 2048 симв., может быть null
usernamestringНетдо 32 симв., может быть null
GET/api/social/channels/check-username

Вход: нужен

Параметры запроса: username, conversationId

GET/api/social/channels/resolve/{username}

Публичный канал по @username — превью до подписки.

Вход: нужен

POST/api/social/channels/resolve/{username}

Подписаться на публичный канал по @username.

Вход: нужен · CSRF

Сообщества#

GET/api/social/communities

Вход: нужен

POST/api/social/communities

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
namestringДаот 1, до 80 симв.
handlestringДаот 3, до 32 симв.
descriptionstringНетдо 500 симв.
avatarUrlstringНетдо 2048 симв.
bannerUrlstringНетдо 2048 симв.
GET/api/social/communities/{handle}

Вход: нужен

PATCH/api/social/communities/{handle}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
namestringНетдо 80 симв.
descriptionstringНетдо 500 симв., может быть null
avatarUrlstringНетдо 2048 симв., может быть null
bannerUrlstringНетдо 2048 симв., может быть null
locationstringНетдо 80 симв., может быть null
websitestringНетдо 200 симв., может быть null
categorystringНетдо 40 симв., может быть null
handleAliasesstring[]Нетдо 5 эл.
GET/api/social/communities/{handle}/admins

Вход: нужен

POST/api/social/communities/{handle}/admins

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
usernamestringДаот 1, до 60 симв.
action"promote" | "demote"Да
POST/api/social/communities/{handle}/gifts/send

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
variantIdstringДаот 5
messagestringНетдо 280 симв., может быть null
isAnonymousbooleanНет
GET/api/social/communities/{handle}/media

Вход: нужен

Параметры запроса: cursor

GET/api/social/communities/{handle}/members

Вход: нужен

POST/api/social/communities/{handle}/membership

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
action"join" | "leave"Да
GET/api/social/communities/{handle}/posts

Вход: нужен

Параметры запроса: cursor

POST/api/social/communities/{handle}/posts

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
contentstringНетдо 1200 симв., по умолчанию ""
imageUrlsstring[]Нетдо 10 эл., по умолчанию []
videoUrlstringНетдо 2048 симв., может быть null
attachmentsobject[]Нетдо 4 эл., по умолчанию []
attachments[].urlstringДадо 2048 симв.
attachments[].namestringДаот 1, до 255 симв.
attachments[].sizeintegerНетдо 200000000, может быть null
attachments[].mimeTypestringНетдо 127 симв., может быть null
clientPostIdstringНетдо 64 симв., может быть null
GET/api/social/communities/admined

Каналы, которыми управляет вызывающий — список для пикера «Каналы в профиле».

Вход: нужен

GET/api/social/communities/discover

Вход: нужен

Параметры запроса: q

Истории#

GET/api/social/stories

Вход: нужен

POST/api/social/stories

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
type"TEXT" | "IMAGE" | "VIDEO"Нетпо умолчанию "TEXT"
textstringНетдо 500 симв., по умолчанию ""
mediaUrlstringНетдо 2048 симв.
backgroundColorstringНетдо 32 симв.
thumbnailUrlstringНетдо 2048 симв.
musicIdstringНетдо 128 симв.
musicunknownНет
layersunknown[]Нетдо 80 эл.
editorStateunknownНет
audioUrlstringНетдо 2048 симв.
giftIdstringНетдо 128 симв.
communityHandlestringНетдо 32 симв.
visibility"PUBLIC" | "FOLLOWERS" | "CLOSE_FRIENDS"Нетпо умолчанию "FOLLOWERS"
GET/api/social/stories/{storyId}

Вход: нужен

PATCH/api/social/stories/{storyId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
textstringНетдо 500 симв., может быть null
DELETE/api/social/stories/{storyId}

Вход: нужен · CSRF

GET/api/social/stories/{storyId}/comments

Вход: нужен

Параметры запроса: cursor, parentId, limit

POST/api/social/stories/{storyId}/comments

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
textstringДаот 1, до 500 симв.
parentIdstringНетдо 64 симв., может быть null
POST/api/social/stories/{storyId}/like

Вход: нужен · CSRF

POST/api/social/stories/{storyId}/reaction

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
emojistringНетот 1, до 32 симв., по умолчанию "❤️"
POST/api/social/stories/{storyId}/reply

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
textstringНетдо 1000 симв., по умолчанию ""
voiceUrlstringНетдо 2048 симв.
voiceDurationMsintegerНетот 0, до 60000, может быть null
POST/api/social/stories/{storyId}/view

Вход: нужен · CSRF

GET/api/social/stories/{storyId}/viewers

Вход: нужен

DELETE/api/social/stories/comments/{commentId}

Вход: нужен · CSRF

POST/api/social/stories/comments/{commentId}/like

Вход: нужен · CSRF

Актуальные истории#

GET/api/social/story-highlights

Вход: нужен

POST/api/social/story-highlights

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
titlestringДаот 1, до 40 симв.
storyIdsstring[]Даот 1, до 50 эл.
DELETE/api/social/story-highlights/{highlightId}

Вход: нужен · CSRF

Блокировки#

GET/api/social/blocks

Вход: нужен

Верификация#

GET/api/social/verification

Current user's latest verification request.

Вход: нужен

POST/api/social/verification

Submit a verification request: uploads the explainer video, then queues it for staff review.

Вход: нужен · CSRF · multipart/form-data

Возможные знакомые#

GET/api/social/people-you-may-know

Вход: нужен

Голос#

POST/api/social/voice/transcribe

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
voiceUrlstring (url)Дадо 2048 симв.

Жалобы#

POST/api/social/reports

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
targetTypenativeEnumДа
targetIdstringДаот 1, до 64 симв.
reasonstringДаот 1, до 500 симв.

Закладки#

GET/api/social/bookmarks

Закладки смотрящего.

Вход: нужен

Заметка профиля#

GET/api/social/note

Вход: нужен

PUT/api/social/note

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
textstringДаот 1, до 120 симв.
musicobjectНетпо умолчанию null
DELETE/api/social/note

Вход: нужен · CSRF

Заявки на подписку#

GET/api/social/follow-requests

Входящие заявки на подписку — список видит только сам владелец закрытого аккаунта.

Вход: нужен

POST/api/social/follow-requests/{requesterId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
action"accept" | "decline"Да

Звёзды#

GET/api/economy/stars/balance

Вход: нужен

POST/api/economy/stars/checkout

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
packIdstringДаот 1, до 64 симв.
provider"MONOBANK" | "CRYPTO"Да
cryptoAssetstringНетдо 16 симв.
cryptoNetworkstringНетдо 32 симв.
POST/api/economy/stars/gift

«Подарить звёзды»

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
usernamestringДаот 1, до 64 симв.
amountintegerДаот 1, до 1000000
POST/api/economy/stars/google/purchase

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
productIdstringДаот 1, до 128 симв.
purchaseTokenstringДаот 1, до 4096 симв.
transactionIdstringНетдо 256 симв., может быть null
GET/api/economy/stars/packs

Вход: нужен

GET/api/economy/stars/transactions

Вход: нужен

Параметры запроса: filter, cursor

Звонки#

POST/api/social/calls

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
usernamestringДаот 1, до 60 симв.
type"AUDIO" | "VIDEO"Да
POST/api/social/calls/{callId}/signal

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
kind"offer" | "answer" | "ice"Да
payloadunknownДа
POST/api/social/calls/{callId}/state

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
action"accept" | "decline" | "end"Да

Интеграции#

GET/api/integrations

Вход: нужен

GET/api/integrations/soundcloud/resolve

Вход: нужен

Параметры запроса: url

DELETE/api/integrations/spotify

Вход: нужен · CSRF

GET/api/integrations/spotify/authorize

Start of the PKCE flow.

Вход: нужен

GET/api/integrations/spotify/playlists

Вход: нужен

GET/api/integrations/spotify/playlists/{playlistId}

Вход: нужен

Истории (медиа)#

GET/api/stories/music/tiktok

Вход: нужен

Параметры запроса: q

Карты#

GET/api/maps/tile/{z}/{x}/{y}

Вход: не нужен

Каталог подарков#

POST/api/gifts/convert

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
giftIdstringДаот 1
POST/api/gifts/craft

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
targetVariantIdstringДаот 1, до 64 симв.
inputGiftIdsstring[]Даот 1, до 4 эл.
GET/api/gifts/craftable

Вход: нужен

POST/api/gifts/pin

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
giftIdstringДаот 1
POST/api/gifts/send

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
recipientUsernamestringДаот 1, до 64 симв.
variantIdstringДаот 1
messagestringНетдо 2000 симв., может быть null
isAnonymousbooleanНет
POST/api/gifts/unpin

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
giftIdstringДаот 1

Ключи шифрования#

GET/api/libunix/devices/{userId}

Вход: нужен

GET/api/libunix/keys

Вход: нужен

Параметры запроса: installationId

PUT/api/libunix/keys

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
installationIdstringДаот 8, до 64 симв.
identityKeyobjectДа
registrationIdintegerДаот 0, до 16383
signedPreKeyobjectДа
signedPreKey.keyIdintegerДаот 0
signedPreKey.publicKeyobjectДа
signedPreKey.signatureobjectДа
kyberLastResortPreKeyobjectДа
kyberLastResortPreKey.keyIdintegerДаот 0
kyberLastResortPreKey.publicKeyobjectДа
kyberLastResortPreKey.signatureobjectДа
preKeysobject[]Нетдо 100 эл., по умолчанию []
preKeys[].keyIdintegerДаот 0
preKeys[].publicKeyobjectДа
kyberPreKeysobject[]Нетдо 100 эл., по умолчанию []
kyberPreKeys[].keyIdintegerДаот 0
kyberPreKeys[].publicKeyobjectДа
kyberPreKeys[].signatureobjectДа
deviceNamestringНетдо 120 симв., может быть null
platformstringНетдо 32 симв., может быть null
GET/api/libunix/keys/{userId}/{deviceId}

Вход: нужен

Кому отправить#

GET/api/social/share-targets

Вход: нужен

Параметры запроса: q

Обновления (pts)#

GET/api/updates/difference

Вход: нужен

Параметры запроса: box, pts

GET/api/updates/state

Вход: нужен

Параметры запроса: box

Организации#

GET/api/organizations

«Мои организации»: свои организации, свой значок, цена создания.

Вход: нужен

POST/api/organizations

Создать организацию за 10 000 ⭐.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
nameobjectДа
glyphType"LETTER" | "EMOJI" | "SVG"Да
glyphstringДаот 1, до 16 симв.
glyphSvgstringНетдо 16000 симв., может быть null
glyphColor"AUTO" | "WHITE" | "BLACK"Нет
colorFromobjectДа
colorToobjectНетможет быть null
PATCH/api/organizations/{orgId}

Изменить название и значок своей организации.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
nameobjectДа
glyphType"LETTER" | "EMOJI" | "SVG"Да
glyphstringДаот 1, до 16 симв.
glyphSvgstringНетдо 16000 симв., может быть null
glyphColor"AUTO" | "WHITE" | "BLACK"Нет
colorFromobjectДа
colorToobjectНетможет быть null
GET/api/organizations/{orgId}/card

Карточка значка для листа у имени: название, владелец, сколько человек носит.

Вход: нужен

GET/api/organizations/{orgId}/members

Кто носит значок организации — только владельцу.

Вход: нужен

POST/api/organizations/{orgId}/members

Выдать значок по нику.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
usernamestringДаот 1, до 64 симв.
DELETE/api/organizations/{orgId}/members/{userId}

Отозвать значок у участника.

Вход: нужен · CSRF

POST/api/organizations/{orgId}/owners

Сделать участника совладельцем — 100 ⭐, не больше трёх владельцев.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
userIdstringДаот 1, до 64 симв.
DELETE/api/organizations/{orgId}/owners/{userId}

Снять права совладельца (значок остаётся).

Вход: нужен · CSRF

DELETE/api/organizations/membership

Снять с себя значок организации.

Вход: нужен · CSRF

Перевод#

POST/api/social/translate

Вход: нужен · CSRF

Подарки#

GET/api/social/gifts/{giftId}

Вход: нужен

GET/api/social/gifts/{giftId}/offers

List the gift's pending offers: the owner sees all of them, anyone else only their own.

Вход: нужен

POST/api/social/gifts/{giftId}/offers

Make a price offer on someone's collectible gift.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
amountStarsintegerДаот 1, до 1000000
durationHoursintegerНетот 6, до 72, по умолчанию 24
POST/api/social/gifts/{giftId}/pin

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
isPinnedbooleanДа
POST/api/social/gifts/{giftId}/sell

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
starsAmountintegerДаот 1, до 1000000
DELETE/api/social/gifts/{giftId}/sell

Снять с продажи.

Вход: нужен · CSRF

POST/api/social/gifts/{giftId}/status

Вход: нужен · CSRF

POST/api/social/gifts/{giftId}/transfer

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
toUsernamestringДаот 3, до 25 симв.
GET/api/social/gifts/{giftId}/upgrade

Вход: нужен

POST/api/social/gifts/{giftId}/upgrade

Telegram "upgrade": pay stars → the owned base gift becomes a unique with random model/pattern/backdrop.

Вход: нужен · CSRF

POST/api/social/gifts/{giftId}/visibility

Скрыть подарок из профиля или показать снова

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
hiddenbooleanДа
GET/api/social/gifts/collections

Вход: нужен

Параметры запроса: compact

GET/api/social/gifts/collections/{slug}/resale

Real resale listings for a collection + backdrop/model/pattern catalog with live counts.

Вход: нужен

POST/api/social/gifts/marketplace/{listingId}/buy

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
recipientUsernamestringНетот 1, до 64 симв., может быть null
POST/api/social/gifts/offers/{offerId}/accept

Seller accepts an offer: the gift transfers to the buyer and the seller is credited (minus fee).

Вход: нужен · CSRF

POST/api/social/gifts/offers/{offerId}/cancel

Buyer cancels their own pending offer: their escrowed stars are refunded.

Вход: нужен · CSRF

POST/api/social/gifts/offers/{offerId}/reject

Seller rejects an offer: the buyer's escrowed stars are refunded.

Вход: нужен · CSRF

Подписки#

GET/api/social/following/quick-access

Полоска подписок над лентой.

Вход: нужен

Пользователи (поиск)#

GET/api/users/{id}/gifts

Вход: нужен

Приглашения#

GET/api/referral

Вход: нужен

GET/api/referral/resolve

Кто стоит за кодом из ссылки — для строки «Вас пригласил …» на экране регистрации.

Вход: не нужен

Параметры запроса: code

Присутствие#

GET/api/social/presence

Вход: нужен

Параметры запроса: ids

POST/api/social/presence/heartbeat

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
onlinebooleanНетпо умолчанию true

Прогресс#

GET/api/progress

Вход: нужен

POST/api/progress/quests/{questId}/claim

Вход: нужен · CSRF

Продвижение#

GET/api/ads/config

Вход: нужен

POST/api/ads/reward/claim

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
sessionIdstringДаот 1, до 64 симв.
POST/api/ads/reward/session

Вход: нужен · CSRF

Секретные чаты#

GET/api/social/secret

The viewer's live secret chats — the device syncs this on start and after a push.

Вход: нужен

GET/api/social/secret/{id}

Вход: нужен

DELETE/api/social/secret/{id}

Вход: нужен · CSRF

POST/api/social/secret/{id}/accept

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
publicKeystringДаот 1, до 256 симв.
keyIdstringНетдо 32 симв., может быть null
GET/api/social/secret/{id}/messages

Вход: нужен

POST/api/social/secret/{id}/messages

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
ciphertextstringДаот 1, до 16384 симв.
silentbooleanНет
POST/api/social/secret/{id}/messages/delete

«Удалить у обоих» — шифротекст выбранных сообщений стирается с сервера.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
messageIdsstring[]Даот 1, до 100 эл.
POST/api/social/secret/{id}/read

Вход: нужен · CSRF

POST/api/social/secret/{id}/reject

Вход: нужен · CSRF

PATCH/api/social/secret/{id}/ttl

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
secondsintegerДадо 604800
POST/api/social/secret/{id}/typing

«печатает…» в секретном чате — только событие собеседнику.

Вход: нужен · CSRF

POST/api/social/secret/request

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
peerIdstringДаот 1, до 64 симв.
publicKeystringДаот 1, до 256 симв.

Серия#

GET/api/social/streak/check-in

Read the current user's streak.

Вход: нужен

POST/api/social/streak/check-in

Вход: нужен · CSRF

Серия (check-in)#

GET/api/streak/{chatId}

Вход: нужен

POST/api/streak/update

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
chatIdstringДаот 1

Состояние сервиса#

GET/api/health

Вход: не нужен

Стикеры#

GET/api/stickers/file

Sticker file proxy: streams the Telegram file.

Вход: не нужен

Параметры запроса: fileId, ext

GET/api/stickers/sets

Вход: нужен

Студия автора#

GET/api/creator/analytics

Вход: нужен

POST/api/creator/subscribe

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
creatorIdstringДаот 1, до 128 симв.
PUT/api/creator/subscription/price

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
priceStarsintegerДаот 1, до 1000000, может быть null

Точки входа#

GET/api/edges

Вход: не нужен

Уведомления#

GET/api/social/notifications

Вход: нужен

Параметры запроса: cursor

PATCH/api/social/notifications

Вход: нужен · CSRF

GET/api/social/notifications/preferences

Вход: нужен

PATCH/api/social/notifications/preferences

Вход: нужен · CSRF

GET/api/social/notifications/unread-count

Вход: нужен

Управление ботами#

GET/api/bots

Вход: нужен

POST/api/bots

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
displayNamestringДаот 1, до 64 симв.
aboutstringНетдо 120 симв.
descriptionstringНетдо 512 симв.
avatarUrlstringНетдо 2048 симв.
GET/api/bots/{botId}

Вход: нужен

PATCH/api/bots/{botId}

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
displayNamestringНетот 1, до 64 симв.
aboutstringНетдо 120 симв., может быть null
descriptionstringНетдо 512 симв., может быть null
avatarUrlstringНетдо 2048 симв., может быть null
commandsobject[]Нетдо 100 эл.
commands[].commandstringДаот 1, до 32 симв.
commands[].descriptionstringДадо 256 симв.
privacyModebooleanНет
canJoinGroupsbooleanНет
activebooleanНет
DELETE/api/bots/{botId}

Вход: нужен · CSRF

GET/api/bots/{botId}/revenue

Доход бота: сколько уже можно вывести, сколько ещё на удержании и когда откроется.

Вход: нужен

POST/api/bots/{botId}/token

Перевыпуск токена.

Вход: нужен · CSRF

POST/api/bots/{botId}/verification

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
notestringНетдо 500 симв., по умолчанию ""
POST/api/bots/{botId}/withdraw

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
amountStarsintegerДадо 1000000
GET/api/bots/check-username

Живая проверка ника в мастере создания.

Вход: нужен

Параметры запроса: username

Хештеги#

GET/api/social/hashtags/{tag}

Вход: нужен

Параметры запроса: cursor

GET/api/social/hashtags/top

Вход: нужен

Параметры запроса: limit

Черновики#

GET/api/social/drafts

Вход: нужен

Параметры запроса: community

POST/api/social/drafts

Вход: нужен · CSRF

PATCH/api/social/drafts/{draftId}

Вход: нужен · CSRF

DELETE/api/social/drafts/{draftId}

Вход: нужен · CSRF

Эмодзи#

GET/api/emoji/apple/{file}

Вход: не нужен

Эмодзи Telegram#

GET/api/telegram/custom-emojis

Вход: не нужен

Параметры запроса: ids

GET/api/telegram/custom-emojis/file

Вход: не нужен

Параметры запроса: fileId

Premium#

POST/api/premium/checkout

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
provider"MONOBANK" | "CRYPTO"Да
cryptoAssetstringНетдо 16 симв.
cryptoNetworkstringНетдо 32 симв.
GET/api/premium/features

Вход: не нужен

POST/api/premium/gift

«Подарить Premium» — a month of Unix Premium for another user, paid with the sender's stars.

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
usernamestringДаот 1, до 64 симв.
GET/api/premium/payment-methods

Вход: нужен

GET/api/premium/payments/{paymentId}

Вход: нужен

POST/api/premium/purchase

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
platform"ANDROID" | "IOS" | "WEB"Да
transactionIdstringДаот 3, до 256 симв.
receiptstringНетдо 20000 симв.
productIdstringНетдо 128 симв.
POST/api/premium/restore

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
platform"ANDROID" | "IOS" | "WEB"Нет
transactionIdstringНетот 3, до 256 симв.
receiptstringНетдо 20000 симв.
productIdstringНетдо 128 симв.
POST/api/premium/stars

Buy a month of Unix Premium for YOURSELF with the stars balance.

Вход: нужен · CSRF

GET/api/premium/status

Вход: нужен

Push-уведомления#

POST/api/mobile/push/register

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
tokenstringДаот 1
platform"ios" | "android"Да
deviceInfoobjectНет
POST/api/mobile/push/test

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
titlestringНетот 1, до 120 симв., по умолчанию "Тестовое уведомление"
bodystringНетот 1, до 300 симв., по умолчанию "Пуши настроены корректно."
routestringНетот 1, по умолчанию "/dashboard/notifications"
POST/api/mobile/push/unregister

Вход: нужен · CSRF

ПолеТипОбязательноОграничения
tokenstringНетот 16
platform"ios" | "android" | "web"Нет

Realtime-токен#

GET/api/unixproto/token

Вход: нужен

UnixProto Auth#

POST/api/unixproto-auth/handshake

Вход: не нужен · CSRF

ПолеТипОбязательноОграничения
clientPublicKeystringДаот 1
clientNoncestringДаот 1
dcIdintegerНет
deviceIdstringНетдо 200 симв.
appVersionstringНетдо 60 симв.
POST/api/unixproto-auth/rpc

Вход: не нужен · CSRF