Telegram api что это
Введение в Telegram API
Дата публикации Oct 24, 2017
Telegramэто сервис обмена мгновенными сообщениями, такой же, как WhatsApp, Facebook Messenger и WeChat. В последние годы он приобрел популярность по разным причинам: его некоммерческий характер, кроссплатформенная поддержка, обещания безопасности¹, и этооткрытые API,
В этом посте мы будем использоватьТелемарафонклиентская библиотека Python для Telegram API для подсчета количества сообщений в каждом из наших чатов Telegram.
API Telegram
Наиболее известным из API Telegram является его API-интерфейс Bot, API-интерфейс на основе HTTP для разработчиков, взаимодействующих с бот-платформой. Bot API позволяет разработчикам управлять ботами Telegram, например, получать сообщения и отвечать другим пользователям.
Помимо Bot API, есть и сам Telegram API. Это API, используемый приложениями Telegram для всех ваших действий в Telegram. Чтобы назвать несколько: просмотр ваших чатов, отправка и получение сообщений, изменение изображения на дисплее или создание новых групп. С помощью Telegram API вы можете делать все, что можете, в приложении Telegram программно.
Telegram API намного сложнее, чем Bot API. Вы можете получить доступ к API-интерфейсу бота через HTTP-запросы со стандартными полезными нагрузками JSON, формы или строки запроса, в то время как Telegram API использует собственный формат полезной нагрузки и протокол шифрования.
Telegram API
Тип Язык
Telegram API основан на RPC, поэтому взаимодействие с API включает отправку полезной нагрузки, представляющей вызов функции, и получение результата. Например, чтение содержимого разговора включает вызов messages.getMessage функция с необходимыми параметрами и получения messages.Messages в ответ.
Пример TL-схемы (сначала объявляются типы, за которыми следуют функции с разделителем):
Вызов функции TL и результат с использованием функций и типов из вышеуказанной схемы TL, а также эквивалентное двоичное представление (изофициальная документация):
Слои TL-схемы
Версия Telegram API имеет версии с использованием слоев TL-Schema; каждый слой имеет уникальную TL-схему. Веб-сайт Telegram содержит текущую TL-схему и предыдущие уровни вhttps://core.telegram.org/schema,
Начиная
Создание приложения Telegram
Вам нужно будет получить api_id а также api_hash взаимодействовать с Telegram API. Следуйте инструкциям из официальной документации здесь:https://core.telegram.org/api/obtaining_api_id,
Вам придется посетитьhttps://my.telegram.org/войдите под своим номером телефона и кодом подтверждения, который будет отправлен в Telegram, и заполните форму в разделе «Инструменты разработки API», указав название приложения и короткое имя. После этого вы можете найти свой api_id а также api_hash в том же месте.
Кроме того, в тех же инструкциях упоминается, что вы можете использовать образцы учетных данных, которые можно найти в исходных кодах Telegram для тестирования. Для удобства я буду использовать учетные данные, которые я нашел вИсходный код Telegram Desktop на GitHubв примере кода здесь.
Установка Telethon
Вы можете установить Telethon с pip :
Использовать pip соответствует вашему интерпретатору Python 3; это может быть pip3 вместо. (Случайно: недавно была выпущена Ubuntu 17.10, и она использует Python 3 в качестве установки Python по умолчанию.)
Создание клиента
Прежде чем вы сможете начать взаимодействовать с Telegram API, вам нужно создать клиентский объект с вашим api_id а также api_hash и подтвердите его с вашим номером телефона. Это похоже на вход в Telegram на новом устройстве; вы можете представить этого клиента как еще одно приложение Telegram
Ниже приведен код для создания и аутентификации объекта клиента, модифицированный из документации Telethon:
Как упоминалось ранее, api_id а также api_hash выше взяты из исходного кода Telegram Desktop. Введите свой номер телефона в phone переменная.
Если клиент был создан и аутентифицирован успешно, объект, представляющий себя, должен быть напечатан на консоли. Это будет похоже на (эллипсы … означает, что какой-то контент был пропущен)
Теперь вы можете использовать этот клиентский объект, чтобы начать делать запросы к Telegram API.
Работа с Telegram API
Проверка TL-схемы
Как упоминалось ранее, использование Telegram API включает вызов доступных функций в TL-схеме. В этом случае мы заинтересованы в messages.GetDialogs функция. Мы также должны принять к сведению соответствующие типы в аргументах функции. Вот подмножество TL-схемы, которую мы будем использовать для выполнения этого запроса:
Использование документации Telethon
К счастью, документация Telethon дает более подробную информацию о том, как мы можем вызвать эту функцию. Отhttps://lonamiwebs.github.io/Telethon/index.html, если вы введете getdialogs в поле поиска, вы увидите результат для метода с именем GetDialogsRequest (Функции TL-схемы представлены *Request объекты в Telethon).
Документация для GetDialogsRequest указывает тип возвращаемого значения для метода, а также чуть более подробную информацию о параметрах. Кнопка «Копировать импорт в буфер обмена» особенно полезна, когда мы хотим использовать этот объект, как сейчас.
Сделать запрос
Вот наш законченный GetDialogsRequest и как получить его результат, передав его нашему авторизованному клиентскому объекту:
В моем случае я получил обратно DialogsSlice объект, содержащий список диалогов, сообщений, чатов и пользователей, как мы и ожидали на основе TL-схемы:
Получение DialogsSlice вместо того Dialogs означает, что не все мои диалоги были возвращены, но count Атрибут говорит мне, сколько диалогов у меня всего. Если у вас меньше определенного количества разговоров, вы можете получить Dialogs вместо объекта, и в этом случае все ваши диалоги были возвращены, а количество диалогов у вас есть только длина векторов.
терминология
Терминология, используемая Telegram API, может иногда немного сбивать с толку, особенно из-за недостатка информации, кроме определений типов. Что такое «диалоги», «сообщения», «чаты» и «пользователи»?
Например, если моя история чата была этим скриншотом, я взял изПриложение Telegram в магазине Play:
dialogs будет содержать разговоры на скриншоте: Старые Пираты, Пресс-центр, Моника, Джайна…
chats будет содержать записи для Old Pirates, Press Room и Meme Factory.
messages будет содержать сообщения «Все на борту!» из «Старых пиратов», «Ух ты, приятное упоминание!» из пресс-зала, сообщение, представляющее отправленную фотографию Монике, сообщение, представляющее ответ Джайны, и так далее.
users будет содержать запись для Эшли с тех пор, как она отправила последнее сообщение в пресс-центр, Монику, Джайну, Кейт и Уинстон с тех пор, как он отправил последнее сообщение на Фабрику мемов.
(Я еще не работал с секретными чатами через Telegram API, поэтому я не уверен, как они обрабатываются.)
Подсчет сообщений
Управление данными ответа
Чтобы посчитать количество сообщений в каждом из наших разговоров, нам нужно сделать GetHistoryRequest для этого разговора с соответствующими InputPeer для этого разговора.
Все соответствующие InputPeer конструкторы принимают то же самое id а также access_hash параметров, но в зависимости от того, является ли разговор индивидуальным чатом, группой или каналом, эти значения находятся в разных местах GetDialogsRequest ответ:
В псевдокоде имеем:
Библиотека магии
Telethon имеет несколько вспомогательных функций для упрощения общих операций. На самом деле мы могли бы сделать вышеупомянутое с двумя из этих вспомогательных методов, client.get_dialogs() а также client.get_message_history() вместо:
Однако я чувствовал, что лучше сначала изучать методы API-интерфейса Telegram напрямую, тем более что не существует вспомогательного метода для всего. Тем не менее, есть некоторые вещи, которые намного проще с помощью вспомогательных методов, например, как мы аутентифицировали нашего клиента в начале, или такие действия, как загрузка файлов, которые в противном случае были бы утомительными.
Завершение
С API Telegram вы можете сделать гораздо больше, особенно с точки зрения аналитики. Я начал изучать его, подумав об одном из моих старых проектов, чтобы попытаться создать визуализацию данных из экспортированных историй чата WhatsApp:https://github.com/yi-jiayu/chat-analytics,
Используя регулярные выражения для анализа истории чата в виде простого текста, я мог создать диаграмму, аналогичную графику хранилища перфокарт GitHub, показывающую, в какое время недели чат был наиболее активным:
Однако использование функции «Чат по электронной почте» для экспорта было довольно хакерским, и вам нужно было вручную экспортировать историю разговоров для каждого чата, и это будет устаревшим, как только вы получите новое сообщение. Я не стал продвигать проект дальше, но я всегда думал, что другие истории могут быть извлечены из истории чатов.
Благодаря программному доступу к истории чатов, с чатами Telegram можно сделать гораздо больше. Методы, такие как messages.search может мне исключительно полезно. Возможно, динамически генерировать статистику по разговорам, которые достигают максимума или затухают, или которые постоянно активны, или находят ваши любимые смайлики или самые распространенные н-граммы? Предел неба (или ограничение скорости API, в зависимости от того, что ниже).
Обновления
(2017–10–25 09:45 SGT) Изменен подсчет сообщений для пропуска неожиданных диалогов
Telegram APIs
We offer two kinds of APIs for developers. The Bot API allows you to easily create programs that use Telegram messages for an interface. The Telegram API and TDLib allow you to build your own customized Telegram clients. You are welcome to use both APIs free of charge.
You can also add Telegram Widgets to your website.
This API allows you to connect bots to our system. Telegram Bots are special accounts that do not require an additional phone number to set up. These accounts serve as an interface for code running somewhere on your server.
To use this, you don’t need to know anything about how our MTProto encryption protocol works — our intermediary server will handle all encryption and communication with the Telegram API for you. You communicate with this server via a simple HTTPS-interface that offers a simplified version of the Telegram API.
Bot developers can also make use of our Payments API to accept payments from Telegram users around the world.
Even if you’re looking for maximum customization, you don’t have to create your app from scratch. Try our Telegram Database Library (or simply TDLib), a tool for third-party developers that makes it easy to build fast, secure and feature-rich Telegram apps.
TDLib takes care of all network implementation details, encryption and local data storage, so that you can dedicate more time to design, responsive interfaces and beautiful animations.
TDLib supports all Telegram features and makes developing Telegram apps a breeze on any platform. It can be used on Android, iOS, Windows, macOS, Linux and virtually any other system. The library is open source and compatible with virtually any programming language.
This API allows you to build your own customized Telegram clients. It is 100% open for all developers who wish to create Telegram applications on our platform. Feel free to study the open source code of existing Telegram applications for examples of how things work here. Don’t forget to register your application in our system.
How to get your application identifier and create a new Telegram app.
How to register a user’s phone to start using the API.
How to login to a user’s account if they have enabled 2FA, how to change password.
How to handle API return errors correctly.
How to connect to the closest DC access point for faster interaction with the API, and things to watch out for when developing a client.
How to subscribe to updates and handle them properly.
How to subscribe and handle them properly.
How to handle channels, supergroups, groups, and what’s the difference between them.
Telegram offers detailed channel statistics for channels and supergroups.
Additional options for calling methods.
How to transfer large data batches correctly.
How to fetch results from large lists of objects.
The MTProto API has multiple client configuration parameters that can be fetched with the appropriate methods.
Important checks required in your client application.
Binding temporary authorization key to permanent ones.
Ways to boost API interactions.
A list of available high-level methods.
Text and JSON-presentation of types and methods used in API.
A list of available schema versions.
How to work with bots using the MTProto API.
Bots offer a set of commands that can be used by users in private, or in a chat.
Users can interact with your bot via buttons or even inline buttons, straight from inline messages in any chat.
Users can interact with your bot via inline queries, straight from the text input field in any chat.
Bots can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats; how to work with games in the MTProto API.
Telegram allows applying detailed message filters while looking for messages in chats. This allows the server to filter messages based on a text query, and even on their type, and this feature is often used by graphical clients to implement features like the chat gallery, chat profile pictures and more.
Telegram allows sending polls and quizes, that can be voted on by thousands, if not milions of users in chats and channels.
How to handle admin permissions, granular bans and global permissions in channels, groups and supergroups.
Groups can be associated to a channel as a discussion group, to allow users to discuss about posts.
Telegram allows commenting on a channel post or on a generic group message, thanks to message threads.
Both supergroups and channels offer a so-called admin log, a log of recent relevant supergroup and channel actions, like the modification of group/channel settings or information on behalf of an admin, user kicks and bans, and more.
Telegram allows pinning multiple messages on top of a specific chat.
Telegram allows mentioning other users in case of urgent duckling matters, and quickly navigating to those mentions in order to read them as swiftly as possible.
Telegram allows scheduling messages.
Telegram allows sending the live geolocation of a user in a chat, optionally setting a proximity alert.
Sometimes, user and channel constructors met in group chat updates may not contain full info about the user: how to handle such constructors.
How to reset an account if the 2FA password was forgotten.
Telegram allows importing messages and media from foreign chat apps.
How to work with Telegram Passport directly using the MTProto API.
How to work with Telegram Payments directly using the MTProto API.
How to create styled text with message entities
Graphical telegram clients should transform emojis into their respective animated version.
Telegram supports sending animated dice emojis.
How to handle message drafts
Working with folders
If enabled, the rating of top peers indicates the relevance of a frequently used peer in a certain category (frequently messaged users, frequently used bots, inline bots, frequently visited channels and so on).
How to handle file references.
Handle Seamless Telegram Login URL authorization requests.
When interacting with HTML5 games and the websites of payment gateways, Telegram apps should expose the following JS APIs.
Telegram API: наглядный разбор с примерами
Для любого бизнеса важно установить канал общения с клиентами. Но сделать это не так просто. Психология людей такова, что они не хотят захламлять память своего смартфона новым фирменным приложением из того места, которое они посетили. Совсем другое дело — чат-бот. Ненавязчивый и дружелюбный. А кроме того — со всеми необходимыми фишками: рекламными акциями, скидками и быстрым заказом. И уведомления в одном единственном удобном мессенджере. Почему бы его не реализовать в своем бизнесе? Тем более, что это не так сложно, как вы думаете.
Сегодня мы поговорим о ботах и их API ( telegram api ) на базе популярного мессенджера Telegram.
Содержание
Telegram Bot API и Telegram API
Для его работы задействован промежуточный сервер с HTTPS-интерфейсом, который шифрует трафик и обеспечивает связь с Telegram API. Bot API позволяет легко создавать программы, которые используют интерфейс Telegram для выполнения кода на локальном сервере. Пользователи могут взаимодействовать с ботами, отправляя им сообщения, команды и встроенные запросы.
Принцип работы любого бота заключается в том, что он перманентно направляет запросы на сервер и регулярно получает обновления. Получать их можно двумя способами. Во-первых, можно использовать вебхуки, когда сервер делает обратный вызов на указанный URL. А во-вторых, можно просто « забрасывать » запросами Telegram, получая постоянные ответы.
Обратите внимание — получать уведомления о новых сообщениях в боте и других событиях вы можете всего один раз. Поэтому, если данные чата представляются вам очень важными, то придется самостоятельно сохранять список чатов и историю старых сообщений. Если вы случайно сотрете/потеряете эту информацию, то вы ее больше никак не восстановите.
В отличие от Bot API, где получать обновление можно только один раз, в Telegram API это ограничение можно обойти, если использовать несколько клиентов. В таком случае бот будет получать все обновления на каждом из запущенных клиентов. Также в Bot API нет возможности рассылки сообщений всем юзерам одновременно.
На GitHub ( https://github.com/tdlib/telegram-bot-api ) можно найти исходники сервера Bot API. Развернув такой сервер вы получите HTTP URL с возможностью организации работы через вебхуки. Также сможете загружать файлы (до двух терабайт) на локальный сервер. Сервер Bot API имеет возможность настройки порта и локального IP-адреса для вебхука, а также поддерживает до 100000 одновременных подключений — более чем достаточно для большинства задач.
BotFather: быстрый Start
Чтобы приступить к созданию собственного бота, необходимо получить токен для авторизации и подключения через API. Делается это при помощи служебного бота. Введите в поиске Telegram его имя — BotFather. Далее следует выбрать команду /newbot и дать имя боту.
В меню настроек BotSettings включается режим встроенных запросов (по умолчанию эта опция отключена). Когда встроенные запросы активированы, пользователи могут вызвать вашего бота, просто введя имя пользователя в поле для ввода текста в любом чате, группе или канале.
Если Telegram использовать в коммерческих целях, чат-бот можно вооружить средствами для приема платежей. Стоит обратить внимание, что сам Telegram не занимается проведением транзакций, он лишь дает возможность подключить услуги длинного списка провайдеров.
В их числе такие платежные системы, как Stripe, YooMoney, Сбербанк, PayMaster, PSB, Tranzzo, Payme, CLICK, LiqPay, Portmone, Paymega, ECOMMPAY и др. Разумеется, чтобы использовать эти платежные системы, нужно быть юридическим лицом.
aiogram — асинхронная библиотека
Реализовывать свой проект удобнее при помощи библиотек, таких как aiogram — это, пожалуй, лучшая стабильная асинхронная библиотека для Python ( https://pypi.org/project/aiogram/ ).
Относительно асинхронности нужно сказать несколько слов. Python — язык однопоточный, и любые команды в нем выполняются только после того, как завершилось выполнение предыдущей команды. Однако в случае с ботом программе необходимо отвечать на множество сообщений и делать это очень быстро. Можно, конечно, плодить множество потоков выполнений, но такой вариант чаще всего неприемлем, и альтернативой выступает асинхронная реализация задачи.
Когда в потоке выполнения команды возникает какая-то пауза, например, работает функция и у нее при этом есть какой-то таймаут ожидания, мы получаем участок времени, который не занят решением алгоритма. Асинхронность в aiogram позволяет заполнить эти промежутки, ускоряя работу нашего бота и быстро отвечая на сообщения. Устанавливается эта библиотека следующей командой :
Создаем эхо-бот
Перед тем как начать разбираться с Telegram-ботами, попробуйте создать простенький эхо-бот, который будет возвращать все поступающие сообщения. Это поможет понять механизм работы и разобраться с его функциями.
Создаем конфигурационный файл config.py и указываем в нем значение, сгенерированное ботом BotFather. Приступаем к написанию кода самого чат-бота.
Первая отвечает за прямой доступ к методам API и обеспечивает общее взаимодействие с ботом. Вторая, Dispatcher — простой обработчик событий. Мы обращаемся к этому обработчику событий и вызываем декоратор message_handler , который будет вызываться тогда, когда приходит событие о новом сообщении.
В данном случае обрабатываются все входящие сообщения, которые бот может читать. Тут важно понимать, что даже команды, написанные через слеш для бота — самые обычные сообщения. С точки зрения бота любое взаимодействие является сообщением.
Если вы делаете бота, который работает с деньгами или какой-то конфиденциальной информацией, то параметр skip_updates лучше устанавливать в значение Falsе — тогда обработчик не будет пропускать старые события и будет обрабатывать их в любом случае. Если этого не делать, существует вероятность, что какая-нибудь важная транзакция может потеряться и возникнет потенциальная угроза безопасности (или коллизия).
Оформление: кнопки и текст
Все сообщения в Telegram можно форматировать, используя различные варианты оформления текста — жирный, курсив и т.д. В Bot API разметка сообщений может создаваться в HTML и Markdown. Для удобства в ботах применяются кнопки, которые ставят под сообщениями. Их называют инлайн-клавиатурой или инлайн-кнопками, и они бывают разных видов.
Например, URL button — простая кнопка со ссылкой на какой-то веб-ресурс. Вариант кнопки Callback запрашивает обновление. Она может применяться, скажем, для уведомлений или предупреждений (с окном notification или окном alert ). Кнопка для перехода в режим инлайн может открывать меню для выбора чата.
Один из примеров такой клавиатуры — бот в кафе для дистанционного принятия заказов:
Учим бот-модерации
Теперь, если проверить, можно увидеть, что бот стал дублировать сообщения, то есть он их видит. Следовательно, мы можем теперь сделать нашего чат-бота администратором группы и научить его удалять нежелательные сообщения в группе или даже банить пользователей. Права для администрирования в группе назначаются точно так же, как и для любого пользователя группы.
Отредактируем код нашего бота. Если в тексте сообщения содержатся плохие (матерные) слова, наш бот-админ их автоматически распознает и удалит. Для этого вместо нашей echo функции ставим фильтр:
Теперь, если перезапустить бот, он будет читать сообщения в группе и удалять нежелательные слова. Таким образом, можно делать проверку лексики на наличие нецензурных слов и нежелательных ссылок.
Мы это сделали, чтобы функция обрабатывала сообщения только каких-то конкретных типов, в данном случае — сервисные сообщения. Также бывают еще текстовые сообщения, медиасообщения, голосовые и пр.
Даем возможность бана в группе
В коде бота мы его импортируем:
Также необходимо в конфигурационном файле config.py указать id чата ( GROUP_ID ).
Заключение
Как видите, сложного ничего нет и все трудности при разработке чат-ботов сводятся к тому, чтобы найти оптимальный API и библиотеку под Python, C#, PHP и другие языки программирования. Сегодня это явный тренд, чат-боты могут создавать воронки продаж не хуже опытных менеджеров, а кроме того берут на себя массу функций, требовавших ранее человеческих ресурсов, — запись на прием к врачу, продажа билетов и так далее.
Более сложные боты обладают искусственным интеллектом и умеют использовать нейронные сети. Возможности таких чат-ботов ограничены только вашей фантазией, но об этом — в следующий раз. А пока посмотрите дополнительное видео по технике создания ботов на JavaScript для Telegram API :