StartBotRequest

Only users can use this request. See code examples.

---functions---
messages.startBot#e6df7378 bot:InputUser peer:InputPeer random_id:long start_param:string = Updates

Returns

Updates

This type can be an instance of either:

UpdateShortUpdateShortChatMessage
UpdateShortMessageUpdateShortSentMessage
UpdatesUpdatesCombined
UpdatesTooLong

Parameters

botInputUserAnything entity-like will work if the library can find its Input version (e.g., usernames, Peer, User or Channel objects, etc.).
peerInputPeerAnything entity-like will work if the library can find its Input version (e.g., usernames, Peer, User or Channel objects, etc.).
start_paramstring
random_idlongIf left unspecified, it will be inferred automatically.

Known RPC errors

This request can cause 4 known errors:

BotInvalidErrorThis is not a valid bot.
PeerIdInvalidErrorAn invalid Peer was used. Make sure to pass the right peer type and that the value is valid (for instance, bots cannot start conversations).
StartParamEmptyErrorThe start parameter is empty.
StartParamInvalidErrorStart parameter invalid.

You can import these from telethon.errors.

Example

from telethon.sync import TelegramClient
from telethon import functions, types

with TelegramClient(name, api_id, api_hash) as client:
    result = client(functions.messages.StartBotRequest(
        bot='username',
        peer='username',
        start_param='some string here'
    ))
    print(result.stringify())