2016-12-30 16:32:25 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.getWebPagePreview
description: messages.getWebPagePreview parameters, return type and example
2016-12-30 16:32:25 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.getWebPagePreview
2016-12-30 16:32:25 +01:00
[Back to methods index ](index.md )
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2018-03-20 16:42:05 +01:00
|message|[CLICK ME string](../types/string.md) | Yes|
2016-12-30 16:32:25 +01:00
2017-01-02 19:50:37 +01:00
### Return type: [MessageMedia](../types/MessageMedia.md)
2016-12-30 16:32:25 +01:00
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2016-12-30 16:32:25 +01:00
### Example:
```
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2016-12-30 16:32:25 +01:00
}
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
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();
2016-12-30 16:32:25 +01:00
2017-07-23 16:33:46 +02:00
$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', ]);
2017-02-13 04:33:06 +01:00
```
2017-03-11 19:54:51 +01: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
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
2017-03-11 19:54:51 +01:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
MessageMedia = messages.getWebPagePreview({message='string', })
2017-03-11 19:54:51 +01:00
```
2017-04-21 13:13:24 +02:00
## 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.