MadelineProto/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md

70 lines
1.6 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.getWebPagePreview
2018-03-23 16:23:49 +01:00
description: Get webpage preview
---
2017-01-19 23:02:27 +01:00
## Method: messages.getWebPagePreview
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Get webpage preview
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message|
### Return type: [MessageMedia](../types/MessageMedia.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2017-07-23 16:33:46 +02:00
$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
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.getWebPagePreview`
Parameters:
message - 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
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
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.