MadelineProtoDocs/old_docs/API_docs_v81/methods/messages.sendMedia.md

139 lines
5.7 KiB
Markdown
Raw Normal View History

2019-06-24 15:45:02 +02:00
---
title: messages.sendMedia
description: Send a media
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_sendMedia.html
2019-06-24 15:45:02 +02:00
---
# Method: messages.sendMedia
[Back to methods index](index.md)
Send a media
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|silent|[Bool](../types/Bool.md) | Send message silently (no notification should be triggered) | Optional|
|background|[Bool](../types/Bool.md) | Send message in background | Optional|
|clear\_draft|[Bool](../types/Bool.md) | Clear the draft | Optional|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination | Optional|
|reply\_to\_msg\_id|[int](../types/int.md) | Message ID to which this message should reply to | Optional|
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Attached media | Optional|
|message|[string](../types/string.md) | Caption | Yes|
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for bot keyboards | Optional|
2019-06-24 15:45:02 +02:00
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional|
|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional |
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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();
$Updates = $MadelineProto->messages->sendMedia(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'media' => InputMedia, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]);
```
Or, if you're into Lua:
```lua
2019-12-27 17:48:04 +01:00
Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, media=InputMedia, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', })
2019-06-24 15:45:02 +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:
2019-06-24 15:45:02 +02:00
2019-12-27 17:48:04 +01:00
Set parseMode to html to enable HTML parsing of the message.
2019-06-24 15:45:02 +02:00
2019-12-27 17:48:04 +01:00
Set parseMode to Markdown to enable markown AND html parsing of the message.
2019-06-24 15:45:02 +02:00
The following tags are currently supported:
```html
<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:
```markdown
[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 |
|------|----------|---------------|
2019-12-27 17:48:04 +01:00
|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid|
|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is 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|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2019-09-13 17:13:55 +02:00
|400|CHAT_RESTRICTED|You can't send messages in this chat, you were restricted|
2019-09-02 17:41:28 +02:00
|400|EXTERNAL_URL_INVALID|External URL invalid|
|400|FILE_PART_LENGTH_INVALID|The length of a file part is invalid|
|400|FILE_PARTS_INVALID|The number of file parts is invalid|
|400|IMAGE_PROCESS_FAILED|Failure while processing image|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MEDIA_CAPTION_TOO_LONG|The caption is too long|
|400|MEDIA_EMPTY|The provided media object is invalid|
|400|MEDIA_INVALID|Media invalid|
2019-10-29 19:02:30 +01:00
|400|MSG_ID_INVALID|Invalid message ID provided|
2019-09-02 17:41:28 +02:00
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|PHOTO_EXT_INVALID|The extension of the photo is invalid|
|400|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid|
2019-10-29 19:02:30 +01:00
|400|PHOTO_SAVE_FILE_INVALID|Internal issues, try again later|
2019-12-27 17:48:04 +01:00
|400|REPLY_MARKUP_BUY_EMPTY|Reply markup for buy button empty|
2019-09-02 17:41:28 +02:00
|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels|
|400|USER_IS_BLOCKED|You were blocked by this user|
|400|USER_IS_BOT|Bots can't send messages to other bots|
|400|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL|
|400|WEBPAGE_MEDIA_EMPTY|Webpage media empty|
2019-12-27 17:48:04 +01:00
|400|YOU_BLOCKED_USER|You blocked this user|
2019-09-02 17:41:28 +02:00
|403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
2019-12-27 17:48:04 +01:00
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.|
2019-09-02 17:41:28 +02:00
|-503|Timeout|Timeout while fetching data|
2019-06-24 15:45:02 +02:00