danog

3.0 KiB

Raw Blame History

title	description	image	redirect_from
messages.getWebPagePreview	Get preview of webpage	https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png	/API_docs/methods/messages_getWebPagePreview.html

Method: messages.getWebPagePreview

Back to methods index

Get preview of webpage

Parameters:

Name	Type	Description	Required
message	string	Message from which to extract the preview	Yes
entities	Array of MessageEntity	Entities for styled text	Optional
parse_mode	string	Whether to parse HTML or Markdown markup in the message	Optional

Return type: MessageMedia

Can bots use this method: NO

MadelineProto Example (now async for huge speed and parallelism!):

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();

$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]);

Or, if you're into Lua:

MessageMedia = messages.getWebPagePreview({message='string', entities={MessageEntity}, parseMode='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 will be returned instead.

Usage of parseMode:

Set parseMode to html to enable HTML parsing of the message.

Set parseMode to Markdown to enable markown AND html parsing of the message.

The following tags are currently supported:

<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
<u>underline</u>
<s>strikethrough</s>
<del>strikethrough</del>
<strike>strikethrough</strike>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<blockquote>pre-formatted fixed-width code block</blockquote>
<a href="https://github.com">URL</a>
<a href="mention:@danogentili">Mention by username</a>
<a href="mention:186785362">Mention by user id</a>
<pre language="json">Pre tags can have a language attribute</pre>

You can also use normal markdown, note that to create mentions you must use the mention: syntax like in html:

[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)

MadelineProto supports all html entities supported by html_entity_decode.

Errors

Code	Type	Description
400	MESSAGE_EMPTY	The provided message is empty

3.0 KiB Raw Blame History