MadelineProtoDocs/old_docs/API_docs_v66/methods/messages.startBot.md

59 lines
2.0 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
title: messages.startBot
2019-12-27 17:48:04 +01:00
description: Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking)
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2019-06-24 15:45:02 +02:00
# Method: messages.startBot
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking)
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot | Optional|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to start the bot, can be the bot's private chat or a group | Optional|
|start\_param|[string](../types/string.md) | [Deep linking parameter](https://core.telegram.org/bots#deep-linking) | Yes|
2018-04-01 13:19:25 +02:00
2019-06-24 15:45:02 +02:00
### Return type: [Updates](../types/Updates.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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();
2019-06-24 15:45:02 +02:00
$Updates = $MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => InputPeer, 'start_param' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-06-24 15:45:02 +02:00
Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|BOT_INVALID|This is not a valid bot|
2019-12-27 17:48:04 +01:00
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MSG_ID_INVALID|Invalid message ID provided|
2019-09-02 17:41:28 +02:00
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|START_PARAM_EMPTY|The start parameter is empty|
|400|START_PARAM_INVALID|Start parameter invalid|
2018-04-01 13:19:25 +02:00