|
| 1 | +--- |
| 2 | +title: sendSecretPhoto |
| 3 | +parent: /methods |
| 4 | +metas: |
| 5 | + description: Send a photo to a secret chat. User-only. |
| 6 | +--- |
| 7 | + |
| 8 | +Send a photo to a secret chat.<span class="select-none"> <span class="inline-flex w-fit items-center" style="font-size:12px;white-space:nowrap;word-break:keep-all;"><span class="w-fit bg-dbt select-none text-fgt" style="padding:2px 8px;border-radius:12px;">USER-ONLY</span></span> </span> |
| 9 | + |
| 10 | +### Parameters |
| 11 | + |
| 12 | +<div class="flex flex-col gap-3"><div><div class="font-mono" id="p_id" data-anchor="true"><span class="font-bold">id</span><span class="opacity-50">:</span> <span>number</span></div><div class="pl-3"><div class="no-margin"> |
| 13 | + |
| 14 | +The identifier of the secret chat. |
| 15 | + |
| 16 | +</div></div></div><div><div class="font-mono" id="p_photo" data-anchor="true"><span class="font-bold">photo</span><span class="opacity-50">:</span> <a href="/types/filesource">FileSource</a></div><div class="pl-3"><div class="no-margin"> |
| 17 | + |
| 18 | +The photo to send. |
| 19 | + |
| 20 | +</div></div></div><div class="flex flex-col gap-3"><div><div class="flex gap-2"><div class="font-mono p" id="p_width" data-anchor="true"><span class="font-bold">width</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>number</span></div></div><div class="pl-3"><div class="no-margin"> |
| 21 | + |
| 22 | +The width of the photo in pixels. |
| 23 | + |
| 24 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_height" data-anchor="true"><span class="font-bold">height</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>number</span></div></div><div class="pl-3"><div class="no-margin"> |
| 25 | + |
| 26 | +The height of the photo in pixels. |
| 27 | + |
| 28 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_isSilent" data-anchor="true"><span class="font-bold">isSilent</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>boolean</span></div></div><div class="pl-3"><div class="no-margin"> |
| 29 | + |
| 30 | +Whether the message should be sent silently. |
| 31 | + |
| 32 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_replyToMessageId" data-anchor="true"><span class="font-bold">replyToMessageId</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin"> |
| 33 | + |
| 34 | +The identifier of a message to reply to. |
| 35 | + |
| 36 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_ttl" data-anchor="true"><span class="font-bold">ttl</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>number</span></div></div><div class="pl-3"><div class="no-margin"> |
| 37 | + |
| 38 | +The message's time-to-live. |
| 39 | + |
| 40 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_viaBot" data-anchor="true"><span class="font-bold">viaBot</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin"> |
| 41 | + |
| 42 | +The name of the bot that was used to send the message. |
| 43 | + |
| 44 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_fileName" data-anchor="true"><span class="font-bold">fileName</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin"> |
| 45 | + |
| 46 | +The file name to assign if applicable. |
| 47 | + |
| 48 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_fileSize" data-anchor="true"><span class="font-bold">fileSize</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>number</span></div></div><div class="pl-3"><div class="no-margin"> |
| 49 | + |
| 50 | +The file's size. |
| 51 | + |
| 52 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_mimeType" data-anchor="true"><span class="font-bold">mimeType</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin"> |
| 53 | + |
| 54 | +The mime type to assign if applicable. |
| 55 | + |
| 56 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_chunkSize" data-anchor="true"><span class="font-bold">chunkSize</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>number</span></div></div><div class="pl-3"><div class="no-margin"> |
| 57 | + |
| 58 | +Size of each upload chunk in bytes. |
| 59 | + |
| 60 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_signal" data-anchor="true"><span class="font-bold">signal</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span href="/">AbortSignal</span></div></div><div class="pl-3"><div class="no-margin"> |
| 61 | + |
| 62 | +Upload abort signal. |
| 63 | + |
| 64 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_progressId" data-anchor="true"><span class="font-bold">progressId</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin"> |
| 65 | + |
| 66 | +A progress ID retrieved from the method getProgressId. If specified, updates on the upload progress will be sent. |
| 67 | + |
| 68 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_caption" data-anchor="true"><span class="font-bold">caption</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <span>string</span></div></div><div class="pl-3"><div class="no-margin"> |
| 69 | + |
| 70 | +The caption to attach. |
| 71 | + |
| 72 | +</div></div></div><div><div class="flex gap-2"><div class="font-mono p" id="p_entities" data-anchor="true"><span class="font-bold">entities</span><span class="opacity-50"><span title="Optional" class="cursor-help">?</span>:</span> <a href="/types/secretmessageentity">SecretMessageEntity</a><span class="opacity-50">[]</span></div></div><div class="pl-3"><div class="no-margin"> |
| 73 | + |
| 74 | +The caption's entities. |
| 75 | + |
| 76 | +</div></div></div></div></div> |
| 77 | + |
| 78 | +### Result |
| 79 | + |
| 80 | +<div class="font-mono"><span>void</span></div> |
| 81 | + |
| 82 | +### Syntax |
| 83 | + |
| 84 | +```ts |
| 85 | +// Required parameters only. |
| 86 | +await client.sendSecretPhoto(id, photo); |
| 87 | + |
| 88 | +// Required parameters + optional parameters. |
| 89 | +// Any of the optional parameters can be omitted. |
| 90 | +await client.sendSecretPhoto(id, photo, { |
| 91 | + width, |
| 92 | + height, |
| 93 | + isSilent, |
| 94 | + replyToMessageId, |
| 95 | + ttl, |
| 96 | + viaBot, |
| 97 | + fileName, |
| 98 | + fileSize, |
| 99 | + mimeType, |
| 100 | + chunkSize, |
| 101 | + signal, |
| 102 | + progressId, |
| 103 | + caption, |
| 104 | + entities, |
| 105 | +}); |
| 106 | +``` |
| 107 | + |
| 108 | + |
| 109 | + |
0 commit comments