MadelineProto/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md

65 lines
1.4 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: messages.getWebPagePreview
2018-03-23 16:23:49 +01:00
description: Get webpage preview
2017-10-14 11:50:46 +02:00
---
## Method: messages.getWebPagePreview
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Get webpage preview
2017-10-14 11:50:46 +02:00
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-27 14:41:50 +02:00
|message|[string](../types/string.md) | Yes|Extract preview from this message|
2017-10-14 11:50:46 +02:00
### Return type: [MessageMedia](../types/MessageMedia.md)
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-10-14 11:50:46 +02:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-10-14 11:50:46 +02:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-10-14 11:50:46 +02:00
### 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.