.github | ||
tests | ||
utils | ||
.gitignore | ||
.pre-commit-config.yaml | ||
CODE_OF_CONDUCT.md | ||
codecov.yml | ||
config.yaml | ||
CONTRIBUTING.md | ||
dev-requirements.txt | ||
LICENSE | ||
Makefile | ||
media_downloader.py | ||
mypy.ini | ||
pylintrc | ||
README.md | ||
requirements.txt | ||
setup.py |
Telegram Media Downloader
Feature request · Report a bug · Support: Discussions & Telegram Community
Overview:
Download all media files from a conversation or a channel that you are a part of from telegram. A meta of last read/downloaded message is stored in the config file so that in such a way it won't download the same media file again.
Support:
Category | Support |
---|---|
Language | Python 3.7 and above |
Download media types | audio, document, photo, video, video_note, voice |
ToDo:
- Add support for multiple channels/chats.
Installation
For *nix os distributions with make
availability
$ git clone https://github.com/Dineshkarthik/telegram_media_downloader.git
$ cd telegram_media_downloader
$ make install
For Windows which doesn't have make
inbuilt
$ git clone https://github.com/Dineshkarthik/telegram_media_downloader.git
$ cd telegram_media_downloader
$ pip3 install -r requirements.txt
Configuration
All the configurations are passed to the Telegram Media Downloader via config.yaml
file.
Getting your API Keys: The very first step requires you to obtain a valid Telegram API key (API id/hash pair):
- Visit https://my.telegram.org/apps and log in with your Telegram Account.
- Fill out the form to register a new Telegram application.
- Done! The API key consists of two parts: api_id and api_hash.
Getting chat id:
1. Using web telegram:
- Open https://web.telegram.org/?legacy=1#/im
- Now go to the chat/channel and you will see the URL as something like
https://web.telegram.org/?legacy=1#/im?p=u853521067_2449618633394
here853521067
is the chat id.https://web.telegram.org/?legacy=1#/im?p=@somename
heresomename
is the chat id.https://web.telegram.org/?legacy=1#/im?p=s1301254321_6925449697188775560
here take1301254321
and add-100
to the start of the id =>-1001301254321
.https://web.telegram.org/?legacy=1#/im?p=c1301254321_6925449697188775560
here take1301254321
and add-100
to the start of the id =>-1001301254321
.
2. Using bot:
- Use @username_to_id_bot to get the chat_id of
- almost any telegram user: send username to the bot or just forward their message to the bot
- any chat: send chat username or copy and send its joinchat link to the bot
- public or private channel: same as chats, just copy and send to the bot
- id of any telegram bot
config.yaml
api_hash: your_api_hash
api_id: your_api_id
chat_id: telegram_chat_id
last_read_message_id: 0
ids_to_retry: []
media_types:
- audio
- document
- photo
- video
- voice
file_formats:
audio:
- all
document:
- pdf
- epub
video:
- mp4
- api_hash - The api_hash you got from telegram apps
- api_id - The api_id you got from telegram apps
- chat_id - The id of the chat/channel you want to download media. Which you get from the above-mentioned steps.
- last_read_message_id - If it is the first time you are going to read the channel let it be
0
or if you have already used this script to download media it will have some numbers which are auto-updated after the scripts successful execution. Don't change it. - ids_to_retry -
Leave it as it is.
This is used by the downloader script to keep track of all skipped downloads so that it can be downloaded during the next execution of the script. - media_types - Type of media to download, you can update which type of media you want to download it can be one or any of the available types.
- file_formats - File types to download for supported media types which are
audio
,document
andvideo
. Default format isall
, downloads all files.
Execution
$ python3 media_downloader.py
All the downloaded media will be stored inside respective direcotry named in the same path as the python script.
Media type | Download directory |
---|---|
audio | path/to/project/audio |
document | path/to/project/document |
photo | path/to/project/photo |
video | path/to/project/video |
voice | path/to/project/voice |
voice_note | path/to/project/voice_note |
Proxy
socks4, socks5, http
proxies are supported in this project currently. To use it, add the following to the bottom of your config.yaml
file
proxy:
scheme: socks5
hostname: 11.22.33.44
port: 1234
username: your_username
password: your_password
If your proxy doesn’t require authorization you can omit username and password. Then the proxy will automatically be enabled.
Contributing
Contributing Guidelines
Read through our contributing guidelines to learn about our submission process, coding rules and more.
Want to Help?
Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing.
Code of Conduct
Help us keep Telegram Media Downloader open and inclusive. Please read and follow our Code of Conduct.