Функции API Telegram

Функции API существенно расширяют возможности работы бота в Telegram. С помощью использования функций API можно работать с вложениями, с группами и чатами в Telegram, например, автоматизируя блокировку или разблокировку пользователей и многое другое!

Первоисточник: Telegram bot API

Важно!

Для понимания работы с функциями API настоятельно рекомендуем ознакомиться с правилами указания функций и параметров в калькуляторе.

ОБОЗНАЧЕНИЯ:

! - восклицательным знаком обозначаются обязательные параметры

параметр=None - так указывается значение по умолчанию для обозначенного параметра,

неправильно просто копировать текст функции из документации tg_send_message(platform_id, "Какой то текст", client_message_id=61818138, reply_markup=None, parse_mode=None, disable_web_page_preview=0, protect_content=False)

После знаков равно указаны значения по умолчанию для каждого параметра, следовательно, если Вам не нужен тот или иной параметр, но нужен какой-либо из последующих, то нельзя просто опустить его - следует указать вместо него значение по умолчанию для данного параметра.

Таким образом, правильным будет ввод: tg_send_message(platform_id, "Какой то текст", 61818138, None, None, 0, True)

Где взять platform_id для отправки уведомлений?

• У вас должен быть подключен телерам-бот к проекту

• В этого бота нужно прислать любое сообщение с того Telegram-аккаунта, куда должны приходить сообщения

• В списке клиентов проекта выбираете диалог клиента, которому будете отправлять заявки

• Копируете значение ID в мессенджере

Пример передачи параметра platform_id

1. параметр platform_id можно передавать без указания числовых значений:

platform_id передан без указания значений

react = tg_set_reaction(platform_id, 1556, '👌')

Функции с параметром будет отрабатывать без указания значения platform_id.

Важно! Параметр в большинстве функций является обязательным и пропускать его нельзя.

1. Если Вам необходимо использовать функцию в определенном чате, канале, группе, то понадобится передать platform_id с числовым значением:

В функции tg_send_message(!platform_id, !text) на примере выше параметр platform_id передан с помощью кавычек, в которых вложено числовое значение:

tgmess = tg_send_message('1234566788', 'Привет!')

Как прописывать кнопки в параметре reply_markup

Пример reply-кнопок:

opts = {"keyboard": [[{"text": "Налево"}, {"text": "Направо"}]]}

Пример inline-кнопок:

opts = {"inline_keyboard": [[{"text": "Пакет 1","callback_data":1}, {"text": "Пакет 2","callback_data":2}]]}

Как использовать разметку текста (markdown) в параметре parse_mode?

Параметр parse_mode выделяет весь текст/его часть курсивом или жирным шрифтом. Может иметь значения html, markdown, markdownV2.

1. Если выбираете html:

для жирного шрифта используете "<b>caption</b>"

для курсива "<i>caption</i>"

1. Для Markdown:

для жирного шрифта используете "*caption*"

для курсива "_caption_"

Пример отправки курсивного текста: tg_send_message(47615196, "<i>курсив</i>",None,None,"html")

Пример отправки жирного текста: tg_send_message(platform_id, '*test*', None, None, 'markdown')

Список доступных функций

some_client_in_list(list_id, recepient) – проверка состоит ли участник чата в определенном списке

tg_answer_callback_query(callback_query_id, text) – показ пользователю Alert-уведомления

tg_approve_chat_join_request(chat_id, user_id) - принять заявку и добавить пользователя в канал/чат

tg_ban_chat_member(chat_id, user_id, hours) – блокировка (бан) подписчика чата/канала

tg_ban_chat_sender_chat(platform_id, sender_chat_id) – отправка в бан группы

tg_callback_url_open(callback_query_id, url) – установка реакции на callback-кнопку с переходом в бота с тэгом

tg_chat_permission(platform_id, permission, media_permissions) – установка общих ограничений для обычных пользователей чата или отдельных пользователей

tg_close_forum_topic(platform_id, message_thread_id) – закрытие доп.темы

tg_close_general_forum_topic(platform_id) – закрытие Главной темы

tg_copy_message(platform_id, from_chat_id, message_id, reply_to_message_id, reply_markup, parse_mode, protect_content, disable_notification, message_thread_id ) – копирование сообщения

tg_create_chat_invite_link(platform_id, member_limit, hours, request,name) – создание ссылки на вступление в чат

tg_create_forum_topic(platform_id, name, icon, icon_color) – создание доп.темы

tg_decline_chat_join_request(chat_id, user_id) – отклонить заявку в канал/чат

tg_delete_chat_photo(platform_id) – удаление аватарки на группу/чат

tg_delete_command(language, scope, platform_id, user_id) – удаление команд бота

tg_delete_forum_topic(platform_id, message_thread_id) - удалить доп.тему со всеми сообщениями

tg_delete_message(platform_id, message_id) - удаление сообщения

tg_edit_forum_topic(platform_id, message_thread_id, name, icon) – переименование и/или смена эмодзи доп.темы

tg_edit_general_forum_topic(platform_id, topic_name) – переименование Главной темы группы

tg_edit_message_caption(platform_id, message_id, caption, reply_markup, parse_mode) – редактирование описания

tg_edit_message_media(platform_id, message_id, media, reply_markup) – редактирование медиавложений

tg_edit_message_reply_markup(platform_id, message_id, reply_markup) – редактирование инлайн-клавиатуры в сообщении

tg_edit_message_text(platform_id, message_id, text, reply_markup, parse_mode, disable_web_page_preview) – редактирование текста в сообщении

tg_export_chat_link(platform_id) - сделать неактивными все существующие ссылки и заменить их на одну

tg_forward_message(platform_id, from_chat_id, message_id, protect_content, disable_notification, message_thread_id) - пересылка сообщения

tg_get_bot_description(language_code) - Получение текущего описания

tg_get_bot_short_description(language_code) - Получение текущего краткого описания

tg_get_chat_member(chat_id, user_id) – проверка наличия подписки

tg_get_chat_member_count(platform_id) – определение числа участников чата/канала

tg_get_command(language, scope, platform_id, user_id) – просмотр команд бота

tg_get_forum_icon() – получить список эмодзи для Темы

tg_hide_general_forum_topic(platform_id) – скрыть Главную тему

tg_pin_chat_message(platform_id, message_id, disable_notification) – как закрепить сообщение в чате/канале

tg_promote_user(platform_id, user_id, promote_options_list) - настройка прав пользователя / повышение до администратора в супер-группе или канале в Telegram

tg_reopen_forum_topic(platform_id, message_thread_id) – открыть ранее закрытую доп.тему

tg_reopen_general_forum_topic(platform_id) – открытие ранее закрытой Главной темы

tg_restrict_chat_member(platform_id, user_id, minutes, permission, media_permissions) – установка персональных ограничений для обычных пользователей чата или для отдельных пользователей

tg_revoke_chat_invite_link(platform_id, invite_link) – удаление ссылки на вступление в чат

tg_send_animation(platform_id, animation, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, has_spoiler, disable_notification, message_thread_id) – отправка анимации

tg_send_chat_action(platform_id, bot_action, message_thread_id ) – показ пользователю действий бота (печатает / выбирает стикер и т.д.)

tg_send_contact(platform_id, phone, first_name, last_name, protect_content, disable_notification, reply_to_message_id, reply_markup, message_thread_id) – отправка контакта

tg_send_dice(platform_id, emoji, reply_markup, disable_notification, reply_to_message_id, protect_content, message_thread_id) – отправка эмодзи со случайным выбором (Dice)

tg_send_document(platform_id, document, caption, reply_markup, parse_mode,reply_to_message_id, protect_content, disable_notification, message_thread_id) – отправка документа

tg_send_message(platform_id, text,client_message_id, reply_markup, parse_mode, disable_web_page_preview, protect_content, disable_notification, message_thread_id) – отправка сообщения

tg_send_message_1(token, platform_id, text, client_message_id, reply_markup, parse_mode, disable_web_page_preview, protect_content, disable_notification, message_thread_id) – отправка сообщения с указанием конкретного бота

tg_send_photo(platform_id, photo, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, has_spoiler, disable_notification, message_thread_id) – отправка картинки

tg_send_poll(platform_id, question, options, is_anonymous, allows_multiple_answers, reply_markup, disable_notification, protect_content, token, reply_to_message_id, message_thread_id ) – создание опроса

tg_send_quiz_poll(platform_id, question, options, explanation, correct_option_id, is_anonymous, reply_markup, parse_mode, protect_content, disable_notification, token, reply_to_message_id, message_thread_id ) – создание викторины

tg_send_some_audio(platform_id, audio_list, disable_notification, reply_to_message_id, message_thread_id) – отправка нескольких аудио

tg_send_some_document(platform_id, document_list, disable_notification, reply_to_message_id, message_thread_id) – отправка нескольких документов

tg_send_some_photo(platform_id, image_list, disable_notification=0, protect_content=False, reply_to_message_id=0, has_spoiler=False,message_thread_id) – отправка нескольких картинок

tg_send_some_video(platform_id, video_list, disable_notification, protect_content, reply_to_message_id, has_spoiler, message_thread_id) – отправка нескольких видео

tg_send_sticker(platform_id, sticker_id, protect_content, disable_notification, reply_to_message_id, reply_markup, message_thread_id) – отправка стикера

tg_send_venue(platform_id, latitude, longitude, title, address, protect_content, disable_notification, reply_to_message_id, reply_markup, message_thread_id) – отправка геоточки

tg_send_video(platform_id, video, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, has_spoiler, disable_notification, message_thread_id) – отправка видео

tg_send_video_note(platform_id, video_note, reply_markup, protect_content, reply_to_message_id, disable_notification, message_thread_id) – отправка круглого видео

tg_send_voice(platform_id, voice, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, disable_notification, message_thread_id) – отправка голосового сообщения

tg_set_administrator_title(platform_id, user_id, title) – изменение титула администратора с помощью бота

tg_set_bot_description(description, language_code) - Установка приветственного сообщения

tg_set_bot_short_description(description, language_code) - Установка описания для превью ссылки

tg_set_chat_description(platform_id, description) – смена описания чата через бот

tg_set_chat_photo(platform_id, photo) – установка аватарки на группу/чат

tg_set_command(commands, language, scope, platform_id, user_id) – установка команд бота

tg_set_group_title(platform_id, title) – смена имени чата через бот

tg_stop_poll(platform_id, message_id) – завершение опроса

tg_unban_chat_member(chat_id, user_id) - разблокировка (разбан) подписчика чата/канала

tg_unban_chat_sender_chat(platform_id, sender_chat_id) – снятие бана с группы

tg_unhide_general_forum_topic(platform_id) – отобразить Главную тему

tg_unpin_all(platform_id) – как открепить все закрепленные сообщения

tg_unpin_chat_message(platform_id, message_id) – как открепить сообщение в чате/канале

tg_unpin_topic_messages(platform_id, message_thread_id) - открепить все собщения доп.темы