MadelineProtoDocs/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.getDocumentByHash
description: Get document by SHA256 hash
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: messages.getDocumentByHash
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Get document by SHA256 hash
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes|
|size|[int](../types/int.md) | The file size | Yes|
|mime\_type|[string](../types/string.md) | The mime type of the file | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Document](../types/Document.md)
### Can bots use this method: **YES**
2019-05-04 12:15:39 +02:00
### MadelineProto Example ([now async!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Document = $MadelineProto->messages->getDocumentByHash(['sha256' => 'bytes', 'size' => int, 'mime_type' => 'string', ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|SHA256_HASH_INVALID|The provided SHA256 hash is invalid|