telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Variable filtersConst

    filters: {
        ALL: MessageFilter;
        ANIMATION: BaseFilter;
        ATTACHMENT: BaseFilter;
        AUDIO: BaseFilter;
        BOT_COMMAND: BaseFilter;
        CAPTION: MessageFilter;
        CASHTAG: BaseFilter;
        ChatType: {
            CHANNEL: BaseFilter;
            GROUP: BaseFilter;
            GROUPS: BaseFilter;
            PRIVATE: BaseFilter;
            SUPERGROUP: BaseFilter;
        };
        COMMAND: MessageFilter;
        CONTACT: BaseFilter;
        DICE: BaseFilter;
        DOCUMENT: BaseFilter;
        EMAIL: BaseFilter;
        FORWARDED: MessageFilter;
        GAME: BaseFilter;
        HASHTAG: BaseFilter;
        LOCATION: BaseFilter;
        MENTION: BaseFilter;
        PHONE_NUMBER: BaseFilter;
        PHOTO: BaseFilter;
        POLL: BaseFilter;
        REPLY: MessageFilter;
        StatusUpdate: {
            ALL: BaseFilter;
            CHANNEL_CHAT_CREATED: MessageFilter;
            DELETE_CHAT_PHOTO: MessageFilter;
            GROUP_CHAT_CREATED: MessageFilter;
            LEFT_CHAT_MEMBER: MessageFilter;
            MIGRATE_FROM_CHAT_ID: MessageFilter;
            MIGRATE_TO_CHAT_ID: MessageFilter;
            NEW_CHAT_MEMBERS: MessageFilter;
            NEW_CHAT_PHOTO: MessageFilter;
            NEW_CHAT_TITLE: MessageFilter;
            PINNED_MESSAGE: MessageFilter;
            SUPERGROUP_CHAT_CREATED: MessageFilter;
        };
        STICKER: BaseFilter;
        TEXT: MessageFilter;
        URL: BaseFilter;
        VENUE: BaseFilter;
        VIDEO: BaseFilter;
        VIDEO_NOTE: BaseFilter;
        VOICE: BaseFilter;
        Custom(fn: (update: Update) => boolean | Promise<boolean>): CustomFilter;
        Regex(pattern: string | RegExp): RegexFilter;
    } = ...

    Predefined update and message filter collection for message routing.

    Type Declaration

    • ALL: MessageFilter

      Matches all messages unconditionally

    • ANIMATION: BaseFilter

      Matches animated GIF files

    • ATTACHMENT: BaseFilter

      Matches any media attachment (photo, document, audio, video, voice, animation)

    • AUDIO: BaseFilter

      Matches audio music files

    • BOT_COMMAND: BaseFilter

      Matches messages containing bot command entities

    • CAPTION: MessageFilter

      Matches messages with a caption

    • CASHTAG: BaseFilter

      Matches messages containing $CASHTAG symbols

    • ChatType: {
          CHANNEL: BaseFilter;
          GROUP: BaseFilter;
          GROUPS: BaseFilter;
          PRIVATE: BaseFilter;
          SUPERGROUP: BaseFilter;
      }

      Chat type filter sub-namespace

      • CHANNEL: BaseFilter

        Matches messages in broadcast channels

      • GROUP: BaseFilter

        Matches messages in standard basic groups

      • GROUPS: BaseFilter

        Matches messages in either basic groups or supergroups

      • PRIVATE: BaseFilter

        Matches messages in private direct chats

      • SUPERGROUP: BaseFilter

        Matches messages in supergroups

    • COMMAND: MessageFilter

      Matches messages starting with a bot command

    • CONTACT: BaseFilter

      Matches phone contact cards

    • DICE: BaseFilter

      Matches animated dice rolls

    • DOCUMENT: BaseFilter

      Matches document / file messages

    • EMAIL: BaseFilter

      Matches messages containing email addresses

    • FORWARDED: MessageFilter

      Matches forwarded messages

    • GAME: BaseFilter

      Matches game messages

    • HASHTAG: BaseFilter

      Matches messages containing #hashtags

    • LOCATION: BaseFilter

      Matches geographic locations

    • MENTION: BaseFilter

      Matches messages containing @username mentions

    • PHONE_NUMBER: BaseFilter

      Matches messages containing phone numbers

    • PHOTO: BaseFilter

      Matches photo messages

    • POLL: BaseFilter

      Matches poll messages

    • REPLY: MessageFilter

      Matches reply messages

    • StatusUpdate: {
          ALL: BaseFilter;
          CHANNEL_CHAT_CREATED: MessageFilter;
          DELETE_CHAT_PHOTO: MessageFilter;
          GROUP_CHAT_CREATED: MessageFilter;
          LEFT_CHAT_MEMBER: MessageFilter;
          MIGRATE_FROM_CHAT_ID: MessageFilter;
          MIGRATE_TO_CHAT_ID: MessageFilter;
          NEW_CHAT_MEMBERS: MessageFilter;
          NEW_CHAT_PHOTO: MessageFilter;
          NEW_CHAT_TITLE: MessageFilter;
          PINNED_MESSAGE: MessageFilter;
          SUPERGROUP_CHAT_CREATED: MessageFilter;
      }

      Chat status update filter sub-namespace

      • ALL: BaseFilter

        Matches any chat status update

      • CHANNEL_CHAT_CREATED: MessageFilter

        Matches messages indicating a channel was created

      • DELETE_CHAT_PHOTO: MessageFilter

        Matches messages where chat photo was deleted

      • GROUP_CHAT_CREATED: MessageFilter

        Matches messages indicating a group chat was created

      • LEFT_CHAT_MEMBER: MessageFilter

        Matches messages where a member left or was removed

      • MIGRATE_FROM_CHAT_ID: MessageFilter

        Matches migration service messages with source chat ID

      • MIGRATE_TO_CHAT_ID: MessageFilter

        Matches migration service messages with target chat ID

      • NEW_CHAT_MEMBERS: MessageFilter

        Matches messages where new members joined or were added

      • NEW_CHAT_PHOTO: MessageFilter

        Matches messages where chat photo was changed

      • NEW_CHAT_TITLE: MessageFilter

        Matches messages where chat title was changed

      • PINNED_MESSAGE: MessageFilter

        Matches pinned message notifications

      • SUPERGROUP_CHAT_CREATED: MessageFilter

        Matches messages indicating a supergroup was created

    • STICKER: BaseFilter

      Matches sticker messages

    • TEXT: MessageFilter

      Matches plain text messages excluding bot commands

    • URL: BaseFilter

      Matches messages containing HTTP/HTTPS web links

    • VENUE: BaseFilter

      Matches venue locations

    • VIDEO: BaseFilter

      Matches video files

    • VIDEO_NOTE: BaseFilter

      Matches round video notes

    • VOICE: BaseFilter

      Matches voice audio notes

    • Custom: function

      • Creates a custom filter using an arbitrary update predicate.

        Parameters

        • fn: (update: Update) => boolean | Promise<boolean>

          Predicate function returning boolean or Promise of boolean.

        Returns CustomFilter

        A new CustomFilter.

        const adminOnly = filters.Custom((update) => update.effective_user?.id === 12345);
    • Regex: function

      • Creates a filter matching text or caption against a regular expression.

        Parameters

        • pattern: string | RegExp

          Regular expression or pattern string.

        Returns RegexFilter

        A new RegexFilter.

        const orderFilter = filters.Regex(/^order_(\d+)$/i);

    import { filters, MessageHandler } from "telebot-ts";

    // Matches non-command text messages in private chats
    const privateText = new MessageHandler(
      filters.TEXT.and(filters.ChatType.PRIVATE),
      async (update, context) => { ... }
    );

    Settings
    Member Visibility