MadelineProtoDocs/old_docs/API_docs_v46/methods/messages.getDocumentByHash.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2019-08-15 20:25:16 +02:00
---
title: messages.getDocumentByHash
2019-12-27 17:48:04 +01:00
description: Get a document by its SHA256 hash, mainly used for gifs
2019-08-15 20:25:16 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: messages.getDocumentByHash
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Get a document by its SHA256 hash, mainly used for gifs
2019-08-15 20:25:16 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|sha256|[bytes](../types/bytes.md) | SHA256 of file | Yes|
|size|[int](../types/int.md) | Size of the file in bytes | Yes|
|mime\_type|[string](../types/string.md) | Mime type | Yes|
2019-08-15 20:25:16 +02:00
### Return type: [Document](../types/Document.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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();
$Document = $MadelineProto->messages->getDocumentByHash(['sha256' => 'bytes', 'size' => int, 'mime_type' => 'string', ]);
```
Or, if you're into Lua:
```lua
Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', })
```
2019-09-02 17:41:28 +02:00
### Errors
2019-08-15 20:25:16 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|SHA256_HASH_INVALID|The provided SHA256 hash is invalid|
2019-08-15 20:25:16 +02:00