Telethon/methods/messages/upload_media.html
2024-11-17 22:32:52 +01:00

36 lines
6.0 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UploadMediaRequest</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
<script>
document.getElementById("style").href = "../../css/docs."
+ (localStorage.getItem("theme") || "light")
+ ".css";
</script>
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
rel="stylesheet">
</head>
<body>
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Messages</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="upload_media.html">UploadMediaRequest</a></li></ul><h1>UploadMediaRequest</h1><p><strong>Both users and bots</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
messages.uploadMedia#14967978 flags:# business_connection_id:flags.0?<a href="../../index.html#string">string</a> peer:<a href="../../types/input_peer.html">InputPeer</a> media:<a href="../../types/input_media.html">InputMedia</a> = <a href="../../types/message_media.html">MessageMedia</a></pre><button onclick="cp('from telethon.tl.functions.messages import UploadMediaRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/message_media.html">MessageMedia</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/message_media_contact.html">MessageMediaContact</a></td><td><a href="../../constructors/message_media_dice.html">MessageMediaDice</a></td></tr><tr><td><a href="../../constructors/message_media_document.html">MessageMediaDocument</a></td><td><a href="../../constructors/message_media_empty.html">MessageMediaEmpty</a></td></tr><tr><td><a href="../../constructors/message_media_game.html">MessageMediaGame</a></td><td><a href="../../constructors/message_media_geo.html">MessageMediaGeo</a></td></tr><tr><td><a href="../../constructors/message_media_geo_live.html">MessageMediaGeoLive</a></td><td><a href="../../constructors/message_media_giveaway.html">MessageMediaGiveaway</a></td></tr><tr><td><a href="../../constructors/message_media_giveaway_results.html">MessageMediaGiveawayResults</a></td><td><a href="../../constructors/message_media_invoice.html">MessageMediaInvoice</a></td></tr><tr><td><a href="../../constructors/message_media_paid_media.html">MessageMediaPaidMedia</a></td><td><a href="../../constructors/message_media_photo.html">MessageMediaPhoto</a></td></tr><tr><td><a href="../../constructors/message_media_poll.html">MessageMediaPoll</a></td><td><a href="../../constructors/message_media_story.html">MessageMediaStory</a></td></tr><tr><td><a href="../../constructors/message_media_unsupported.html">MessageMediaUnsupported</a></td><td><a href="../../constructors/message_media_venue.html">MessageMediaVenue</a></td></tr><tr><td><a href="../../constructors/message_media_web_page.html">MessageMediaWebPage</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>media</b></td><td style="text-align:center"><a href="../../types/input_media.html">InputMedia</a></td><td></td></tr><tr><td><b>business_connection_id</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 4 known errors:</p><table><tr><td><code>BotMissingError</code></td><td>This method can only be run by a bot.</td></tr><tr><td><code>MediaInvalidError</code></td><td>Media invalid.</td></tr><tr><td><code>PeerIdInvalidError</code></td><td>An invalid Peer was used. Make sure to pass the right peer type and that the value is valid (for instance, bots cannot start conversations).</td></tr><tr><td><code>PostponedTimeoutError</code></td><td>The postponed call has timed out.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><p>Please refer to the documentation of <a href="https://docs.telethon.dev/en/stable/modules/client.html#telethon.client.uploads.UploadMethods.send_file"><code>client.send_file()</code></a> to learn about the parameters and see several code examples on how to use it.</p><p>The method above is the recommended way to do it. If you need more control over the parameters or want to learn how it is implemented, open the details by clicking on the "Details" text.</p><details><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
<strong>from</strong> telethon <strong>import</strong> functions, types
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
result = client(functions.messages.UploadMediaRequest(
peer=<em>'username'</em>,
media=types.InputMediaUploadedPhoto(
file=client.upload_file(<em>'/path/to/file.jpg'</em>),
spoiler=<strong>True</strong>,
stickers=[types.InputDocument(
id=-12398745604826,
access_hash=-12398745604826,
file_reference=<em>b'arbitrary\x7f data \xfa here'</em>
)],
ttl_seconds=42
),
business_connection_id=<em>'some string here'</em>
))
print(result.stringify())</pre></details><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>