MadelineProtoDocs/old_docs/API_docs_v70/methods/messages_getWebPage.md

70 lines
1.4 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.getWebPage
description: Get webpage preview
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.getWebPage
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Get webpage preview
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|url|[string](../types/string.md) | URL | Yes|
2018-08-29 17:27:54 +02:00
|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional|
2018-04-01 13:19:25 +02:00
### Return type: [WebPage](../types/WebPage.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2018-08-29 17:18:37 +02:00
$WebPage = $MadelineProto->messages->getWebPage(['url' => 'string', 'hash' => [int, int], ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getWebPage`
Parameters:
url - Json encoded string
2018-08-29 17:18:37 +02:00
hash - Json encoded array of int
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```lua
2018-08-29 17:18:37 +02:00
WebPage = messages.getWebPage({url='string', hash={int}, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|WC_CONVERT_URL_INVALID|WC convert URL invalid|