76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
|
---
|
||
|
|
title: messages.startBot
|
||
|
|
description: Start a bot
|
||
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||
|
|
---
|
||
|
|
# Method: messages.startBot
|
||
|
|
[Back to methods index](index.md)
|
||
|
|
|
||
|
|
|
||
|
|
Start a bot
|
||
|
|
|
||
|
|
### Parameters:
|
||
|
|
|
||
|
|
| Name | Type | Description | Required |
|
||
|
|
|----------|---------------|-------------|----------|
|
||
|
|
|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional|
|
||
|
|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional|
|
||
|
|
|start\_param|[string](../types/string.md) | The bot's start parameter | Yes|
|
||
|
|
|
||
|
|
|
||
|
|
### Return type: [Updates](../types/Updates.md)
|
||
|
|
|
||
|
|
### Can bots use this method: **NO**
|
||
|
|
|
||
|
|
|
||
|
|
### MadelineProto Example:
|
||
|
|
|
||
|
|
|
||
|
|
```php
|
||
|
|
if (!file_exists('madeline.php')) {
|
||
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||
|
|
}
|
||
|
|
include 'madeline.php';
|
||
|
|
|
||
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||
|
|
$MadelineProto->start();
|
||
|
|
|
||
|
|
$Updates = $MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => InputPeer, 'start_param' => 'string', ]);
|
||
|
|
```
|
||
|
|
|
||
|
|
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### As a user:
|
||
|
|
|
||
|
|
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.startBot`
|
||
|
|
|
||
|
|
Parameters:
|
||
|
|
|
||
|
|
bot - Json encoded InputUser
|
||
|
|
|
||
|
|
peer - Json encoded InputPeer
|
||
|
|
|
||
|
|
start_param - Json encoded string
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Or, if you're into Lua:
|
||
|
|
|
||
|
|
```lua
|
||
|
|
Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', })
|
||
|
|
```
|
||
|
|
|
||
|
|
### Errors this method can return:
|
||
|
|
|
||
|
|
| Error | Description |
|
||
|
|
|----------|---------------|
|
||
|
|
|BOT_INVALID|This is not a valid bot|
|
||
|
|
|PEER_ID_INVALID|The provided peer id is invalid|
|
||
|
|
|START_PARAM_EMPTY|The start parameter is empty|
|
||
|
|
|START_PARAM_INVALID|Start parameter invalid|
|
||
|
|
|
||
|
|
|