MadelineProtoDocs/docs/API_docs/methods/bots_sendCustomRequest.md

79 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: bots.sendCustomRequest
description: Send a custom request to the bot API
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
---
2018-04-05 01:19:57 +02:00
# Method: bots.sendCustomRequest
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Send a custom request to the bot API
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|custom\_method|[string](../types/string.md) | The method to call | Yes|
|params|[DataJSON](../types/DataJSON.md) | Method parameters | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [DataJSON](../types/DataJSON.md)
### Can bots use this method: **YES**
### MadelineProto Example:
```
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();
$DataJSON = $MadelineProto->bots->sendCustomRequest(['custom_method' => 'string', 'params' => DataJSON, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - bots.sendCustomRequest
* params - `{"custom_method": "string", "params": DataJSON, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/bots.sendCustomRequest`
Parameters:
custom_method - Json encoded string
params - Json encoded DataJSON
Or, if you're into Lua:
```
DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USER_BOT_INVALID|This method can only be called by a bot|