Telethon/methods/phone/request_call.html
2024-09-23 18:48:46 +02:00

34 lines
4.7 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RequestCallRequest</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">Phone</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="request_call.html">RequestCallRequest</a></li></ul><h1>RequestCallRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
phone.requestCall#42ff96ed flags:# video:flags.0?<a href="../../index.html#true">true</a> user_id:<a href="../../types/input_user.html">InputUser</a> random_id:<a href="../../index.html#int">int</a> g_a_hash:<a href="../../index.html#bytes">bytes</a> protocol:<a href="../../types/phone_call_protocol.html">PhoneCallProtocol</a> = <a href="../../types/phone/phone_call.html">phone.PhoneCall</a></pre><button onclick="cp('from telethon.tl.functions.phone import RequestCallRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/phone/phone_call.html">phone.PhoneCall</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/phone/phone_call.html">PhoneCall</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>user_id</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</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>g_a_hash</b></td><td style="text-align:center"><a href="../../index.html#bytes">bytes</a></td><td></td></tr><tr><td><b>protocol</b></td><td style="text-align:center"><a href="../../types/phone_call_protocol.html">PhoneCallProtocol</a></td><td></td></tr><tr><td><b>video</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>random_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td>If left unspecified, it will be inferred automatically.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 6 known errors:</p><table><tr><td><code>CallProtocolFlagsInvalidError</code></td><td>Call protocol flags invalid.</td></tr><tr><td><code>ParticipantCallFailedError</code></td><td>Failure while making call.</td></tr><tr><td><code>ParticipantVersionOutdatedError</code></td><td>The other participant does not use an up to date telegram client with support for calls.</td></tr><tr><td><code>UserIdInvalidError</code></td><td>Invalid object ID for a user. Make sure to pass the right types, for instance making sure that the request is designed for users or otherwise look for a different one more suited.</td></tr><tr><td><code>UserIsBlockedError</code></td><td>User is blocked.</td></tr><tr><td><code>UserPrivacyRestrictedError</code></td><td>The user's privacy settings do not allow you to do this.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><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.phone.RequestCallRequest(
user_id=<em>'username'</em>,
g_a_hash=<em>b'arbitrary\x7f data \xfa here'</em>,
protocol=types.PhoneCallProtocol(
min_layer=42,
max_layer=42,
library_versions=[<em>'some string here'</em>],
udp_p2p=<strong>True</strong>,
udp_reflector=<strong>True</strong>
),
video=<strong>True</strong>
))
print(result.stringify())</pre><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>