@@ -42,16 +42,16 @@ What use would this library be if you couldn't perform any actions?!
4242
4343There are 3 parameters available to get things rolling:
4444
45- Parameter | Description
46- ----------| ------------
47- s | ** s** ecret: This is a special secret value defined in the main ` manager.php ` file.
48- | This parameter is required to call the script via browser!
49- a | ** a** ction: The actual action to perform. (handle (default), set, unset, reset)
50- | ** handle** executes the ` getUpdates ` method; ** set** / ** unset** / ** reset** the Webhook.
51- l | ** l** oop: Number of seconds to loop the script for (used for getUpdates method).
52- | This would be used mainly via CLI, to continually get updates for a certain period.
53- i | ** i** nterval: Number of seconds to wait between getUpdates requests (used for getUpdates method, default: 2).
54- | This would be used mainly via CLI, to continually get updates for a certain period, every ** i** seconds.
45+ | Parameter | Description |
46+ | --------- | ----------- |
47+ | s | ** s** ecret: This is a special secret value defined in the main ` manager.php ` file. |
48+ | | This parameter is required to call the script via browser! |
49+ | a | ** a** ction: The actual action to perform. (handle (default), set, unset, reset) |
50+ | | ** handle** executes the ` getUpdates ` method; ** set** / ** unset** / ** reset** the Webhook. |
51+ | l | ** l** oop: Number of seconds to loop the script for (used for getUpdates method). |
52+ | | This would be used mainly via CLI, to continually get updates for a certain period. |
53+ | i | ** i** nterval: Number of seconds to wait between getUpdates requests (used for getUpdates method, default: 2). |
54+ | | This would be used mainly via CLI, to continually get updates for a certain period, every ** i** seconds. |
5555
5656#### via browser
5757
@@ -148,42 +148,43 @@ For 84 random characters:
148148Apart from the necessary vital parameters, the bot can be easily configured using extra parameters.
149149
150150Enable admins? Add custom command paths? Set up logging?
151- --> All no problem!
151+
152+ ** All no problem!**
152153
153154Here is a list of available extra parameters:
154155
155- Parameter | Description
156- --------- |------------
157- validate_request | Only allow webhook access from valid Telegram API IPs.
158- * bool* | * default is ` true ` *
159- webhook | URL to the manager PHP file used for setting up the Webhook.
160- * string* | * e.g.* ` 'https://example.com/manager.php' `
161- certificate | Path to a self-signed certificate (if necessary).
162- * string* | * e.g.* ` __DIR__ . '/server.crt' `
163- max_connections | Maximum allowed simultaneous HTTPS connections to the webhook
164- * int* | * e.g.* ` 20 `
165- allowed_updates | List the types of updates you want your bot to receive
166- * array* | * e.g.* ` ['message', 'edited_channel_post', 'callback_query'] `
167- logging | Path(s) where to the log files should be put. This is an array that can contain all 3 log file paths (` error ` , ` debug ` and ` update ` ).
168- * array* | * e.g.* ` ['error' => __DIR__ . '/php-telegram-bot-error.log'] `
169- limiter | Enable or disable the limiter functionality
170- * bool* | * e.g.* ` true ` or ` false `
171- admins | An array of user ids that have admin access to your bot.
172- * array* | * e.g.* ` [12345] `
173- mysql | Mysql credentials to connect a database (necessary for [ ` getUpdates ` ] ( #using-getupdates-method ) method!).
174- * array* | * e.g.* ` ['host' => '127.0.0.1', 'user' => 'root', 'password' => 'root', 'database' => 'telegram_bot'] `
175- download_path | Custom download path.
176- * string* | * e.g.* ` __DIR__ . '/Download' `
177- upload_path | Custom upload path.
178- * string* | * e.g.* ` __DIR__ . '/Upload' `
179- commands_paths | A list of custom commands paths.
180- * array* | * e.g.* ` [__DIR__ . '/CustomCommands'] `
181- command_configs | A list of all custom command configs.
182- * array* | * e.g.* ` ['sendtochannel' => ['your_channel' => '@my_channel'] `
183- botan_token | The Botan.io token to be used for analytics.
184- * string* | * e.g.* ` 'botan_12345' `
185- custom_input | Override the custom input of your bot (mostly for testing purposes!).
186- * string* | * e.g.* ` '{"some":"raw", "json":"update"}' `
156+ | Parameter | Description |
157+ | --------- | ----------- |
158+ | validate_request | Only allow webhook access from valid Telegram API IPs. |
159+ | * bool* | * default is ` true ` * |
160+ | webhook | URL to the manager PHP file used for setting up the Webhook. |
161+ | * string* | * e.g.* ` 'https://example.com/manager.php' ` |
162+ | certificate | Path to a self-signed certificate (if necessary). |
163+ | * string* | * e.g.* ` __DIR__ . '/server.crt' ` |
164+ | max_connections | Maximum allowed simultaneous HTTPS connections to the webhook |
165+ | * int* | * e.g.* ` 20 ` |
166+ | allowed_updates | List the types of updates you want your bot to receive |
167+ | * array* | * e.g.* ` ['message', 'edited_channel_post', 'callback_query'] ` |
168+ | logging | Path(s) where to the log files should be put. This is an array that can contain all 3 log file paths (` error ` , ` debug ` and ` update ` ). |
169+ | * array* | * e.g.* ` ['error' => __DIR__ . '/php-telegram-bot-error.log'] ` |
170+ | limiter | Enable or disable the limiter functionality |
171+ | * bool* | * e.g.* ` true ` or ` false ` |
172+ | admins | An array of user ids that have admin access to your bot. |
173+ | * array* | * e.g.* ` [12345] ` |
174+ | mysql | Mysql credentials to connect a database (necessary for [ ` getUpdates ` ] ( #using-getupdates-method ) method!). |
175+ | * array* | * e.g.* ` ['host' => '127.0.0.1', 'user' => 'root', 'password' => 'root', 'database' => 'telegram_bot'] ` |
176+ | download_path | Custom download path. |
177+ | * string* | * e.g.* ` __DIR__ . '/Download' ` |
178+ | upload_path | Custom upload path. |
179+ | * string* | * e.g.* ` __DIR__ . '/Upload' ` |
180+ | commands_paths | A list of custom commands paths. |
181+ | * array* | * e.g.* ` [__DIR__ . '/CustomCommands'] ` |
182+ | command_configs | A list of all custom command configs. |
183+ | * array* | * e.g.* ` ['sendtochannel' => ['your_channel' => '@my_channel'] ` |
184+ | botan_token | The Botan.io token to be used for analytics. |
185+ | * string* | * e.g.* ` 'botan_12345' ` |
186+ | custom_input | Override the custom input of your bot (mostly for testing purposes!). |
187+ | * string* | * e.g.* ` '{"some":"raw", "json":"update"}' ` |
187188
188189### Using getUpdates method
189190
0 commit comments