2022-05-14 00:37:40 +02:00
<!DOCTYPE html>
< html class = "" >
< head >
< meta charset = "utf-8" >
< title > messages.startBot< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta property = "description" content = "Start a conversation with a bot using a deep linking parameter" >
< meta property = "og:title" content = "messages.startBot" >
< meta property = "og:image" content = "" >
< meta property = "og:description" content = "Start a conversation with a bot using a deep linking parameter" >
< link rel = "icon" type = "image/svg+xml" href = "/img/website_icon.svg?4" >
< link rel = "apple-touch-icon" sizes = "180x180" href = "/img/apple-touch-icon.png" >
< link rel = "icon" type = "image/png" sizes = "32x32" href = "/img/favicon-32x32.png" >
< link rel = "icon" type = "image/png" sizes = "16x16" href = "/img/favicon-16x16.png" >
< link rel = "alternate icon" href = "/img/favicon.ico" type = "image/x-icon" / >
< link href = "/css/bootstrap.min.css?3" rel = "stylesheet" >
2023-03-20 12:08:32 +01:00
< link href = "/css/telegram.css?236" rel = "stylesheet" media = "screen" >
2022-05-14 00:37:40 +02: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 = "/methods" > All Methods< / a > < / li > < i class = "icon icon-breadcrumb-divider" > < / i > < li > < a href = "/method/messages.startBot" > messages.startBot< / a > < / li > < / ul > < / div >
< h1 id = "dev_page_title" > messages.startBot< / h1 >
2022-11-15 01:03:58 +01:00
< div id = "dev_page_content" > < p > Start a conversation with a bot using a < a href = "/api/links#bot-links" > deep linking parameter< / a > < / p >
2022-05-14 00:37:40 +02:00
< p > < div class = "clearfix" >
< ul class = "dev_layer_select slightly-pull-right nav nav-pills" >
< li class = "dropdown" >
2024-02-14 16:13:13 +01:00
< a class = "dropdown-toggle" onclick = "return dropdownClick(this, event)" href = "#" > Layer 170 < b class = "caret" > < / b > < / a >
2022-05-14 00:37:40 +02:00
< ul class = "dropdown-menu" >
2024-02-14 16:13:13 +01:00
< li > < a href = "?layer=1" > 1 – Base layer< / a > < / li > < li > < a href = "?layer=2" > 2 – New userpic notifications< / a > < / li > < li > < a href = "?layer=3" > 3 – Send message can trigger link change< / a > < / li > < li > < a href = "?layer=4" > 4 – Check-in chats< / a > < / li > < li > < a href = "?layer=5" > 5 – Localized SMS, localized notifications< / a > < / li > < li > < a href = "?layer=6" > 6 – Foursquare integration< / a > < / li > < li > < a href = "?layer=7" > 7 – Added wallPaperSolid< / a > < / li > < li > < a href = "?layer=8" > 8 – Added end-to-end encryption< / a > < / li > < li > < a href = "?layer=9" > 9 – Improved big files upload perfomance< / a > < / li > < li > < a href = "?layer=10" > 10 – Improved chat participants updates< / a > < / li > < li > < a href = "?layer=11" > 11 – Improved secret chats< / a > < / li > < li > < a href = "?layer=12" > 12 – New dynamic support< / a > < / li > < li > < a href = "?layer=13" > 13 – Audio, video MIME; contacts import retry; new secret actions< / a > < / li > < li > < a href = "?layer=14" > 14 – Notify settings sync, blacklist sync< / a > < / li > < li > < a href = "?layer=15" > 15 – Modified getHistory offset behaviour< / a > < / li > < li > < a href = "?layer=16" > 16 – Split sendCode into 2 parts< / a > < / li > < li > < a href = "?layer=17" > 17 – Added custom typing, introduced message flags< / a > < / li > < li > < a href = "?layer=18" > 18 – Added usernames< / a > < / li > < li > < a href = "?layer=23" > 23 – Stickers for secret chats< / a > < / li > < li > < a href = "?layer=105" > 105 – Scheduled messages, Cloud themes< / a > < / li > < li > < a href = "?layer=108" > 108 – Login with QR code< / a > < / li > < li > < a href = "?layer=109" > 109 – Polls v2< / a > < / li > < li > < a href = "?layer=110" > 110 – People Nearby 2.0, Bank card entity< / a > < / li > < li > < a href = "?layer=111" > 111 – Folders, Broadcast Stats< / a > < / li > < li > < a href = "?layer=112" > 112 – Old featured stickers, generic dice, poll timer, poll solution< / a > < / li > < li > < a href = "?layer=113" > 113 – PSA< / a > < / li > < li > < a href = "?layer=114" > 114 – Video thumbs for GIFs< / a > < / li > < li > < a href = "?layer=115" > 115 – Peek Channel Invite< / a > < / li > < li > < a href = "?layer=116" > 116 – Group Stats, Profile Videos< / a > < / li > < li > < a href = "?layer=117" > 117 – WebRTC Phone Calls< / a > < / li > < li > < a href = "?layer=118" > 118 – Callback with 2FA, Countries list< / a > < / li > < li > < a href = "?layer=119" > 119 – Comments in channels, Threads, Anonymous Admins< / a > < / li > < li > < a href = "?layer=120" > 120 – Multipins, Message Stats, GeoLive v2< / a > < / li > < li > < a href = "?layer=121" > 121 – SVG-based Outlines for Stickers< / a > < / li > < li > < a href = "?layer=122" > 122 – Voice Chats< / a > < / li > < li > < a href = "?layer=123" > 123 – Voice Chat improvements< / a > < / li > < li > < a href = "?layer=124" > 124 – Expiring Invite links< / a > < / li > < li > < a href = "?layer=125" > 125 – Voice Chats in Broadcasts< / a > < / li > < li > < a href = "?layer=126" > 126 – Ban channels in channels< / a > < / li > < li > < a href = "?layer=127" > 127 – Payments in channels< / a > < / li > < li > < a href = "?layer=128" > 128 – Microthumbs for User/Chat profile photos< / a > < / li > < li > < a href = "?layer=129" > 129 – Video Chats< / a > < / li > < li > < a href = "?layer=130" > 130 – Custom placeholder for bot reply keyboards< / a > < / li > < li > < a href = "?layer=131" > 131 – Reset 2FA Password after a week< / a > < / li > < li > < a href = "?layer=132" > 132 – Chat themes< / a > < / li > < li > < a href = "?layer=133" > 133 – 64-bit IDs for User/Chat< / a > < / li > < li > < a href = "?layer=134" > 134 – Chat Requests, Shared Media Calendar< / a > < / li > < li > < a href = "?layer=135" > 135 – Send Message As a Channel< / a > < / li > < li > < a href = "?layer=136" > 136 – Reactions< / a > < / li > < li > < a href = "?layer=137" > 137 – Translations< / a > < / li > < li > < a href = "?layer=138" > 138 – GIF Sticker Packs< / a > < / li > < li > < a href = "?layer=139" > 139 – RTMP streaming< / a > < / li > < li > < a href = "?layer=140" > 140 – WebApps, Cloud Ringtones< / a > < / li > < li > < a href = "?layer=142" > 142 – TCP Reflectors< / a > < / li > < li > < a href = "?layer=143" > 143 – Premium Subscription, Cloud Invoices< / a > < / li > < li > < a href = "?layer=144" > 144 – Premium as a Gift, Custom Emoji< / a > < / li > < li > < a href = "?layer=145" > 145 – Custom Reactions, Statuses, Sign In with email< / a > < / li > < li > < a href = "?
2022-05-14 00:37:40 +02:00
< li class = "divider" > < / li >
< li > < a href = "/api/layers" > More...< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< pre class = "page_scheme" > < code > < a href = "/constructor/updatesTooLong" > updatesTooLong< / a > #e317af7e = < a href = "/type/Updates" > Updates< / a > ;
< a href = "/constructor/updateShortMessage" > updateShortMessage< / a > #313bc7f8 flags:< a href = "/type/%23" > #< / a > out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:< a href = "/type/int" > int< / a > user_id:< a href = "/type/long" > long< / a > message:< a href = "/type/string" > string< / a > pts:< a href = "/type/int" > int< / a > pts_count:< a href = "/type/int" > int< / a > date:< a href = "/type/int" > int< / a > fwd_from:flags.2?< a href = "/type/MessageFwdHeader" > MessageFwdHeader< / a > via_bot_id:flags.11?< a href = "/type/long" > long< / a > reply_to:flags.3?< a href = "/type/MessageReplyHeader" > MessageReplyHeader< / a > entities:flags.7?< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/MessageEntity" > MessageEntity< / a > > ttl_period:flags.25?< a href = "/type/int" > int< / a > = < a href = "/type/Updates" > Updates< / a > ;
< a href = "/constructor/updateShortChatMessage" > updateShortChatMessage< / a > #4d6deea5 flags:< a href = "/type/%23" > #< / a > out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:< a href = "/type/int" > int< / a > from_id:< a href = "/type/long" > long< / a > chat_id:< a href = "/type/long" > long< / a > message:< a href = "/type/string" > string< / a > pts:< a href = "/type/int" > int< / a > pts_count:< a href = "/type/int" > int< / a > date:< a href = "/type/int" > int< / a > fwd_from:flags.2?< a href = "/type/MessageFwdHeader" > MessageFwdHeader< / a > via_bot_id:flags.11?< a href = "/type/long" > long< / a > reply_to:flags.3?< a href = "/type/MessageReplyHeader" > MessageReplyHeader< / a > entities:flags.7?< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/MessageEntity" > MessageEntity< / a > > ttl_period:flags.25?< a href = "/type/int" > int< / a > = < a href = "/type/Updates" > Updates< / a > ;
< a href = "/constructor/updateShort" > updateShort< / a > #78d4dec1 update:< a href = "/type/Update" > Update< / a > date:< a href = "/type/int" > int< / a > = < a href = "/type/Updates" > Updates< / a > ;
< a href = "/constructor/updatesCombined" > updatesCombined< / a > #725b04c3 updates:< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/Update" > Update< / a > > users:< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/User" > User< / a > > chats:< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/Chat" > Chat< / a > > date:< a href = "/type/int" > int< / a > seq_start:< a href = "/type/int" > int< / a > seq:< a href = "/type/int" > int< / a > = < a href = "/type/Updates" > Updates< / a > ;
< a href = "/constructor/updates" > updates< / a > #74ae4240 updates:< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/Update" > Update< / a > > users:< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/User" > User< / a > > chats:< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/Chat" > Chat< / a > > date:< a href = "/type/int" > int< / a > seq:< a href = "/type/int" > int< / a > = < a href = "/type/Updates" > Updates< / a > ;
< a href = "/constructor/updateShortSentMessage" > updateShortSentMessage< / a > #9015e101 flags:< a href = "/type/%23" > #< / a > out:flags.1?true id:< a href = "/type/int" > int< / a > pts:< a href = "/type/int" > int< / a > pts_count:< a href = "/type/int" > int< / a > date:< a href = "/type/int" > int< / a > media:flags.9?< a href = "/type/MessageMedia" > MessageMedia< / a > entities:flags.7?< a href = "/type/Vector%20t" > Vector< / a > < < a href = "/type/MessageEntity" > MessageEntity< / a > > ttl_period:flags.25?< a href = "/type/int" > int< / a > = < a href = "/type/Updates" > Updates< / a > ;
---functions---
< a href = "/method/messages.startBot" class = "current_page_link" > messages.startBot< / a > #e6df7378 bot:< a href = "/type/InputUser" > InputUser< / a > peer:< a href = "/type/InputPeer" > InputPeer< / a > random_id:< a href = "/type/long" > long< / a > start_param:< a href = "/type/string" > string< / a > = < a href = "/type/Updates" > Updates< / a > ;< / code > < / pre > < / p >
< h3 > < a class = "anchor" href = "#parameters" id = "parameters" name = "parameters" > < i class = "anchor-icon" > < / i > < / a > Parameters< / h3 >
< table class = "table" >
< thead >
< tr >
< th > Name< / th >
< th style = "text-align: center;" > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < strong > bot< / strong > < / td >
< td style = "text-align: center;" > < a href = "/type/InputUser" > InputUser< / a > < / td >
< td > The bot< / td >
< / tr >
< tr >
< td > < strong > peer< / strong > < / td >
< td style = "text-align: center;" > < a href = "/type/InputPeer" > InputPeer< / a > < / td >
< td > The chat where to start the bot, can be the bot's private chat or a group< / td >
< / tr >
< tr >
< td > < strong > random_id< / strong > < / td >
< td style = "text-align: center;" > < a href = "/type/long" > long< / a > < / td >
< td > Random ID to avoid resending the same message< / td >
< / tr >
< tr >
< td > < strong > start_param< / strong > < / td >
< td style = "text-align: center;" > < a href = "/type/string" > string< / a > < / td >
2022-11-15 01:03:58 +01:00
< td > < a href = "/api/links#bot-links" > Deep linking parameter< / a > < / td >
2022-05-14 00:37:40 +02:00
< / tr >
< / tbody >
< / table >
< h3 > < a class = "anchor" href = "#result" id = "result" name = "result" > < i class = "anchor-icon" > < / i > < / a > Result< / h3 >
< p > < a href = "/type/Updates" > Updates< / a > < / p >
< h3 > < a class = "anchor" href = "#possible-errors" id = "possible-errors" name = "possible-errors" > < i class = "anchor-icon" > < / i > < / a > Possible errors< / h3 >
< table class = "table" >
< thead >
< tr >
< th > Code< / th >
< th > Type< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > 400< / td >
< td > BOT_INVALID< / td >
< td > This is not a valid bot.< / td >
< / tr >
< tr >
< td > 400< / td >
< td > CHAT_ADMIN_REQUIRED< / td >
< td > You must be an admin in this chat to do this.< / td >
< / tr >
< tr >
2022-11-15 01:03:58 +01:00
< td > 403< / td >
< td > CHAT_WRITE_FORBIDDEN< / td >
< td > You can't write in this chat.< / td >
< / tr >
< tr >
2022-05-14 00:37:40 +02:00
< td > 400< / td >
< td > INPUT_USER_DEACTIVATED< / td >
< td > The specified user was deleted.< / td >
< / tr >
< tr >
< td > 400< / td >
< td > MSG_ID_INVALID< / td >
< td > Invalid message ID provided.< / td >
< / tr >
< tr >
< td > 400< / td >
< td > PEER_ID_INVALID< / td >
< td > The provided peer id is invalid.< / td >
< / tr >
< tr >
< td > 500< / td >
< td > RANDOM_ID_DUPLICATE< / td >
< td > You provided a random ID that was already used.< / td >
< / tr >
< tr >
< td > 400< / td >
< td > START_PARAM_EMPTY< / td >
< td > The start parameter is empty.< / td >
< / tr >
< tr >
< td > 400< / td >
< td > START_PARAM_INVALID< / td >
< td > Start parameter invalid.< / td >
< / tr >
< tr >
< td > 400< / td >
< td > START_PARAM_TOO_LONG< / td >
< td > Start parameter is too long.< / td >
< / tr >
< / tbody >
< / table >
< h3 > < a class = "anchor" href = "#related-pages" id = "related-pages" name = "related-pages" > < i class = "anchor-icon" > < / i > < / a > Related pages< / h3 >
2022-11-15 01:03:58 +01:00
< h4 > < a class = "anchor" href = "#deep-links" id = "deep-links" name = "deep-links" > < i class = "anchor-icon" > < / i > < / a > < a href = "/api/links" > Deep links< / a > < / h4 >
< p > Telegram clients must handle special tg:// and t.me deep links encountered in messages, link entities and in other apps by registering OS handlers.< / p > < / div >
2022-05-14 00:37:40 +02:00
< / 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 >
2022-09-09 12:10:24 +02:00
< li > < a href = "//telegram.org/privacy" > Privacy< / a > < / li >
2022-09-09 23:58:59 +02:00
< li > < a href = "//telegram.org/press" > Press< / a > < / li >
2022-05-14 00:37:40 +02:00
< / 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 >
2022-09-09 23:58:59 +02:00
< li > < a href = "//telegram.org/android" > Android< / a > < / li >
< li > < a href = "//telegram.org/dl/web" > Mobile Web< / a > < / li >
2022-05-14 00:37:40 +02:00
< / 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" >
2024-02-14 16:13:13 +01:00
< h5 > < a href = "//telegram.org/press" > Press< / a > < / h5 >
2022-05-14 00:37:40 +02:00
< / div >
< / div >
< / div >
< / div >
2022-12-10 23:50:15 +01:00
< script src = "/js/main.js?47" > < / script >
2022-05-14 00:37:40 +02:00
< script > b a c k T o T o p I n i t ( " G o u p " ) ;
removePreloadInit();
< / script >
< / body >
< / html >
