2017-04-21 13:27:04 +02:00
|
|
|
---
|
|
|
|
title: messages.getDocumentByHash
|
|
|
|
description: messages.getDocumentByHash parameters, return type and example
|
|
|
|
---
|
|
|
|
## Method: messages.getDocumentByHash
|
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
|
|
|
|
| Name | Type | Required |
|
2017-08-20 11:05:56 +02:00
|
|
|
|----------|---------------|----------|
|
2017-04-21 13:27:04 +02:00
|
|
|
|sha256|[bytes](../types/bytes.md) | Yes|
|
|
|
|
|size|[int](../types/int.md) | Yes|
|
|
|
|
|mime\_type|[string](../types/string.md) | Yes|
|
|
|
|
|
|
|
|
|
|
|
|
### Return type: [Document](../types/Document.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 |
|
|
|
|
|----------|---------------|
|
|
|
|
|SHA256_HASH_INVALID|The provided SHA256 hash is invalid|
|
|
|
|
|
|
|
|
|
2017-04-21 13:27:04 +02:00
|
|
|
### Example:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
|
|
|
if (isset($token)) { // Login as a bot
|
2017-06-19 18:56:47 +02:00
|
|
|
$MadelineProto->bot_login($token);
|
2017-04-21 13:27:04 +02:00
|
|
|
}
|
|
|
|
if (isset($number)) { // Login as a user
|
|
|
|
$sentCode = $MadelineProto->phone_login($number);
|
|
|
|
echo 'Enter the code you received: ';
|
|
|
|
$code = '';
|
|
|
|
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
|
|
|
|
$code .= fgetc(STDIN);
|
|
|
|
}
|
|
|
|
$MadelineProto->complete_phone_login($code);
|
|
|
|
}
|
|
|
|
|
2017-07-23 16:33:46 +02:00
|
|
|
$Document = $MadelineProto->messages->getDocumentByHash(['sha256' => 'bytes', 'size' => int, 'mime_type' => 'string', ]);
|
2017-04-21 13:27:04 +02:00
|
|
|
```
|
|
|
|
|
2017-07-24 01:32:29 +02:00
|
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
2017-07-23 16:11:02 +02:00
|
|
|
|
|
|
|
### As a bot:
|
|
|
|
|
|
|
|
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
* method - messages.getDocumentByHash
|
2017-07-23 16:40:54 +02:00
|
|
|
* params - `{"sha256": "bytes", "size": int, "mime_type": "string", }`
|
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/messages.getDocumentByHash`
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
sha256 - Json encoded bytes
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
size - Json encoded int
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
mime_type - Json encoded string
|
|
|
|
|
2017-07-23 16:40:54 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-04-21 13:27:04 +02:00
|
|
|
Or, if you're into Lua:
|
|
|
|
|
|
|
|
```
|
2017-07-23 16:33:46 +02:00
|
|
|
Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', })
|
2017-04-21 13:27:04 +02:00
|
|
|
```
|
|
|
|
|