tg_client WebSocket: Unified Domain Catalog
Всі запити перенесені з docs_ws_domain_core.html в категорійні блоки.
Для кожного action є параметри, відповідь, опис і приклад запиту.
Локально знайдено: 0
Глобальні Результати Документації
Індексація документації...
Збігів: 0
Session & Bootstrap (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
open_client | userbot_id | Починає стрім подій у цей WS (початково connected) | Підписує consumer на chat_list_updates для вказаного userbot. | |
get_active_sessions | userbot_id | get_active_sessions / get_active_sessions_error | Повертає активні Telegram-сесії поточного акаунта. У результаті є масив sessions, окремо current_session, other_sessions і inactive_session_ttl_days. Також приймається alias get_sessions. | |
terminate_session | userbot_id, session_id | terminate_session / terminate_session_error | Завершує конкретну Telegram-сесію за session_id. Також приймається alias delete_session. | |
set_session_settings | userbot_id, session_id, опц. can_accept_calls, can_accept_secret_chats | set_session_settings / set_session_settings_error | Оновлює налаштування конкретної сесії: приймати дзвінки і/або нові secret chats. Потрібно передати хоча б одне поле. Також приймається alias update_session_settings. | |
terminate_all_other_sessions | userbot_id | terminate_all_other_sessions / terminate_all_other_sessions_error | Завершує всі інші Telegram-сесії, крім поточної. Також приймається alias terminate_all_sessions. | |
get_chats | userbot_id, опц. chat_list | get_chats (один батч з items[]), або get_chats_error | Віддає список чатів з останнім повідомленням і метаданими одним батчем: count, chat_ids[], items[]. | |
get_recently_opened_chats | userbot_id, опц. limit | get_recently_opened_chats (потік елементів чату), або get_recently_opened_chats_error | Віддає нещодавно відкриті приватні чати (TDLib getRecentlyOpenedChats + фільтр chatTypePrivate). | |
Dialogs & Search (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
open_dialog | userbot_id, chat_id, опц. from_message_id, message_thread_id, limit, offset, center_message_id, window_before, window_after, pinned_limit | Потік: dialog_access, message, опц. pinned_message, pagination_setup, dialog_end; або dialog_empty/dialog_error | Завантажує історію чату/топіку, мапить у domain payload і надсилає порціями. dialog_access приходить першим і містить ефективні права поточного користувача для обмеження UI. Для окремого списку тем форуму використовуйте get_forum_topics. У message.sender.avatar приходить тільки meta фото відправника без auto-download. Для post/thread повідомлень може бути comments_meta з discussion_chat_id, message_thread_id, comment_count. | |
get_forum_topics | userbot_id, chat_id | get_forum_topics / get_forum_topics_error | Повертає окремим запитом список topic payload для forum/supergroup. Використовуйте для екрана списку тем замість побічного payload з open_dialog. | |
open_comments | userbot_id, comments_meta або discussion_chat_id + message_thread_id, опц. from_message_id, limit, offset, center_message_id, window_before, window_after, pinned_limit | Потік: dialog_access, comments_access, message, pagination_setup, dialog_end; або dialog_empty/dialog_error | Відкриває коментарі поста як окремий thread у discussion chat. comments_access дублює ефективні permission-дані для composer/comments UI та додатково містить discussion_chat_id і message_thread_id. | |
search_messages_in_chat | userbot_id, chat_id, опц. query, filter/search_filter, limit, from_message_id, offset, message_thread_id | search_messages_in_chat / search_messages_in_chat_error | Пошук повідомлень у чаті через TDLib searchChatMessages з підтримкою searchMessagesFilter* і поверненням повідомлень у форматі domain payload. | |
search_messages_global | userbot_id, опц. query, filter/search_filter, limit, offset_date, offset_chat_id, offset_message_id, chat_list | search_messages_global / search_messages_global_error | Глобальний пошук повідомлень по діалогах через TDLib searchMessages з підтримкою searchMessagesFilter* і поверненням нормалізованих message payload. | |
get_chat_recent_actions | userbot_id, chat_id, опц. query, from_event_id, limit, user_ids[], event_filters | get_chat_recent_actions / get_chat_recent_actions_error | “Недавні дії” (TDLib getChatEventLog) для каналу/супергрупи. Повертає сирі події логу та next_from_event_id для пагінації. Потребує прав адміністратора. | |
Messages CRUD (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
send_message | userbot_id, chat_id, text, опц. entities, media/media_items, reply_to | send_message / send_message_error | Відправляє текстове або media повідомлення в чат. Підтримує reply в інший чат через reply_to і альбоми через media_items. | |
send_comment | userbot_id, comments_meta або discussion_chat_id + message_thread_id, і той самий payload, що для send_message: text, entities, media, media_items, reply_to, reply_markup, options, ... | send_comment / send_comment_error | Відправляє повідомлення у comments thread поста в linked discussion chat. Підтримує файли, entities, albums і той самий набір send-полів, що й send_message. | |
reply_message | userbot_id, chat_id, reply_to_message_id, text | reply_message / reply_message_error | Відправляє reply на конкретний message. | |
edit_message | userbot_id, chat_id, message_id, text | edit_message / edit_message_error | Редагує повідомлення. | |
delete_messages | userbot_id, chat_id, message_ids[], опц. revoke | delete_messages / delete_messages_error | Видаляє один або кілька меседжів. | |
forward_message | userbot_id, to_chat_ids[], from_chat_id, message_ids[], опц. send_copy/without_sender, remove_caption/without_caption, new_caption, show_caption_above_media | forward_message / forward_message_error | Форвардить повідомлення в один або кілька чатів. Підтримує режим “без імені відправника” через send_copy і режим “без опису” через remove_caption. | |
pin_message | userbot_id, chat_id, message_id, опц. disable_notification, only_for_self | pin_message / pin_message_error | Закріплює message у чаті. | |
unpin_message | userbot_id, chat_id, message_id | unpin_message / unpin_message_error | Відкріплює message. | |
set_reaction | userbot_id, chat_id, message_id, reaction, опц. is_big, add_to_recent | set_reaction / set_reaction_error | Ставить реакцію на message через TDLib addMessageReaction (emoji/custom emoji/paid). | |
Media & Stickers (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
download_file | userbot_id, file_id, опц. source, chat_id, msg_id, message_thread_id, extra | download_file (ack), далі media_ready; або download_file_error | Запускає ручне завантаження файлу. Після готовності надсилає шлях/мета в media_ready. | |
get_prem_path | userbot_id, emoji_id | get_prem_path / get_prem_path_error | Повертає asset для premium/custom emoji. | |
get_custom_emoji_media | userbot_id, custom_emoji_ids[], опц. request_id | get_custom_emoji_media (ack), далі media_ready; або get_custom_emoji_media_error | Приймає масив custom emoji id, запускає їх завантаження і поступово надсилає окремі media_ready по кожному emoji. Використовуйте для видимих emoji зі sticker pack. | |
get_recent_stickers | userbot_id, опц. is_attached | get_recent_stickers / get_recent_stickers_error | Повертає нещодавні стікери через TDLib getRecentStickers. | |
get_stickers_pack | userbot_id, опц. query, limit, offset, with_lottie | get_stickers_pack / get_stickers_pack_error | Повертає згруповані паки емоджі/стікерів (включно з premium/recommended). Для visible custom emoji викликайте get_custom_emoji_media по items[].emoji_id, для regular stickers — download_file по items[].remote_id. Якщо with_lottie=true, asset-и custom emoji повертаються одразу в item. | |
Подія media_ready
media_ready — асинхронна WS-подія, яка приходить окремо від основної відповіді, коли бекенд вже підготував медіа і може віддати URL або asset.
{"userbot_id":1,"type":"media_ready","result":{...}}
Варіант 1: файл
{"userbot_id":1,"type":"media_ready","result":{"file_id":123456,"path":"https://...","kind":"avatar","remote_unique_id":"AQAD...","chat_id":"-1001234567890","msg_id":"555"}}
Базові поля: file_id, path, kind. Додатково можуть приходити remote_unique_id, chat_id, msg_id, user_id, message_thread_id, album_id, preview_index, preview_kind, preview_media_type, preview_type, preview_for_file_id, preview_for_file_format, preview_for_file_size, waveform, sticker_format, emoji, source.
Варіант 2: premium/custom emoji
{"userbot_id":1,"type":"media_ready","result":{"emoji_id":"5393021912655030923","kind":"custom_emoji","file_id":987654,"path":"https://...","emoji_webm":"https://...","is_lottie":false,"source":"custom_emoji_batch","request_id":"composer-emoji-pack","batch_index":1,"batch_total":2}}
Для custom emoji приходять emoji_id, kind=custom_emoji і або path/emoji_json_url з is_lottie=true, або path/emoji_webm з is_lottie=false. Додатково можливі file_id, chat_id, msg_id, message_thread_id, source, request_id, batch_index, batch_total.
Порядок завантаження: для файлів спочатку перевіряється кеш/клауд, і тільки потім — якщо для цього потоку дозволено автозавантаження — йде догрузка з TG. Поле path у media_ready — це URL на об'єкт у клауді; для public emoji/sticker bucket він може бути стабільним публічним URL, а для інших media — presigned URL.
Коли приходить:
download_file— після ручного завантаження файлу;get_chatsіget_recently_opened_chats— тільки для аватарок і preview;search_messages_in_chatіsearch_messages_global— тільки для аватарок і preview;open_dialog— для повного медіа та premium/custom emoji;get_custom_emoji_media— для пакетного завантаження custom emoji по масиву id, зокрема для видимих елементів зі sticker pack;
Profiles & Contacts (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
search_user | userbot_id, username | search_user / search_user_error | Пошук публічного чату/юзера за username. Підтримує і durov, і @durov. | |
search_chats_global | userbot_id, query (або title/username), опц. limit, wait_media_ready | search_chats_global / search_chats_global_error | Глобальний пошук чатів по title і username через TDLib searchChats, searchChatsOnServer і searchPublicChats. Повертає масив items у форматі chat-list. | |
create_private_chat | userbot_id, user_id (або tg_user_id), опц. force | create_private_chat / create_private_chat_error | Створює або повертає приватний чат через TDLib createPrivateChat. Повернений chat_id використовуйте далі в open_dialog. | |
create_supergroup_chat | userbot_id, title, опц. is_channel, description | create_supergroup_chat / create_supergroup_chat_error | Створює нову групу або канал через TDLib createNewSupergroupChat. Якщо is_channel=true, буде створено канал. | |
get_user | userbot_id, user_id | get_user / get_user_error | Повертає розширений профіль користувача: базові поля user, нормалізований parsed_status/last_seen, profile_photo і full_info. | |
get_chat_profile | userbot_id, chat_id | get_chat_profile / get_chat_profile_error | Повертає розширений профіль чату/каналу/групи: chat + chat_full_info, а також supergroup/basic_group (коли доступно), і profile_photo. | |
import_contacts | userbot_id, phone, опц. first_name, last_name, vcard, contact_user_id | import_contacts / import_contacts_error | Імпортує контакт через TDLib importContacts і повертає requested_contact + масив contacts з профілем для збереження на фронті. | |
set_name | userbot_id, first_name, опц. last_name (або full_name/name) | set_name / set_name_error | Змінює імʼя/прізвище поточного акаунта через TDLib setName. | |
set_bio | userbot_id, bio (або about) | set_bio / set_bio_error | Оновлює bio (About) поточного акаунта через TDLib setBio. Порожній рядок очищає bio. | |
set_username | userbot_id, username | set_username / set_username_error | Оновлює @username поточного акаунта через TDLib setUsername. Порожній рядок прибирає username. | |
set_birthdate | userbot_id, day, month, опц. year (або birthdate обʼєкт / null, опц. clear) | set_birthdate / set_birthdate_error | Оновлює день народження поточного акаунта через TDLib setBirthdate. Якщо рік не передано, використовується 0 (рік прихований). Для очищення дати передайте birthdate: null (або clear: true). | |
Folder CRUD & Chat Lists (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
create_chat_folder | userbot_id, title (або name), опц. icon_name/icon, color_id, is_shareable, pinned_chat_ids[], included_chat_ids[], excluded_chat_ids[], флаги include_*/exclude_* | create_chat_folder / create_chat_folder_error | Створює нову папку чатів через TDLib createChatFolder. | |
delete_chat_folder | userbot_id, chat_folder_id, опц. leave_chat_ids[] | delete_chat_folder / delete_chat_folder_error | Видаляє папку чатів через TDLib deleteChatFolder; опційно можна одночасно вийти з указаних чатів. | |
chat_in_folder | userbot_id, chat_id, chat_folder_id, опц. added/removed/pin/unpin | chat_in_folder / chat_in_folder_error | Керує членством чату у folder list. | |
get_chats_for_chat_folder_invite_link | userbot_id, chat_folder_id | get_chats_for_chat_folder_invite_link / get_chats_for_chat_folder_invite_link_error | Повертає список чатів, які можна включити в invite link папки (TDLib get_chats_for_chat_folder_invite_link). | |
get_chat_folder_invite_links | userbot_id, chat_folder_id | get_chat_folder_invite_links / get_chat_folder_invite_links_error | Повертає список існуючих invite links для папки (TDLib get_chat_folder_invite_links). | |
create_chat_folder_invite_link | userbot_id, chat_folder_id, опц. name, chat_ids[] (або chatIds[]) | create_chat_folder_invite_link / create_chat_folder_invite_link_error | Створює нове invite link для папки через TDLib create_chat_folder_invite_link. | |
edit_chat_folder_invite_link | userbot_id, chat_folder_id, invite_link, опц. name, chat_ids[] (або chatIds[]) | edit_chat_folder_invite_link / edit_chat_folder_invite_link_error | Редагує invite link папки через TDLib editChatFolderInviteLink. | |
delete_chat_folder_invite_link | userbot_id, chat_folder_id, invite_link | delete_chat_folder_invite_link / delete_chat_folder_invite_link_error | Видаляє invite link папки через TDLib deleteChatFolderInviteLink. | |
archive_chat | userbot_id, chat_id | archive_chat / archive_chat_error | Переміщає чат в архів. | |
unarchive_chat | userbot_id, chat_id | unarchive_chat / unarchive_chat_error | Повертає чат в main list. | |
pin_chat | userbot_id, chat_id, опц. is_pinned, chat_list | pin_chat / pin_chat_error | Закріплює або відкріплює чат у списку. | |
Privacy & Blocking (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
get_privacy_setting | userbot_id, setting (або privacy_setting) | get_privacy_setting / get_privacy_setting_error | Повертає поточні правила приватності для одного налаштування. Для user rules використовує TDLib getUserPrivacySettingRules, для “Повідомлення” — getNewChatPrivacySettings. | |
get_privacy_settings | userbot_id, опц. settings[] або CSV-рядок | get_privacy_settings / get_privacy_settings_error | Повертає набір privacy-налаштувань одним запитом (масив items + errors). | |
set_privacy_setting | userbot_id, setting, опц. mode, allow_user_ids/always_allow_user_ids, restrict_user_ids/never_allow_user_ids, allow_chat_ids, restrict_chat_ids, allow_premium_users, rules, allow_new_chats_from_unknown_users | set_privacy_setting / set_privacy_setting_error | Змінює privacy-правила. Підтримує базові режими (all/contacts/nobody) і винятки для користувачів/чатів, або повний масив TDLib rules. | |
block_user | userbot_id, user_id (або tg_user_id), опц. is_blocked, block_list | block_user / block_user_error | Блокує або розблоковує користувача через TDLib setMessageSenderBlockList. | |
unblock_user | userbot_id, user_id (або tg_user_id) | unblock_user / unblock_user_error | Видаляє користувача зі списку блокування через TDLib setMessageSenderBlockList з block_list=null. | |
get_blocked_users | userbot_id, опц. block_list, offset, limit | get_blocked_users / get_blocked_users_error | Повертає список заблокованих sender-ів через TDLib getBlockedMessageSenders з окремими масивами users і chats. | |
Chat/Channel Configuration (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
set_chat_title | userbot_id, chat_id, title | set_chat_title / set_chat_title_error | Змінює назву чату/каналу через TDLib setChatTitle. | |
set_chat_description | userbot_id, chat_id, description | set_chat_description / set_chat_description_error | Змінює опис чату/каналу через TDLib setChatDescription. | |
set_chat_permissions | userbot_id, chat_id, permissions | set_chat_permissions / set_chat_permissions_error | Змінює загальні дозволи учасників чату через TDLib setChatPermissions. Підтримує частковий payload і alias полів (can_send_messages, can_add_web_page_previews, can_manage_topics). | |
check_chat_username | userbot_id, chat_id, username | check_chat_username / check_chat_username_error | Перевіряє username для чату/каналу через TDLib checkChatUsername. | |
set_supergroup_username | userbot_id, chat_id (або supergroup_id), username | set_supergroup_username / set_supergroup_username_error | Змінює @username каналу/супергрупи через TDLib setSupergroupUsername. Порожній рядок робить чат приватним. | |
toggle_chat_has_protected_content | userbot_id, chat_id, has_protected_content | toggle_chat_has_protected_content / toggle_chat_has_protected_content_error | Вмикає/вимикає захист контенту (копіювання/пересилання) через TDLib toggleChatHasProtectedContent. | |
set_chat_slow_mode_delay | userbot_id, chat_id, slow_mode_delay (або delay) | set_chat_slow_mode_delay / set_chat_slow_mode_delay_error | Керує “повільним режимом” у чаті через TDLib setChatSlowModeDelay. 0 вимикає slow mode. | |
set_chat_direct_messages_group | userbot_id, chat_id, is_enabled, опц. paid_message_star_count (або star_count) | set_chat_direct_messages_group / set_chat_direct_messages_group_error | Керує блоком “Приймати повідомлення” в каналі через TDLib setChatDirectMessagesGroup: вмикає/вимикає прийом повідомлень і задає ціну в Stars за повідомлення. | |
set_chat_discussion_group | userbot_id, chat_id, discussion_chat_id | set_chat_discussion_group / set_chat_discussion_group_error | Прив’язує або відв’язує групу обговорення каналу через TDLib setChatDiscussionGroup. Для відв’язки передайте discussion_chat_id=0. | |
get_suitable_discussion_chats | userbot_id | get_suitable_discussion_chats / get_suitable_discussion_chats_error | Повертає список чатів, які підходять для прив’язки як група обговорення, через TDLib getSuitableDiscussionChats. | |
get_suitable_personal_chats | userbot_id | get_suitable_personal_chats / get_suitable_personal_chats_error | Повертає список каналів, які можна вибрати як “особистий канал”, через TDLib getSuitablePersonalChats. | |
set_personal_chat | userbot_id, chat_id | set_personal_chat / set_personal_chat_error | Встановлює канал як “особистий канал” через TDLib setPersonalChat. У відповіді додається item, зібраний через build_chat_item. | |
hide_personal_chat | userbot_id | hide_personal_chat / hide_personal_chat_error | Приховує “особистий канал” через TDLib setPersonalChat з chat_id=0. | |
Members & Moderation (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
get_chat_members | userbot_id, chat_id, опц. limit, offset, query, filter/member_filter | get_chat_members / get_chat_members_error | Повертає учасників чату з пагінацією. Для supergroup використовує getSupergroupMembers/searchChatMembers, для basic group — getBasicGroupFullInfo. | |
add_chat_member | userbot_id, chat_id, user_id (або tg_user_id), опц. forward_limit | add_chat_member / add_chat_member_error | Додає користувача в чат/канал через TDLib addChatMember. Для груп може використовувати forward_limit (скільки останніх повідомлень показати новому учаснику). | |
add_chat_members | userbot_id, chat_id, user_ids[] (або userids[]) | add_chat_members / add_chat_members_error | Додає кількох користувачів у чат/канал через TDLib addChatMembers одним запитом. | |
remove_chat_member | userbot_id, chat_id, user_id (або tg_user_id), опц. revoke_messages | remove_chat_member / remove_chat_member_error | Вилучає користувача з каналу/чату через TDLib setChatMemberStatus зі статусом chatMemberStatusBanned. | |
restore_chat_member | userbot_id, chat_id, user_id (або tg_user_id) | restore_chat_member / restore_chat_member_error | Відновлює користувачу можливість знову приєднатись (unban) через TDLib setChatMemberStatus зі статусом chatMemberStatusLeft. Не додає назад автоматично. | |
get_chat_join_requests | userbot_id, chat_id, опц. invite_link, query, offset_request, limit | get_chat_join_requests / get_chat_join_requests_error | Повертає запити на вступ через TDLib getChatJoinRequests. Для пагінації можна передавати останній елемент як offset_request. | |
process_chat_join_request | userbot_id, chat_id, user_id (або tg_user_id), опц. approve | process_chat_join_request / process_chat_join_request_error | Схвалює або відхиляє запит на вступ через TDLib processChatJoinRequest. | |
process_chat_join_requests | userbot_id, chat_id, опц. invite_link, approve | process_chat_join_requests / process_chat_join_requests_error | Схвалює або відхиляє всі заявки (або всі заявки конкретного invite link) через TDLib processChatJoinRequests. | |
get_chat_invite_link_members | userbot_id, chat_id, invite_link, опц. only_with_expired_subscription, offset_member, limit | get_chat_invite_link_members / get_chat_invite_link_members_error | Повертає користувачів, які приєдналися за конкретним invite link, через TDLib getChatInviteLinkMembers. Для пагінації можна передавати останній елемент як offset_member. | |
leave_chat | userbot_id, chat_id | leave_chat / leave_chat_error | Вихід із групи/каналу. | |
delete_chat | userbot_id, chat_id, опц. revoke, remove_from_chat_list | delete_chat / delete_chat_error | Очищає історію чату (і за параметрами прибирає зі списку). | |
delete_channel | userbot_id, chat_id (або channel_id як alias того ж chat_id), опц. revoke, remove_from_chat_list | delete_channel / delete_channel_error | Видаляє канал через TDLib deleteChatHistory; бекенд перевіряє, що вказаний чат є каналом. | |
Admins, Ownership & 2FA (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
add_chat_administrator | userbot_id, chat_id, user_id (або tg_user_id), опц. custom_title, rights, is_anonymous, can_be_edited | add_chat_administrator / add_chat_administrator_error | Призначає користувача адміністратором у каналі/групі через TDLib setChatMemberStatus з chatMemberStatusAdministrator. | |
remove_chat_administrator | userbot_id, chat_id, user_id (або tg_user_id) | remove_chat_administrator / remove_chat_administrator_error | Знімає адмінські права і повертає користувача до звичайного учасника через TDLib setChatMemberStatus з chatMemberStatusMember. | |
transfer_chat_ownership | userbot_id, chat_id, user_id (або tg_user_id), password (або current_password) | transfer_chat_ownership / transfer_chat_ownership_error | Передає право власника каналу/групи іншому адміністратору через TDLib transferChatOwnership. Потрібен пароль 2FA поточного власника. | |
get_transfer_ownership_state | userbot_id | get_transfer_ownership_state / get_transfer_ownership_state_error | Об’єднує перевірки TDLib getPasswordState і canTransferOwnership в один запит для UI блоку перевірки безпеки. | |
get_password_state | userbot_id | get_password_state / get_password_state_error | Повертає стан 2FA через TDLib getPasswordState: чи увімкнений пароль, password_hint, стан recovery email. | |
verify_2fa_password | userbot_id, password (або current_password) | verify_2fa_password / verify_2fa_password_error | Перевіряє валідність поточного 2FA-пароля через TDLib getRecoveryEmailAddress (без зміни налаштувань). | |
change_2fa_password | userbot_id, current_password (або old_password/password), new_password, опц. new_hint, set_recovery_email_address, new_recovery_email_address | change_2fa_password / change_2fa_password_error | Змінює 2FA-пароль через TDLib setPassword. Повертає оновлений password_state. | |
disable_2fa_password | userbot_id, current_password (або password) | disable_2fa_password / disable_2fa_password_error | Вимикає 2FA-пароль через TDLib setPassword з порожнім new_password. | |
change_2fa_recovery_email | userbot_id, current_password (або password), new_recovery_email_address (або recovery_email_address/email) | change_2fa_recovery_email / change_2fa_recovery_email_error | Змінює recovery email для 2FA через TDLib setRecoveryEmailAddress. Якщо пошта нова, потрібне підтвердження на email. | |
Supergroup / Channel Toggles (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
toggle_supergroup_sign_messages | userbot_id, chat_id (або supergroup_id), sign_messages, опц. show_message_sender | toggle_supergroup_sign_messages / toggle_supergroup_sign_messages_error | Перемикає підпис повідомлень у каналі/супергрупі через TDLib toggleSupergroupSignMessages. Якщо show_message_sender не передано, бекенд збереже поточне значення. | |
toggle_supergroup_is_all_history_available | userbot_id, chat_id (або supergroup_id), is_all_history_available | toggle_supergroup_is_all_history_available / toggle_supergroup_is_all_history_available_error | Керує видимістю старої історії для нових учасників у супергрупі через TDLib toggleSupergroupIsAllHistoryAvailable. | |
toggle_supergroup_is_forum | userbot_id, chat_id (або supergroup_id), is_forum | toggle_supergroup_is_forum / toggle_supergroup_is_forum_error | Вмикає/вимикає режим гілок (forum topics) у супергрупі через TDLib toggleSupergroupIsForum. | |
Invite Links (CRUD) (0)
| Action | Що приймає | Що повертає | Що робить | Приклад action |
|---|---|---|---|---|
check_chat_invite_link | userbot_id, invite_link (або link/url) | check_chat_invite_link / check_chat_invite_link_error | Перевіряє Telegram-лінк чату. Для invite links використовує TDLib checkChatInviteLink; якщо chat_id уже відомий, бек додатково звіряє актуальну публічність через свіжий getChat. Якщо відповідь застаріла або без chat_id, бек робить best-effort refresh через searchChatsOnServer за exact title. Для публічних t.me/username або @username резолвить чат через searchPublicChat. Якщо chat_id усе одно недоступний, у відповіді повертається chat_id_unavailable_reason. | |
join_chat_by_invite_link | userbot_id, invite_link (або link/url) | join_chat_by_invite_link / join_chat_by_invite_link_error | Приєднує поточного користувача до чату за Telegram-посиланням. Для invite links використовує TDLib joinChatByInviteLink, для публічних t.me/username лінків резолвить чат і викликає joinChat. У відповіді повертає joined, join_request_sent, а також chat і item, якщо чат уже доступний. | |
get_chat_invite_links | userbot_id, chat_id, опц. creator_user_id, is_revoked, offset_date, offset_invite_link, limit | get_chat_invite_links / get_chat_invite_links_error | Повертає список запрошувальних посилань через TDLib getChatInviteLinks. Якщо creator_user_id не передано, бекенд підставляє поточного користувача через getMe. | |
create_chat_invite_link | userbot_id, chat_id, опц. name, expiration_date, member_limit, creates_join_request | create_chat_invite_link / create_chat_invite_link_error | Створює нове invite link через TDLib createChatInviteLink. | |
create_chat_subscription_invite_link | userbot_id, chat_id, опц. name, subscription_pricing (або subscription_period + subscription_star_count) | create_chat_subscription_invite_link / create_chat_subscription_invite_link_error | Створює платне invite link через TDLib createChatSubscriptionInviteLink (Stars subscription для каналу). | |
edit_chat_invite_link | userbot_id, chat_id, invite_link, опц. name, expiration_date, member_limit, creates_join_request | edit_chat_invite_link / edit_chat_invite_link_error | Редагує invite link через TDLib editChatInviteLink. | |
edit_chat_subscription_invite_link | userbot_id, chat_id, invite_link, опц. name | edit_chat_subscription_invite_link / edit_chat_subscription_invite_link_error | Редагує платне invite link через TDLib editChatSubscriptionInviteLink (назва посилання). | |
revoke_chat_invite_link | userbot_id, chat_id, invite_link | revoke_chat_invite_link / revoke_chat_invite_link_error | Відкликає invite link через TDLib revokeChatInviteLink. | |
replace_primary_chat_invite_link | userbot_id, chat_id | replace_primary_chat_invite_link / replace_primary_chat_invite_link_error | Генерує нове primary invite link через TDLib replacePrimaryChatInviteLink. | |
delete_revoked_chat_invite_link | userbot_id, chat_id, invite_link | delete_revoked_chat_invite_link / delete_revoked_chat_invite_link_error | Видаляє відкликане invite link зі списку через TDLib deleteRevokedChatInviteLink (якщо підтримується версією TDLib). | |
delete_all_revoked_chat_invite_links | userbot_id, chat_id, опц. creator_user_id | delete_all_revoked_chat_invite_links / delete_all_revoked_chat_invite_links_error | Видаляє всі відкликані invite links для одного адміністратора через TDLib deleteAllRevokedChatInviteLinks. Якщо creator_user_id не передано, бекенд підставляє поточного користувача через getMe. | |