mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-15 03:36:55 +01:00
Daniil Gentili
7a0153a139
* Documentation rework * Apply fixes from StyleCI * Documentation fixes * Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite * Apply fixes from StyleCI * Logging fixes * Build docs * Add methods to modify start template, bugfix to logging and keyboard conversion * Add TL documentator * Document MTProto methods * Documenting methods... * 7% documented * Bugfixes * Update docs * Update docs * Simplify file management * Implement automatic object conversion for media, and more awesome stuff * Implement automatic object conversion for media, and more awesome stuff * Implement event update handler and file upload/download callback * Auto-detect mime type, duration, width and height of media * Update docs * Document new file functions * Fix links * Fix links * Update bot.php to use event loop * Implement webhook update handler and forking in main loop * Build docs * Better docs * Fixes to secret chats * Almost finished updating docs * Bugfixes, implemented infinite loop for loop() method, almost finished docs * Finish writing docs * Add automatic documentation builder script * Finished writing docs
78 lines
1.8 KiB
Markdown
78 lines
1.8 KiB
Markdown
---
|
|
title: messages.startBot
|
|
description: messages.startBot parameters, return type and example
|
|
---
|
|
## Method: messages.startBot
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Required |
|
|
|----------|---------------|----------|
|
|
|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|
|
|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
|
|
|start\_param|[string](../types/string.md) | Yes|
|
|
|
|
|
|
### Return type: [Updates](../types/Updates.md)
|
|
|
|
### Can bots use this method: **NO**
|
|
|
|
|
|
### 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|
|
|
|
|
|
|
### Example:
|
|
|
|
|
|
```
|
|
if (!file_exists('madeline.php')) {
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
|
}
|
|
include 'madeline.php';
|
|
|
|
// !!! This API id/API hash combination will not work !!!
|
|
// !!! You must get your own @ my.telegram.org !!!
|
|
$api_id = 0;
|
|
$api_hash = '';
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
|
|
$MadelineProto->start();
|
|
|
|
$Updates = $MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => InputPeer, 'start_param' => 'string', ]);
|
|
```
|
|
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
|
|
|
|
|
|
|
### 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', })
|
|
```
|
|
|