MadelineProto/old_docs/API_docs_v72/methods/messages_startBot.md

75 lines
1.7 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: messages.startBot
2018-03-23 16:23:49 +01:00
description: Start a bot
2017-11-15 13:41:58 +01:00
---
## Method: messages.startBot
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Start a bot
2017-11-15 13:41:58 +01:00
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)|
2018-03-27 14:41:50 +02:00
|start\_param|[string](../types/string.md) | Yes|The bot's start parameter|
2017-11-15 13:41:58 +01:00
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-11-15 13:41:58 +01:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-11-15 13:41:58 +01:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-11-15 13:41:58 +01:00
$Updates = $MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => InputPeer, 'start_param' => 'string', ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-11-15 13:41:58 +01:00
### 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:
```
Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', })
```
2018-03-27 14:41:50 +02:00
### 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|