MadelineProtoDocs/old_docs/API_docs_v71/methods/messages.editMessage.md

126 lines
4.7 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.editMessage
2019-12-27 17:48:04 +01:00
description: Edit message
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_editMessage.html
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.editMessage
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Edit message
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional|
2019-12-27 17:48:04 +01:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the message sent | Optional|
|id|[int](../types/int.md) | ID of the message to edit | Yes|
|message|[string](../types/string.md) | New message | Optional|
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for inline keyboards | Optional|
2018-08-29 11:18:25 +02:00
|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional|
2018-08-29 11:22:58 +02:00
|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional |
2018-04-01 13:19:25 +02:00
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```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-04-01 13:24:46 +02:00
$Updates = $MadelineProto->messages->editMessage(['no_webpage' => Bool, 'peer' => InputPeer, 'id' => int, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 17:48:04 +01:00
Updates = messages.editMessage({no_webpage=Bool, peer=InputPeer, id=int, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', })
2018-04-01 13:19:25 +02:00
```
## Usage of reply_markup
You can provide bot API reply_markup objects here.
## 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 [Updates](../types/Updates.md) will be returned instead.
2019-12-27 17:48:04 +01:00
## Usage of parseMode:
2018-04-01 13:19:25 +02:00
2019-12-27 17:48:04 +01:00
Set parseMode to html to enable HTML parsing of the message.
2018-04-01 13:19:25 +02:00
2019-12-27 17:48:04 +01:00
Set parseMode to Markdown to enable markown AND html parsing of the message.
2018-04-01 13:19:25 +02:00
The following tags are currently supported:
2018-12-26 02:56:50 +01:00
```html
2018-04-01 13:19:25 +02:00
<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
2019-06-24 15:45:02 +02:00
<u>underline</u>
<s>strikethrough</s>
<del>strikethrough</del>
<strike>strikethrough</strike>
2018-04-01 13:19:25 +02:00
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
2019-06-24 15:45:02 +02:00
<blockquote>pre-formatted fixed-width code block</blockquote>
2018-04-01 13:19:25 +02:00
<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:
2018-12-26 02:56:50 +01:00
```markdown
2018-04-01 13:19:25 +02:00
[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)
```
2019-12-27 17:48:04 +01:00
MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
2020-02-23 19:29:04 +01:00
|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid|
2019-12-27 17:48:04 +01:00
|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is invalid|
|400|BUTTON_URL_INVALID|Button URL invalid|
2019-09-02 17:41:28 +02:00
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
2019-12-27 17:48:04 +01:00
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2019-09-02 17:41:28 +02:00
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
2020-02-23 19:29:04 +01:00
|400|MEDIA_PREV_INVALID|Previous media invalid|
2019-09-02 17:41:28 +02:00
|400|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.|
|400|MESSAGE_EMPTY|The provided message is empty|
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
|400|MESSAGE_NOT_MODIFIED|The message text has not changed|
|400|PEER_ID_INVALID|The provided peer id is invalid|
2020-02-23 19:29:04 +01:00
|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid|
2019-12-27 17:48:04 +01:00
|400|SCHEDULE_DATE_INVALID|Invalid schedule date provided|
2019-09-02 17:41:28 +02:00
|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels|
2019-12-27 17:48:04 +01:00
|403|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2019-09-02 17:41:28 +02:00
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
2019-12-27 17:48:04 +01:00
|403|INLINE_BOT_REQUIRED|Only the inline bot can edit message|
2019-09-02 17:41:28 +02:00
|403|MESSAGE_AUTHOR_REQUIRED|Message author required|
2018-04-01 13:19:25 +02:00