MadelineProto/old_docs/API_docs_v27/methods/help_getConfig.md

69 lines
1.2 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: help.getConfig
description: help.getConfig parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: help.getConfig
[Back to methods index](index.md)
### Return type: [Config](../types/Config.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|Timeout|A timeout occurred while fetching data from the bot|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
$Config = $MadelineProto->help->getConfig();
2017-07-23 16:11:02 +02:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - help.getConfig
2017-07-23 16:40:54 +02:00
* params - `{}`
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getConfig`
Parameters:
2017-07-23 16:40:54 +02:00
Or, if you're into Lua:
```
Config = help.getConfig({})
```