How to check if a user is subscribed to a specific Telegram channel (Python / PyTelegramBotApi)?

Question

I am writing a Telegram bot using the PyTelegramBotApi library, I would like to implement the function of checking the user's subscription to a certain telegram channel, and if there is none, offer to subscribe. Thanks in advance for your answers!

Tibebes. M · Accepted Answer · 2020-10-18 21:32:48Z

12

use getChatMember method to check if a user is member in a channel or not.

getChatMember

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

import telebot

bot = telebot.TeleBot("TOKEN")

CHAT_ID = -1001...
USER_ID = 700...

result = bot.get_chat_member(CHAT_ID, USER_ID)
print(result)

bot.polling()

Sample result:

You receive a user info if the user is a member

{'user': {'id': 700..., 'is_bot': False, 'first_name': '', 'username': None, 'last_name': None, ... }

or an Exception otherwise

telebot.apihelper.ApiTelegramException: A request to the Telegram API was unsuccessful. Error code: 400 Description: Bad Request: user not found

example on how to use it inside your project

import telebot
from telebot.apihelper import ApiTelegramException

bot = telebot.TeleBot("BOT_TOKEN")

CHAT_ID = -1001...
USER_ID = 700...

def is_subscribed(chat_id, user_id):
    try:
        bot.get_chat_member(chat_id, user_id)
        return True
    except ApiTelegramException as e:
        if e.result_json['description'] == 'Bad Request: user not found':
            return False

if not is_subscribed(CHAT_ID, USER_ID):
    # user is not subscribed. send message to the user
    bot.send_message(CHAT_ID, 'Please subscribe to the channel')
else:
    # user is subscribed. continue with the rest of the logic
    # ...

bot.polling()

edited Oct 18, 2020 at 21:32

answered Oct 18, 2020 at 14:42

Tibebes. M

7,6285 gold badges18 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Bortsov Bogdan Over a year ago

but how is it easier to parse the received data, and make a condition under which if a person is sub, the bot will continue to work, or if not signed, ask to subscribe?

Tibebes. M Over a year ago

@BortsovBogdan I've added some example on how you would use it as if-else logic and send a message

Slava Fomin II Over a year ago

The bot must be added as an admin to the channel in question in order for this to work.

LRDPRDX Apr 13 at 3:47

It seems it succeeds even if the user has left the group. Inside the data you will see 'status' : 'left'

Timofey Burkush Sep 3 at 17:49

Some users get error. Bad Request: PARTICIPANT_ID_INVALID. Method is working, but not always. Who know how to fix this problem?

Collectives™ on Stack Overflow

How to check if a user is subscribed to a specific Telegram channel (Python / PyTelegramBotApi)?

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related