1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-15 02:26:55 +01:00
MadelineProto/docs/API_docs/methods/messages_getWebPagePreview.md
Daniil Gentili d69a27867f Better docs
2017-08-28 12:44:50 +02:00

66 lines
1.5 KiB
Markdown

---
title: messages.getWebPagePreview
description: messages.getWebPagePreview parameters, return type and example
---
## Method: messages.getWebPagePreview
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|message|[string](../types/string.md) | Yes|
### Return type: [MessageMedia](../types/MessageMedia.md)
### Can bots use this method: **NO**
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
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);
}
$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getWebPagePreview`
Parameters:
message - Json encoded string
Or, if you're into Lua:
```
MessageMedia = messages.getWebPagePreview({message='string', })
```
## Return value
If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [MessageMedia](../types/MessageMedia.md) will be returned instead.