2022-02-23 16:30:26 +01:00
<!DOCTYPE html>
< html class = "" >
< head >
< meta charset = "utf-8" >
< title > Commands< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta property = "description" content = "Bots offer a set of commands that can be used by users in private, or in a chat." >
< meta property = "og:title" content = "Commands" >
< meta property = "og:image" content = "" >
< meta property = "og:description" content = "Bots offer a set of commands that can be used by users in private, or in a chat." >
< link rel = "shortcut icon" href = "/favicon.ico?4" type = "image/x-icon" / >
< link href = "/css/bootstrap.min.css?3" rel = "stylesheet" >
2022-03-03 18:30:26 +01:00
< link href = "/css/telegram.css?218" rel = "stylesheet" media = "screen" >
2022-02-23 16:30:26 +01:00
< style >
< / style >
< / head >
< body class = "preload" >
< div class = "dev_page_wrap" >
< div class = "dev_page_head navbar navbar-static-top navbar-tg" >
< div class = "navbar-inner" >
< div class = "container clearfix" >
< ul class = "nav navbar-nav navbar-right hidden-xs" > < li class = "navbar-twitter" > < a href = "https://twitter.com/telegram" target = "_blank" data-track = "Follow/Twitter" onclick = "trackDlClick(this, event)" > < i class = "icon icon-twitter" > < / i > < span > Twitter< / span > < / a > < / li > < / ul >
< ul class = "nav navbar-nav" >
< li > < a href = "//telegram.org/" > Home< / a > < / li >
< li class = "hidden-xs" > < a href = "//telegram.org/faq" > FAQ< / a > < / li >
< li class = "hidden-xs" > < a href = "//telegram.org/apps" > Apps< / a > < / li >
< li class = "active" > < a href = "/api" > API< / a > < / li >
< li class = "" > < a href = "/mtproto" > Protocol< / a > < / li >
< li class = "" > < a href = "/schema" > Schema< / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "container clearfix" >
< div class = "dev_page" >
< div id = "dev_page_content_wrap" class = " " >
< div class = "dev_page_bread_crumbs" > < ul class = "breadcrumb clearfix" > < li > < a href = "/api" > API< / a > < / li > < i class = "icon icon-breadcrumb-divider" > < / i > < li > < a href = "/api/bots%2Fcommands" > Commands< / a > < / li > < / ul > < / div >
< h1 id = "dev_page_title" > Commands< / h1 >
< div id = "dev_page_content" > <!-- scroll_nav -->
< p > < a href = "/bots" > Bots< / a > offer a set of < a href = "/bots/#commands" > commands< / a > that can be used by users in private, or in a chat. < / p >
< p > For a simplified description using the HTTP bot API, see < a href = "/bots/#commands" > here »< / a > . < / p >
< h3 > < a class = "anchor" href = "#getting-commands" id = "getting-commands" name = "getting-commands" > < i class = "anchor-icon" > < / i > < / a > Getting commands< / h3 >
< pre > < code > < a href = '/constructor/botCommand' > botCommand< / a > #c27ac8c7 command:< a href = '/type/string' > string< / a > description:< a href = '/type/string' > string< / a > = < a href = '/type/BotCommand' > BotCommand< / a > ;
< a href = '/constructor/botInfo' > botInfo< / a > #1b74b335 user_id:< a href = '/type/long' > long< / a > description:< a href = '/type/string' > string< / a > commands:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/BotCommand' > BotCommand< / a > > = < a href = '/type/BotInfo' > BotInfo< / a > ;
< a href = '/constructor/channelFull' > channelFull< / a > #e9b27a17 flags:< a href = '/type/%23' > #< / a > can_view_participants:flags.3?< a href = '/constructor/true' > true< / a > can_set_username:flags.6?< a href = '/constructor/true' > true< / a > can_set_stickers:flags.7?< a href = '/constructor/true' > true< / a > hidden_prehistory:flags.10?< a href = '/constructor/true' > true< / a > can_set_location:flags.16?< a href = '/constructor/true' > true< / a > has_scheduled:flags.19?< a href = '/constructor/true' > true< / a > can_view_stats:flags.20?< a href = '/constructor/true' > true< / a > blocked:flags.22?< a href = '/constructor/true' > true< / a > id:< a href = '/type/long' > long< / a > about:< a href = '/type/string' > string< / a > participants_count:flags.0?< a href = '/type/int' > int< / a > admins_count:flags.1?< a href = '/type/int' > int< / a > kicked_count:flags.2?< a href = '/type/int' > int< / a > banned_count:flags.2?< a href = '/type/int' > int< / a > online_count:flags.13?< a href = '/type/int' > int< / a > read_inbox_max_id:< a href = '/type/int' > int< / a > read_outbox_max_id:< a href = '/type/int' > int< / a > unread_count:< a href = '/type/int' > int< / a > chat_photo:< a href = '/type/Photo' > Photo< / a > notify_settings:< a href = '/type/PeerNotifySettings' > PeerNotifySettings< / a > exported_invite:flags.23?< a href = '/type/ExportedChatInvite' > ExportedChatInvite< / a > bot_info:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/BotInfo' > BotInfo< / a > > migrated_from_chat_id:flags.4?< a href = '/type/long' > long< / a > migrated_from_max_id:flags.4?< a href = '/type/int' > int< / a > pinned_msg_id:flags.5?< a href = '/type/int' > int< / a > stickerset:flags.8?< a href = '/type/StickerSet' > StickerSet< / a > available_min_id:flags.9?< a href = '/type/int' > int< / a > folder_id:flags.11?< a href = '/type/int' > int< / a > linked_chat_id:flags.14?< a href = '/type/long' > long< / a > location:flags.15?< a href = '/type/ChannelLocation' > ChannelLocation< / a > slowmode_seconds:flags.17?< a href = '/type/int' > int< / a > slowmode_next_send_date:flags.18?< a href = '/type/int' > int< / a > stats_dc:flags.12?< a href = '/type/int' > int< / a > pts:< a href = '/type/int' > int< / a > call:flags.21?< a href = '/type/InputGroupCall' > InputGroupCall< / a > ttl_period:flags.24?< a href = '/type/int' > int< / a > pending_suggestions:flags.25?< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/string' > string< / a > > groupcall_default_join_as:flags.26?< a href = '/type/Peer' > Peer< / a > theme_emoticon:flags.27?< a href = '/type/string' > string< / a > = < a href = '/type/ChatFull' > ChatFull< / a > ;
< a href = '/constructor/userFull' > userFull< / a > #d697ff05 flags:< a href = '/type/%23' > #< / a > blocked:flags.0?< a href = '/constructor/true' > true< / a > phone_calls_available:flags.4?< a href = '/constructor/true' > true< / a > phone_calls_private:flags.5?< a href = '/constructor/true' > true< / a > can_pin_message:flags.7?< a href = '/constructor/true' > true< / a > has_scheduled:flags.12?< a href = '/constructor/true' > true< / a > video_calls_available:flags.13?< a href = '/constructor/true' > true< / a > user:< a href = '/type/User' > User< / a > about:flags.1?< a href = '/type/string' > string< / a > settings:< a href = '/type/PeerSettings' > PeerSettings< / a > profile_photo:flags.2?< a href = '/type/Photo' > Photo< / a > notify_settings:< a href = '/type/PeerNotifySettings' > PeerNotifySettings< / a > bot_info:flags.3?< a href = '/type/BotInfo' > BotInfo< / a > pinned_msg_id:flags.6?< a href = '/type/int' > int< / a > common_chats_count:< a href = '/type/int' > int< / a > folder_id:flags.11?< a href = '/type/int' > int< / a > ttl_period:flags.14?< a href = '/type/int' > int< / a > theme_emoticon:flags.15?< a href = '/type/string' > string< / a > = < a href = '/type/UserFull' > UserFull< / a > ;
< a href = '/constructor/user' > user< / a > #3ff6ecb0 flags:< a href = '/type/%23' > #< / a > self:flags.10?< a href = '/constructor/true' > true< / a > contact:flags.11?< a href = '/constructor/true' > true< / a > mutual_contact:flags.12?< a href = '/constructor/true' > true< / a > deleted:flags.13?< a href = '/constructor/true' > true< / a > bot:flags.14?< a href = '/constructor/true' > true< / a > bot_chat_history:flags.15?< a href = '/constructor/true' > true< / a > bot_nochats:flags.16?< a href = '/constructor/true' > true< / a > verified:flags.17?< a href = '/constructor/true' > true< / a > restricted:flags.18?< a href = '/constructor/true' > true< / a > min:flags.20?< a href = '/constructor/true' > true< / a > bot_inline_geo:flags.21?< a href = '/constructor/true' > true< / a > support:flags.23?< a href = '/constructor/true' > true< / a > scam:flags.24?< a href = '/constructor/true' > true< / a > apply_min_photo:flags.25?< a href = '/constructor/true' > true< / a > fake:flags.26?< a href = '/constructor/true' > true< / a > id:< a href = '/type/long' > long< / a > access_hash:flags.0?< a href = '/type/long' > long< / a > first_name:flags.1?< a href = '/type/string' > string< / a > last_name:flags.2?< a href = '/type/string' > string< / a > username:flags.3?< a href = '/type/string' > string< / a > phone:flags.4?< a href = '/type/string' > string< / a > photo:flags.5?< a href = '/type/UserProfilePhoto' > UserProfilePhoto< / a > status:flags.6?< a href = '/type/UserStatus' > UserStatus< / a > bot_info_version:flags.14?< a href = '/type/int' > int< / a > restriction_reason:flags.18?< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/RestrictionReason' > RestrictionReason< / a > > bot_inline_placeholder:flags.19?< a href = '/type/string' > string< / a > lang_code:flags.22?< a href = '/type/string' > string< / a > = < a href = '/type/User' > User< / a > ;< / code > < / pre >
< p > The < a href = "/constructor/botInfo" > botInfo< / a > constructors contained in the < a href = "/constructor/userFull" > userFull< / a > , < a href = "/constructor/chatFull" > chatFull< / a > , < a href = "/constructor/channelFull" > channelFull< / a > contain a list of commands, and for groups, the ID and a description of each bot. < / p >
< p > In graphical clients, when users begin a message with a < code > /< / code > , a list of commands supported by all bots present in the current chat should be shown; the same should be done for one-to-one chats with the bot itself. < / p >
< p > If the command list of a bot changes, the < code > bot_info_version< / code > contained in the < a href = "/constructor/user" > user< / a > constructor received in updates will change; this indicates that the client should refetch full bot information using < a href = "/method/users.getFullUser" > users.getFullUser< / a > .< / p >
< h3 > < a class = "anchor" href = "#setting-commands" id = "setting-commands" name = "setting-commands" > < i class = "anchor-icon" > < / i > < / a > Setting commands< / h3 >
< pre > < code > < a href = '/constructor/botCommand' > botCommand< / a > #c27ac8c7 command:< a href = '/type/string' > string< / a > description:< a href = '/type/string' > string< / a > = < a href = '/type/BotCommand' > BotCommand< / a > ;
---functions---
< a href = '/method/bots.setBotCommands' > bots.setBotCommands< / a > #517165a scope:< a href = '/type/BotCommandScope' > BotCommandScope< / a > lang_code:< a href = '/type/string' > string< / a > commands:< a href = '/type/Vector%20t' > Vector< / a > < < a href = '/type/BotCommand' > BotCommand< / a > > = < a href = '/type/Bool' > Bool< / a > ;< / code > < / pre >
< p > The command list can be changed by the owner of the bot through < a href = "https://t.me/botfather" > @botfather< / a > , but bots can also change their own command list by invoking < a href = "/method/bots.setBotCommands" > bots.setBotCommands< / a > .< / p > < / div >
< / div >
< / div >
< / div >
< div class = "footer_wrap" >
< div class = "footer_columns_wrap footer_desktop" >
< div class = "footer_column footer_column_telegram" >
< h5 > Telegram< / h5 >
< div class = "footer_telegram_description" > < / div >
Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/faq" > About< / a > < / h5 >
< ul >
< li > < a href = "//telegram.org/faq" > FAQ< / a > < / li >
< li > < a href = "//telegram.org/blog" > Blog< / a > < / li >
< li > < a href = "//telegram.org/jobs" > Jobs< / a > < / li >
< / ul >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/apps#mobile-apps" > Mobile Apps< / a > < / h5 >
< ul >
< li > < a href = "//telegram.org/dl/ios" > iPhone/iPad< / a > < / li >
< li > < a href = "//telegram.org/dl/android" > Android< / a > < / li >
< li > < a href = "//telegram.org/dl/wp" > Windows Phone< / a > < / li >
< / ul >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/apps#desktop-apps" > Desktop Apps< / a > < / h5 >
< ul >
< li > < a href = "//desktop.telegram.org/" > PC/Mac/Linux< / a > < / li >
< li > < a href = "//macos.telegram.org/" > macOS< / a > < / li >
< li > < a href = "//telegram.org/dl/web" > Web-browser< / a > < / li >
< / ul >
< / div >
< div class = "footer_column footer_column_platform" >
< h5 > < a href = "/" > Platform< / a > < / h5 >
< ul >
< li > < a href = "/api" > API< / a > < / li >
< li > < a href = "//translations.telegram.org/" > Translations< / a > < / li >
< li > < a href = "//instantview.telegram.org/" > Instant View< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "footer_columns_wrap footer_mobile" >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/faq" > About< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/blog" > Blog< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "//telegram.org/apps" > Apps< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "/" > Platform< / a > < / h5 >
< / div >
< div class = "footer_column" >
< h5 > < a href = "https://twitter.com/telegram" target = "_blank" data-track = "Follow/Twitter" onclick = "trackDlClick(this, event)" > Twitter< / a > < / h5 >
< / div >
< / div >
< / div >
< / div >
< script src = "/js/main.js?43" > < / script >
< script src = "/js/jquery.min.js?1" > < / script >
< script src = "/js/bootstrap.min.js?1" > < / script >
< script > w i n d o w . i n i t D e v P a g e N a v & & i n i t D e v P a g e N a v ( ) ;
backToTopInit("Go up");
removePreloadInit();
< / script >
< / body >
< / html >
