MadelineProto/docs/API_docs/methods/bots_sendCustomRequest.md

83 lines
1.8 KiB
Markdown
Raw Normal View History

---
title: bots.sendCustomRequest
2018-03-23 16:23:49 +01:00
description: Send a custom request to the bot API
---
## Method: bots.sendCustomRequest
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Send a custom request to the bot API
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call|
|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters|
### Return type: [DataJSON](../types/DataJSON.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 |
|----------|---------------|
|USER_BOT_INVALID|This method can only be called by a bot|
2018-03-20 19:57:36 +01:00
### MadelineProto 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();
2017-07-23 16:33:46 +02:00
$DataJSON = $MadelineProto->bots->sendCustomRequest(['custom_method' => 'string', 'params' => DataJSON, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - bots.sendCustomRequest
2017-07-23 16:40:54 +02:00
* params - `{"custom_method": "string", "params": DataJSON, }`
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/bots.sendCustomRequest`
Parameters:
custom_method - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
params - Json encoded DataJSON
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, })
```