Powered by pytgbot, the endorsed python Telegram API client.

This is a standalone API implementation allowing bots and user accounts.

For bots this API will work even if api.telegram.org is down, and for user accounts it allows you to use regular bot code to manage groups, etc.

The pytgbot library must be installed.

pip install pytgbot

Now you have to replace the bot api url of the bot to connect to with the one of your (self-)hosted instance.

from pytgbot import Bot

Bot._base_url = "https://api.telegram.rest/bot{api_key}/{command}"

bot = Bot('123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11')

If you want to use it for both bot and user accounts, you have to exclude the bot part before the api_key and add bot to your api key instead.account

from pytgbot import Bot

Bot._base_url = "https://api.telegram.rest/{api_key}/{command}"

bot = Bot('bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11')

This API allows you to both use a API bot or a User account in the fully same way. It therefore supports the regular /bot<token>/... we're all used to and similarly /user<token>/....

Use this method to get a unique session token for your account by providing phone number and security code in multiple steps.

First you call this function with just the phone number, and will get back a phone_code_hash and the session. Those have to be provided again with the second call, when you'll additionally provide the code and if needed the password. Returns an object of Something

Contains information about the current status of registering.

All other known Bot API Methods will be supported. Check the normal Documentation for those.

• setWebhook

• deleteWebhook

• getUpdates

• getMe

• getUpdates

• sendMessage

• sendChatAction

• sendLocation

• editMessageLiveLocation

• stopMessageLiveLocation

• sendVenue

• sendPhoto

  • ⚠️ Currently does not accept file uploads directly to the photo form fields.
    • This is due to (tiangolo/fastapi#907)[tiangolo/fastapi#907]
    • Workaround is using attachment://photo_file (or a different attachment name) and uploading the file to that very same photo_file field instead.

• sendAudio

  • ⚠️ Currently does not accept file uploads directly to the audio form fields.
    • This is due to (tiangolo/fastapi#907)[tiangolo/fastapi#907]
    • Workaround is using attachment://audio_file (or a different attachment name) and uploading the file to that very same audio_file field instead.

• Added API definitions of v4.6, (January 23, 2020) with the following changelog:

  • Supported Polls 2.0.
  • Added the ability to send non-anonymous, multiple answer, and quiz-style polls: added the parameters is_anonymous, type, allows_multiple_answers, correct_option_id, is_closed options to the method sendPoll.
  • Added the object KeyboardButtonPollType and the field request_poll to the object KeyboardButton.
  • Added updates about changes of user answers in non-anonymous polls, represented by the object PollAnswer and the field poll_answer in the Update object.
  • Added the fields total_voter_count, is_anonymous, type, allows_multiple_answers, correct_option_id to the Poll object.
  • [-] Bots can now send polls to private chats.
  • Added more information about the bot in response to the getMe request: added the fields can_join_groups, can_read_all_group_messages and supports_inline_queries to the User object.
  • Added the optional field language to the MessageEntity object.

• The new stuff:

  • New Fields:
    • pytgbot.api_types.receivable.media.MessageEntity: language
    • pytgbot.api_types.receivable.media.Poll: total_voter_count, is_closed, is_anonymous, type, allows_multiple_answers and correct_option_id
    • pytgbot.api_types.receivable.updates.Update: poll_answer
    • pytgbot.api_types.sendable.reply_markup.KeyboardButton: request_poll
    • pytgbot.api_types.receivable.peer.User: can_join_groups, can_read_all_group_messages, supports_inline_queries
    • pytgbot.api_types.receivable.peer.Chat: slow_mode_delay
    • pytgbot.api_types.receivable.peer.ChatMember: custom_title
  • New Arguments:
    • pytgbot.bot.Bot.get_me:
  • New Classes:
    • pytgbot.api_types.sendable.reply_markup.KeyboardButtonPollType
    • pytgbot.api_types.receivable.media.PollAnswer