MadelineProtoDocs/docs/API_docs/methods/upload_getWebFile.md

73 lines
1.6 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: upload.getWebFile
description: Download a file through telegram
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: upload.getWebFile
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Download a file through telegram
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes|
|offset|[int](../types/int.md) | The offset in bytes | Yes|
|limit|[int](../types/int.md) | The number of bytes to fetch | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [upload\_WebFile](../types/upload_WebFile.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
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();
$upload_WebFile = $MadelineProto->upload->getWebFile(['location' => InputWebFileLocation, 'offset' => int, 'limit' => int, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/upload.getWebFile`
Parameters:
location - Json encoded InputWebFileLocation
offset - Json encoded int
limit - Json encoded int
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|LOCATION_INVALID|The provided location is invalid|