telegrinder 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of telegrinder might be problematic. Click here for more details.
- telegrinder/__init__.py +45 -12
- telegrinder/bot/__init__.py +32 -4
- telegrinder/bot/cute_types/callback_query.py +60 -146
- telegrinder/bot/cute_types/chat_join_request.py +12 -16
- telegrinder/bot/cute_types/chat_member_updated.py +15 -105
- telegrinder/bot/cute_types/inline_query.py +5 -14
- telegrinder/bot/cute_types/message.py +623 -1238
- telegrinder/bot/dispatch/__init__.py +40 -3
- telegrinder/bot/dispatch/abc.py +8 -1
- telegrinder/bot/dispatch/context.py +2 -2
- telegrinder/bot/dispatch/dispatch.py +8 -1
- telegrinder/bot/dispatch/handler/__init__.py +17 -1
- telegrinder/bot/dispatch/handler/audio_reply.py +44 -0
- telegrinder/bot/dispatch/handler/base.py +57 -0
- telegrinder/bot/dispatch/handler/document_reply.py +44 -0
- telegrinder/bot/dispatch/handler/func.py +3 -3
- telegrinder/bot/dispatch/handler/media_group_reply.py +43 -0
- telegrinder/bot/dispatch/handler/message_reply.py +12 -35
- telegrinder/bot/dispatch/handler/photo_reply.py +44 -0
- telegrinder/bot/dispatch/handler/sticker_reply.py +37 -0
- telegrinder/bot/dispatch/handler/video_reply.py +44 -0
- telegrinder/bot/dispatch/process.py +2 -2
- telegrinder/bot/dispatch/return_manager/abc.py +11 -8
- telegrinder/bot/dispatch/return_manager/callback_query.py +2 -2
- telegrinder/bot/dispatch/return_manager/inline_query.py +2 -2
- telegrinder/bot/dispatch/return_manager/message.py +3 -3
- telegrinder/bot/dispatch/view/__init__.py +2 -1
- telegrinder/bot/dispatch/view/abc.py +2 -181
- telegrinder/bot/dispatch/view/base.py +200 -0
- telegrinder/bot/dispatch/view/callback_query.py +3 -3
- telegrinder/bot/dispatch/view/chat_join_request.py +2 -2
- telegrinder/bot/dispatch/view/chat_member.py +2 -3
- telegrinder/bot/dispatch/view/inline_query.py +2 -2
- telegrinder/bot/dispatch/view/message.py +5 -4
- telegrinder/bot/dispatch/view/raw.py +4 -3
- telegrinder/bot/dispatch/waiter_machine/__init__.py +18 -0
- telegrinder/bot/dispatch/waiter_machine/actions.py +10 -0
- telegrinder/bot/dispatch/waiter_machine/hasher/__init__.py +15 -0
- telegrinder/bot/dispatch/waiter_machine/hasher/callback.py +60 -0
- telegrinder/bot/dispatch/waiter_machine/hasher/hasher.py +49 -0
- telegrinder/bot/dispatch/waiter_machine/hasher/message.py +54 -0
- telegrinder/bot/dispatch/waiter_machine/hasher/state.py +19 -0
- telegrinder/bot/dispatch/waiter_machine/machine.py +88 -101
- telegrinder/bot/dispatch/waiter_machine/middleware.py +23 -41
- telegrinder/bot/dispatch/waiter_machine/short_state.py +9 -9
- telegrinder/bot/polling/polling.py +5 -2
- telegrinder/bot/rules/__init__.py +3 -3
- telegrinder/bot/rules/abc.py +6 -5
- telegrinder/bot/rules/adapter/__init__.py +1 -1
- telegrinder/bot/rules/integer.py +1 -1
- telegrinder/bot/rules/is_from.py +19 -0
- telegrinder/bot/rules/state.py +9 -6
- telegrinder/bot/scenario/checkbox.py +5 -5
- telegrinder/bot/scenario/choice.py +2 -2
- telegrinder/client/aiohttp.py +5 -7
- telegrinder/model.py +6 -11
- telegrinder/modules.py +16 -25
- telegrinder/msgspec_json.py +1 -1
- telegrinder/msgspec_utils.py +56 -5
- telegrinder/node/base.py +2 -2
- telegrinder/node/composer.py +5 -9
- telegrinder/node/container.py +6 -1
- telegrinder/node/event.py +2 -0
- telegrinder/node/polymorphic.py +7 -7
- telegrinder/node/rule.py +6 -4
- telegrinder/node/scope.py +3 -3
- telegrinder/node/source.py +4 -2
- telegrinder/node/tools/generator.py +7 -6
- telegrinder/rules.py +2 -2
- telegrinder/tools/__init__.py +10 -10
- telegrinder/tools/functional.py +9 -0
- telegrinder/tools/keyboard.py +6 -1
- telegrinder/tools/loop_wrapper/loop_wrapper.py +4 -5
- telegrinder/tools/magic.py +17 -19
- telegrinder/tools/state_storage/__init__.py +3 -3
- telegrinder/tools/state_storage/abc.py +12 -10
- telegrinder/tools/state_storage/memory.py +9 -6
- telegrinder/types/__init__.py +1 -0
- telegrinder/types/methods.py +10 -2
- telegrinder/types/objects.py +47 -5
- {telegrinder-0.2.1.dist-info → telegrinder-0.3.0.dist-info}/METADATA +4 -5
- telegrinder-0.3.0.dist-info/RECORD +164 -0
- telegrinder-0.2.1.dist-info/RECORD +0 -149
- {telegrinder-0.2.1.dist-info → telegrinder-0.3.0.dist-info}/LICENSE +0 -0
- {telegrinder-0.2.1.dist-info → telegrinder-0.3.0.dist-info}/WHEEL +0 -0
|
@@ -42,7 +42,6 @@ if typing.TYPE_CHECKING:
|
|
|
42
42
|
|
|
43
43
|
from telegrinder.bot.cute_types.callback_query import CallbackQueryCute
|
|
44
44
|
|
|
45
|
-
|
|
46
45
|
MediaType: typing.TypeAlias = typing.Literal[
|
|
47
46
|
"animation",
|
|
48
47
|
"audio",
|
|
@@ -50,6 +49,7 @@ MediaType: typing.TypeAlias = typing.Literal[
|
|
|
50
49
|
"photo",
|
|
51
50
|
"video",
|
|
52
51
|
]
|
|
52
|
+
InputMediaType: typing.TypeAlias = InputMedia | tuple[MediaType, InputFile | str]
|
|
53
53
|
ReplyMarkup: typing.TypeAlias = InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply
|
|
54
54
|
|
|
55
55
|
|
|
@@ -207,44 +207,37 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
207
207
|
protect_content: bool | None = None,
|
|
208
208
|
link_preview_options: LinkPreviewOptions | dict[str, typing.Any] | None = None,
|
|
209
209
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
210
|
-
reply_markup:
|
|
210
|
+
reply_markup: InlineKeyboardMarkup
|
|
211
|
+
| ReplyKeyboardMarkup
|
|
212
|
+
| ReplyKeyboardRemove
|
|
213
|
+
| ForceReply
|
|
214
|
+
| None = None,
|
|
211
215
|
**other: typing.Any,
|
|
212
216
|
) -> Result[MessageCute, APIError]:
|
|
213
217
|
"""Shortcut `API.send_message()`, see the [documentation](https://core.telegram.org/bots/api#sendmessage)
|
|
214
218
|
|
|
215
|
-
Use this method to send
|
|
216
|
-
|
|
217
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
218
|
-
will be sent.
|
|
219
|
-
|
|
220
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
221
|
-
(in the format @channelusername).
|
|
219
|
+
Use this method to send text messages. On success, the sent Message is returned.
|
|
220
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
222
221
|
|
|
223
|
-
:param
|
|
224
|
-
forum supergroups only.
|
|
222
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
225
223
|
|
|
226
|
-
:param
|
|
224
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
227
225
|
|
|
228
|
-
:param
|
|
229
|
-
|
|
226
|
+
:param text: Text of the message to be sent, 1-4096 characters after entities parsing.
|
|
227
|
+
:param parse_mode: Mode for parsing entities in the message text. See formatting options formore details.
|
|
230
228
|
|
|
231
|
-
:param entities: A JSON-serialized list of special entities that appear in message text,
|
|
232
|
-
which can be specified instead of parse_mode.
|
|
233
|
-
|
|
234
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
235
|
-
chats only.
|
|
229
|
+
:param entities: A JSON-serialized list of special entities that appear in message text,which can be specified instead of parse_mode.
|
|
236
230
|
|
|
237
231
|
:param link_preview_options: Link preview generation options for the message.
|
|
238
232
|
|
|
239
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
240
|
-
|
|
233
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
241
234
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
242
235
|
|
|
236
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
237
|
+
|
|
243
238
|
:param reply_parameters: Description of the message to reply to.
|
|
244
239
|
|
|
245
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
246
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
247
|
-
or to force a reply from the user."""
|
|
240
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
248
241
|
|
|
249
242
|
...
|
|
250
243
|
|
|
@@ -255,7 +248,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
255
248
|
)
|
|
256
249
|
async def reply(
|
|
257
250
|
self,
|
|
258
|
-
text: str
|
|
251
|
+
text: str,
|
|
259
252
|
chat_id: int | str | None = None,
|
|
260
253
|
message_id: int | None = None,
|
|
261
254
|
message_thread_id: int | None = None,
|
|
@@ -265,46 +258,39 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
265
258
|
entities: list[MessageEntity] | None = None,
|
|
266
259
|
disable_notification: bool | None = None,
|
|
267
260
|
protect_content: bool | None = None,
|
|
268
|
-
link_preview_options: LinkPreviewOptions |
|
|
261
|
+
link_preview_options: LinkPreviewOptions | None = None,
|
|
269
262
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
270
|
-
reply_markup:
|
|
263
|
+
reply_markup: InlineKeyboardMarkup
|
|
264
|
+
| ReplyKeyboardMarkup
|
|
265
|
+
| ReplyKeyboardRemove
|
|
266
|
+
| ForceReply
|
|
267
|
+
| None = None,
|
|
271
268
|
**other: typing.Any,
|
|
272
269
|
) -> Result[MessageCute, APIError]:
|
|
273
270
|
"""Shortcut `API.send_message()`, see the [documentation](https://core.telegram.org/bots/api#sendmessage)
|
|
274
271
|
|
|
275
|
-
Use this method to send
|
|
276
|
-
|
|
277
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
278
|
-
will be sent.
|
|
279
|
-
|
|
280
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
281
|
-
(in the format @channelusername).
|
|
282
|
-
|
|
283
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
284
|
-
forum supergroups only.
|
|
272
|
+
Use this method to send text messages. On success, the sent Message is returned.
|
|
273
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
285
274
|
|
|
286
|
-
:param
|
|
275
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
287
276
|
|
|
288
|
-
:param
|
|
289
|
-
more details.
|
|
277
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
290
278
|
|
|
291
|
-
:param
|
|
292
|
-
|
|
279
|
+
:param text: Text of the message to be sent, 1-4096 characters after entities parsing.
|
|
280
|
+
:param parse_mode: Mode for parsing entities in the message text. See formatting options formore details.
|
|
293
281
|
|
|
294
|
-
:param
|
|
295
|
-
chats only.
|
|
282
|
+
:param entities: A JSON-serialized list of special entities that appear in message text,which can be specified instead of parse_mode.
|
|
296
283
|
|
|
297
284
|
:param link_preview_options: Link preview generation options for the message.
|
|
298
285
|
|
|
299
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
300
|
-
|
|
286
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
301
287
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
302
288
|
|
|
289
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
290
|
+
|
|
303
291
|
:param reply_parameters: Description of the message to reply to.
|
|
304
292
|
|
|
305
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
306
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
307
|
-
or to force a reply from the user."""
|
|
293
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
308
294
|
|
|
309
295
|
...
|
|
310
296
|
|
|
@@ -328,15 +314,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
328
314
|
can delete outgoing messages in channels. - If the bot is an administrator
|
|
329
315
|
of a group, it can delete any message there. - If the bot has can_delete_messages
|
|
330
316
|
permission in a supergroup or a channel, it can delete any message there.
|
|
331
|
-
Returns True on success.
|
|
332
|
-
|
|
333
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
334
|
-
(in the format @channelusername).
|
|
335
|
-
|
|
336
|
-
:param message_id: Identifier of the message to delete.
|
|
337
|
-
|
|
338
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
339
|
-
forum supergroups only."""
|
|
317
|
+
Returns True on success."""
|
|
340
318
|
|
|
341
319
|
params = compose_method_params(
|
|
342
320
|
params=get_params(locals()),
|
|
@@ -353,38 +331,37 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
353
331
|
)
|
|
354
332
|
async def edit(
|
|
355
333
|
self,
|
|
356
|
-
text: str
|
|
357
|
-
chat_id: int | None = None,
|
|
334
|
+
text: str,
|
|
335
|
+
chat_id: int | str | None = None,
|
|
358
336
|
message_id: int | None = None,
|
|
359
337
|
message_thread_id: int | None = None,
|
|
360
338
|
parse_mode: str | None = None,
|
|
361
339
|
entities: list[MessageEntity] | None = None,
|
|
362
340
|
link_preview_options: LinkPreviewOptions | dict[str, typing.Any] | None = None,
|
|
363
341
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
342
|
+
business_connection_id: str | None = None,
|
|
343
|
+
inline_message_id: str | None = None,
|
|
364
344
|
**other: typing.Any,
|
|
365
345
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
366
346
|
"""Shortcut `API.edit_message_text()`, see the [documentation](https://core.telegram.org/bots/api#editmessagetext)
|
|
367
347
|
|
|
368
348
|
Use this method to edit text and game messages. On success, if the edited
|
|
369
349
|
message is not an inline message, the edited Message is returned, otherwise
|
|
370
|
-
True is returned.
|
|
350
|
+
True is returned. Note that business messages that were not sent by the bot
|
|
351
|
+
and do not contain an inline keyboard can only be edited within 48 hours from
|
|
352
|
+
the time they were sent.
|
|
353
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messageto be edited was sent.
|
|
371
354
|
|
|
372
|
-
:param chat_id: Required if inline_message_id is not specified. Unique identifier
|
|
373
|
-
|
|
355
|
+
:param chat_id: Required if inline_message_id is not specified. Unique identifier forthe target chat or username of the target channel (in the format @channelusername).
|
|
356
|
+
:param message_id: Required if inline_message_id is not specified. Identifier of the messageto edit.
|
|
374
357
|
|
|
375
|
-
:param
|
|
376
|
-
to edit.
|
|
377
|
-
|
|
378
|
-
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the \
|
|
379
|
-
inline message.
|
|
358
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
380
359
|
|
|
381
360
|
:param text: New text of the message, 1-4096 characters after entities parsing.
|
|
382
361
|
|
|
383
|
-
:param parse_mode: Mode for parsing entities in the message text. See formatting options
|
|
384
|
-
more details.
|
|
362
|
+
:param parse_mode: Mode for parsing entities in the message text. See formatting options formore details.
|
|
385
363
|
|
|
386
|
-
:param entities: A JSON-serialized list of special entities that appear in message text,
|
|
387
|
-
which can be specified instead of parse_mode.
|
|
364
|
+
:param entities: A JSON-serialized list of special entities that appear in message text,which can be specified instead of parse_mode.
|
|
388
365
|
|
|
389
366
|
:param link_preview_options: Link preview generation options for the message.
|
|
390
367
|
|
|
@@ -408,48 +385,22 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
408
385
|
disable_notification: bool | None = None,
|
|
409
386
|
protect_content: bool | None = None,
|
|
410
387
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
411
|
-
reply_markup:
|
|
388
|
+
reply_markup: InlineKeyboardMarkup
|
|
389
|
+
| ReplyKeyboardMarkup
|
|
390
|
+
| ReplyKeyboardRemove
|
|
391
|
+
| ForceReply
|
|
392
|
+
| None = None,
|
|
393
|
+
show_caption_above_media: bool | None = None,
|
|
412
394
|
**other: typing.Any,
|
|
413
395
|
) -> Result[MessageId, APIError]:
|
|
414
396
|
"""Shortcut `API.copy_message()`, see the [documentation](https://core.telegram.org/bots/api#copymessage)
|
|
415
397
|
|
|
416
|
-
Use this method to copy messages of any kind. Service messages,
|
|
417
|
-
messages, giveaway winners messages, and invoice
|
|
418
|
-
A quiz poll can be copied only if the value of the
|
|
419
|
-
is known to the bot. The method is analogous to
|
|
420
|
-
but the copied message doesn't have a link to
|
|
421
|
-
the MessageId of the sent message on success.
|
|
422
|
-
|
|
423
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
424
|
-
(in the format @channelusername).
|
|
425
|
-
|
|
426
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
427
|
-
forum supergroups only.
|
|
428
|
-
|
|
429
|
-
:param from_chat_id: Unique identifier for the chat where the original message was sent (or channel \
|
|
430
|
-
username in the format @channelusername).
|
|
431
|
-
|
|
432
|
-
:param message_id: Message identifier in the chat specified in from_chat_id.
|
|
433
|
-
|
|
434
|
-
:param caption: New caption for media, 0-1024 characters after entities parsing. If not \
|
|
435
|
-
specified, the original caption is kept.
|
|
436
|
-
|
|
437
|
-
:param parse_mode: Mode for parsing entities in the new caption. See formatting options for \
|
|
438
|
-
more details.
|
|
439
|
-
|
|
440
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the new caption, \
|
|
441
|
-
which can be specified instead of parse_mode.
|
|
442
|
-
|
|
443
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
444
|
-
|
|
445
|
-
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
446
|
-
|
|
447
|
-
:param reply_parameters: Description of the message to reply to.
|
|
448
|
-
|
|
449
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an inline \
|
|
450
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
451
|
-
or to force a reply from the user.
|
|
452
|
-
"""
|
|
398
|
+
Use this method to copy messages of any kind. Service messages, paid media
|
|
399
|
+
messages, giveaway messages, giveaway winners messages, and invoice
|
|
400
|
+
messages can't be copied. A quiz poll can be copied only if the value of the
|
|
401
|
+
field correct_option_id is known to the bot. The method is analogous to
|
|
402
|
+
the method forwardMessage, but the copied message doesn't have a link to
|
|
403
|
+
the original message. Returns the MessageId of the sent message on success."""
|
|
453
404
|
|
|
454
405
|
params = compose_method_params(
|
|
455
406
|
params=get_params(locals()),
|
|
@@ -488,24 +439,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
488
439
|
Use this method to change the chosen reactions on a message. Service messages
|
|
489
440
|
can't be reacted to. Automatically forwarded messages from a channel to
|
|
490
441
|
its discussion group have the same available reactions as messages in the
|
|
491
|
-
channel. Returns True on success.
|
|
492
|
-
|
|
493
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
494
|
-
(in the format @channelusername).
|
|
495
|
-
|
|
496
|
-
:param message_id: Identifier of the target message. If the message belongs to a media group, \
|
|
497
|
-
the reaction is set to the first non-deleted message in the group instead. \
|
|
498
|
-
|
|
499
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
500
|
-
forum supergroups only.
|
|
501
|
-
|
|
502
|
-
:param reaction: New list of reaction types to set on the message. Currently, as non-premium \
|
|
503
|
-
users, bots can set up to one reaction per message. A custom emoji reaction \
|
|
504
|
-
can be used if it is either already present on the message or explicitly allowed \
|
|
505
|
-
by chat administrators.
|
|
506
|
-
|
|
507
|
-
:param is_big: Pass True to set the reaction with a big animation.
|
|
508
|
-
"""
|
|
442
|
+
channel. Bots can't use paid reactions. Returns True on success."""
|
|
509
443
|
|
|
510
444
|
params = compose_method_params(
|
|
511
445
|
params=get_params(locals()),
|
|
@@ -535,20 +469,14 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
535
469
|
Use this method to forward messages of any kind. Service messages and messages
|
|
536
470
|
with protected content can't be forwarded. On success, the sent Message
|
|
537
471
|
is returned.
|
|
472
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
538
473
|
|
|
539
|
-
:param
|
|
540
|
-
(in the format @channelusername).
|
|
541
|
-
|
|
542
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
543
|
-
forum supergroups only.
|
|
544
|
-
|
|
545
|
-
:param from_chat_id: Unique identifier for the chat where the original message was sent (or channel \
|
|
546
|
-
username in the format @channelusername).
|
|
474
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
547
475
|
|
|
548
|
-
:param
|
|
549
|
-
|
|
550
|
-
:param protect_content: Protects the contents of the forwarded message from forwarding and saving. \
|
|
476
|
+
:param from_chat_id: Unique identifier for the chat where the original message was sent (or channelusername in the format @channelusername).
|
|
551
477
|
|
|
478
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
479
|
+
:param protect_content: Protects the contents of the forwarded message from forwarding and saving.
|
|
552
480
|
:param message_id: Message identifier in the chat specified in from_chat_id."""
|
|
553
481
|
|
|
554
482
|
params = compose_method_params(
|
|
@@ -572,6 +500,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
572
500
|
message_id: int | None = None,
|
|
573
501
|
message_thread_id: int | None = None,
|
|
574
502
|
disable_notification: bool | None = None,
|
|
503
|
+
business_connection_id: str | None = None,
|
|
575
504
|
**other: typing.Any,
|
|
576
505
|
) -> Result[bool, "APIError"]:
|
|
577
506
|
"""Shortcut `API.pin_chat_message()`, see the [documentation](https://core.telegram.org/bots/api#pinchatmessage)
|
|
@@ -581,19 +510,13 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
581
510
|
for this to work and must have the 'can_pin_messages' administrator right
|
|
582
511
|
in a supergroup or 'can_edit_messages' administrator right in a channel.
|
|
583
512
|
Returns True on success.
|
|
513
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be pinned.
|
|
584
514
|
|
|
585
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel
|
|
586
|
-
(in the format @channelusername).
|
|
587
|
-
|
|
588
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
589
|
-
forum supergroups only.
|
|
515
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
590
516
|
|
|
591
517
|
:param message_id: Identifier of a message to pin.
|
|
592
518
|
|
|
593
|
-
:param disable_notification: Pass True if it is not necessary to send a notification to all chat
|
|
594
|
-
about the new pinned message. Notifications are always disabled in channels \
|
|
595
|
-
and private chats.
|
|
596
|
-
"""
|
|
519
|
+
:param disable_notification: Pass True if it is not necessary to send a notification to all chat membersabout the new pinned message. Notifications are always disabled in channelsand private chats."""
|
|
597
520
|
|
|
598
521
|
params = compose_method_params(
|
|
599
522
|
params=get_params(locals()),
|
|
@@ -609,6 +532,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
609
532
|
chat_id: int | str | None = None,
|
|
610
533
|
message_id: int | None = None,
|
|
611
534
|
message_thread_id: int | None = None,
|
|
535
|
+
business_connection_id: str | None = None,
|
|
612
536
|
**other: typing.Any,
|
|
613
537
|
) -> Result[bool, "APIError"]:
|
|
614
538
|
"""Shortcut `API.unpin_chat_message()`, see the [documentation](https://core.telegram.org/bots/api#unpinchatmessage)
|
|
@@ -618,13 +542,11 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
618
542
|
for this to work and must have the 'can_pin_messages' administrator right
|
|
619
543
|
in a supergroup or 'can_edit_messages' administrator right in a channel.
|
|
620
544
|
Returns True on success.
|
|
545
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be unpinned.
|
|
621
546
|
|
|
622
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel
|
|
623
|
-
(in the format @channelusername).
|
|
547
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
624
548
|
|
|
625
|
-
:param message_id: Identifier of
|
|
626
|
-
message (by sending date) will be unpinned.
|
|
627
|
-
"""
|
|
549
|
+
:param message_id: Identifier of the message to unpin. Required if business_connection_idis specified. If not specified, the most recent pinned message (by sendingdate) will be unpinned."""
|
|
628
550
|
|
|
629
551
|
params = compose_method_params(
|
|
630
552
|
params=get_params(locals()),
|
|
@@ -656,7 +578,11 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
656
578
|
disable_notification: bool | None = None,
|
|
657
579
|
protect_content: bool | None = None,
|
|
658
580
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
659
|
-
reply_markup:
|
|
581
|
+
reply_markup: InlineKeyboardMarkup
|
|
582
|
+
| ReplyKeyboardMarkup
|
|
583
|
+
| ReplyKeyboardRemove
|
|
584
|
+
| ForceReply
|
|
585
|
+
| None = None,
|
|
660
586
|
**other: typing.Any,
|
|
661
587
|
) -> Result[MessageCute, APIError]:
|
|
662
588
|
"""Shortcut `API.send_audio()`, see the [documentation](https://core.telegram.org/bots/api#sendaudio)
|
|
@@ -666,31 +592,18 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
666
592
|
success, the sent Message is returned. Bots can currently send audio files
|
|
667
593
|
of up to 50 MB in size, this limit may be changed in the future. For sending
|
|
668
594
|
voice messages, use the sendVoice method instead.
|
|
595
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
669
596
|
|
|
670
|
-
:param
|
|
671
|
-
will be sent.
|
|
672
|
-
|
|
673
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
674
|
-
(in the format @channelusername).
|
|
675
|
-
|
|
676
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
677
|
-
forum supergroups only.
|
|
597
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
678
598
|
|
|
679
|
-
:param
|
|
680
|
-
chats only.
|
|
681
|
-
|
|
682
|
-
:param audio: Audio file to send. Pass a file_id as String to send an audio file that exists \
|
|
683
|
-
on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
684
|
-
to get an audio file from the Internet, or upload a new one using multipart/form-data. \
|
|
685
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
599
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
686
600
|
|
|
601
|
+
:param audio: Audio file to send. Pass a file_id as String to send an audio file that existson the Telegram servers (recommended), pass an HTTP URL as a String for Telegramto get an audio file from the Internet, or upload a new one using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
687
602
|
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
688
603
|
|
|
689
|
-
:param parse_mode: Mode for parsing entities in the audio caption. See formatting
|
|
690
|
-
for more details.
|
|
604
|
+
:param parse_mode: Mode for parsing entities in the audio caption. See formatting optionsfor more details.
|
|
691
605
|
|
|
692
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
693
|
-
which can be specified instead of parse_mode.
|
|
606
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
694
607
|
|
|
695
608
|
:param duration: Duration of the audio in seconds.
|
|
696
609
|
|
|
@@ -698,23 +611,15 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
698
611
|
|
|
699
612
|
:param title: Track name.
|
|
700
613
|
|
|
701
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
702
|
-
|
|
703
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
704
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
705
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
706
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
707
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
708
|
-
|
|
709
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
710
|
-
|
|
614
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
615
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
711
616
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
712
617
|
|
|
618
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
619
|
+
|
|
713
620
|
:param reply_parameters: Description of the message to reply to.
|
|
714
621
|
|
|
715
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
716
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
717
|
-
or to force a reply from the user."""
|
|
622
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
718
623
|
|
|
719
624
|
...
|
|
720
625
|
|
|
@@ -742,7 +647,11 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
742
647
|
disable_notification: bool | None = None,
|
|
743
648
|
protect_content: bool | None = None,
|
|
744
649
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
745
|
-
reply_markup:
|
|
650
|
+
reply_markup: InlineKeyboardMarkup
|
|
651
|
+
| ReplyKeyboardMarkup
|
|
652
|
+
| ReplyKeyboardRemove
|
|
653
|
+
| ForceReply
|
|
654
|
+
| None = None,
|
|
746
655
|
**other: typing.Any,
|
|
747
656
|
) -> Result[MessageCute, APIError]:
|
|
748
657
|
"""Shortcut `API.send_animation()`, see the [documentation](https://core.telegram.org/bots/api#sendanimation)
|
|
@@ -750,60 +659,37 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
750
659
|
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without
|
|
751
660
|
sound). On success, the sent Message is returned. Bots can currently send
|
|
752
661
|
animation files of up to 50 MB in size, this limit may be changed in the future.
|
|
662
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
753
663
|
|
|
754
|
-
:param
|
|
755
|
-
will be sent.
|
|
756
|
-
|
|
757
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
758
|
-
(in the format @channelusername).
|
|
664
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
759
665
|
|
|
760
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
761
|
-
forum supergroups only.
|
|
762
|
-
|
|
763
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
764
|
-
chats only.
|
|
765
|
-
|
|
766
|
-
:param animation: Animation to send. Pass a file_id as String to send an animation that exists \
|
|
767
|
-
on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
768
|
-
to get an animation from the Internet, or upload a new animation using multipart/form-data. \
|
|
769
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
666
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
770
667
|
|
|
668
|
+
:param animation: Animation to send. Pass a file_id as String to send an animation that existson the Telegram servers (recommended), pass an HTTP URL as a String for Telegramto get an animation from the Internet, or upload a new animation using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
771
669
|
:param duration: Duration of sent animation in seconds.
|
|
772
670
|
|
|
773
671
|
:param width: Animation width.
|
|
774
672
|
|
|
775
673
|
:param height: Animation height.
|
|
776
674
|
|
|
777
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
778
|
-
|
|
779
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
780
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
781
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
782
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
783
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
784
|
-
|
|
785
|
-
:param caption: Animation caption (may also be used when resending animation by file_id), \
|
|
786
|
-
0-1024 characters after entities parsing.
|
|
675
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
676
|
+
:param caption: Animation caption (may also be used when resending animation by file_id),0-1024 characters after entities parsing.
|
|
787
677
|
|
|
788
|
-
:param parse_mode: Mode for parsing entities in the animation caption. See formatting
|
|
789
|
-
for more details.
|
|
678
|
+
:param parse_mode: Mode for parsing entities in the animation caption. See formatting optionsfor more details.
|
|
790
679
|
|
|
791
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
792
|
-
which can be specified instead of parse_mode.
|
|
680
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
793
681
|
|
|
794
682
|
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
795
683
|
|
|
796
|
-
:param has_spoiler: Pass True if the animation needs to be covered with a spoiler animation.
|
|
797
|
-
|
|
798
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
799
|
-
|
|
684
|
+
:param has_spoiler: Pass True if the animation needs to be covered with a spoiler animation.
|
|
685
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
800
686
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
801
687
|
|
|
688
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
689
|
+
|
|
802
690
|
:param reply_parameters: Description of the message to reply to.
|
|
803
691
|
|
|
804
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
805
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
806
|
-
or to force a reply from the user."""
|
|
692
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
807
693
|
|
|
808
694
|
...
|
|
809
695
|
|
|
@@ -828,7 +714,11 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
828
714
|
disable_notification: bool | None = None,
|
|
829
715
|
protect_content: bool | None = None,
|
|
830
716
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
831
|
-
reply_markup:
|
|
717
|
+
reply_markup: InlineKeyboardMarkup
|
|
718
|
+
| ReplyKeyboardMarkup
|
|
719
|
+
| ReplyKeyboardRemove
|
|
720
|
+
| ForceReply
|
|
721
|
+
| None = None,
|
|
832
722
|
**other: typing.Any,
|
|
833
723
|
) -> Result[MessageCute, APIError]:
|
|
834
724
|
"""Shortcut `API.send_document()`, see the [documentation](https://core.telegram.org/bots/api#senddocument)
|
|
@@ -836,55 +726,30 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
836
726
|
Use this method to send general files. On success, the sent Message is returned.
|
|
837
727
|
Bots can currently send files of any type of up to 50 MB in size, this limit
|
|
838
728
|
may be changed in the future.
|
|
729
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
839
730
|
|
|
840
|
-
:param
|
|
841
|
-
will be sent.
|
|
842
|
-
|
|
843
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
844
|
-
chats only.
|
|
845
|
-
|
|
846
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
847
|
-
(in the format @channelusername).
|
|
848
|
-
|
|
849
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
850
|
-
forum supergroups only.
|
|
851
|
-
|
|
852
|
-
:param document: File to send. Pass a file_id as String to send a file that exists on the Telegram \
|
|
853
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
854
|
-
file from the Internet, or upload a new one using multipart/form-data. \
|
|
855
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
856
|
-
|
|
857
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the \
|
|
858
|
-
file is supported server-side. The thumbnail should be in JPEG format and \
|
|
859
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
860
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
861
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
862
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
863
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
731
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
864
732
|
|
|
865
|
-
:param
|
|
866
|
-
0-1024 characters after entities parsing.
|
|
733
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
867
734
|
|
|
868
|
-
:param
|
|
869
|
-
for
|
|
735
|
+
:param document: File to send. Pass a file_id as String to send a file that exists on the Telegramservers (recommended), pass an HTTP URL as a String for Telegram to get afile from the Internet, or upload a new one using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
736
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
737
|
+
:param caption: Document caption (may also be used when resending documents by file_id),0-1024 characters after entities parsing.
|
|
870
738
|
|
|
871
|
-
:param
|
|
872
|
-
which can be specified instead of parse_mode.
|
|
739
|
+
:param parse_mode: Mode for parsing entities in the document caption. See formatting optionsfor more details.
|
|
873
740
|
|
|
874
|
-
:param
|
|
875
|
-
using multipart/form-data.
|
|
741
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
876
742
|
|
|
877
|
-
:param
|
|
878
|
-
|
|
879
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
743
|
+
:param disable_content_type_detection: Disables automatic server-side content type detection for files uploadedusing multipart/form-data.
|
|
880
744
|
|
|
745
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
881
746
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
882
747
|
|
|
748
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
749
|
+
|
|
883
750
|
:param reply_parameters: Description of the message to reply to.
|
|
884
751
|
|
|
885
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
886
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
887
|
-
or to force a reply from the user."""
|
|
752
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
888
753
|
|
|
889
754
|
...
|
|
890
755
|
|
|
@@ -908,54 +773,41 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
908
773
|
disable_notification: bool | None = None,
|
|
909
774
|
protect_content: bool | None = None,
|
|
910
775
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
911
|
-
reply_markup:
|
|
776
|
+
reply_markup: InlineKeyboardMarkup
|
|
777
|
+
| ReplyKeyboardMarkup
|
|
778
|
+
| ReplyKeyboardRemove
|
|
779
|
+
| ForceReply
|
|
780
|
+
| None = None,
|
|
912
781
|
**other: typing.Any,
|
|
913
782
|
) -> Result[MessageCute, APIError]:
|
|
914
783
|
"""Shortcut `API.send_photo()`, see the [documentation](https://core.telegram.org/bots/api#sendphoto)
|
|
915
784
|
|
|
916
785
|
Use this method to send photos. On success, the sent Message is returned.
|
|
786
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
917
787
|
|
|
918
|
-
:param
|
|
919
|
-
will be sent.
|
|
788
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
920
789
|
|
|
921
|
-
:param
|
|
922
|
-
(in the format @channelusername).
|
|
790
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
923
791
|
|
|
924
|
-
:param
|
|
925
|
-
|
|
792
|
+
:param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegramservers (recommended), pass an HTTP URL as a String for Telegram to get aphoto from the Internet, or upload a new photo using multipart/form-data.The photo must be at most 10 MB in size. The photo's width and height must notexceed 10000 in total. Width and height ratio must be at most 20. More informationon Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
793
|
+
:param caption: Photo caption (may also be used when resending photos by file_id), 0-1024characters after entities parsing.
|
|
926
794
|
|
|
927
|
-
:param
|
|
928
|
-
chats only.
|
|
795
|
+
:param parse_mode: Mode for parsing entities in the photo caption. See formatting optionsfor more details.
|
|
929
796
|
|
|
930
|
-
:param
|
|
931
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
932
|
-
photo from the Internet, or upload a new photo using multipart/form-data. \
|
|
933
|
-
The photo must be at most 10 MB in size. The photo's width and height must not \
|
|
934
|
-
exceed 10000 in total. Width and height ratio must be at most 20. More information \
|
|
935
|
-
on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
797
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
936
798
|
|
|
937
|
-
:param
|
|
938
|
-
characters after entities parsing.
|
|
939
|
-
|
|
940
|
-
:param parse_mode: Mode for parsing entities in the photo caption. See formatting options \
|
|
941
|
-
for more details.
|
|
942
|
-
|
|
943
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
944
|
-
which can be specified instead of parse_mode.
|
|
799
|
+
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
945
800
|
|
|
946
801
|
:param has_spoiler: Pass True if the photo needs to be covered with a spoiler animation.
|
|
947
802
|
|
|
948
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
949
|
-
|
|
803
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
950
804
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
951
805
|
|
|
952
|
-
:param
|
|
806
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
953
807
|
|
|
954
808
|
:param reply_parameters: Description of the message to reply to.
|
|
955
809
|
|
|
956
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
957
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
958
|
-
or to force a reply from the user."""
|
|
810
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
959
811
|
|
|
960
812
|
...
|
|
961
813
|
|
|
@@ -975,44 +827,35 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
975
827
|
disable_notification: bool | None = None,
|
|
976
828
|
protect_content: bool | None = None,
|
|
977
829
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
978
|
-
reply_markup:
|
|
830
|
+
reply_markup: InlineKeyboardMarkup
|
|
831
|
+
| ReplyKeyboardMarkup
|
|
832
|
+
| ReplyKeyboardRemove
|
|
833
|
+
| ForceReply
|
|
834
|
+
| None = None,
|
|
979
835
|
**other: typing.Any,
|
|
980
836
|
) -> Result[MessageCute, APIError]:
|
|
981
837
|
"""Shortcut `API.send_sticker()`, see the [documentation](https://core.telegram.org/bots/api#sendsticker)
|
|
982
838
|
|
|
983
839
|
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers.
|
|
984
840
|
On success, the sent Message is returned.
|
|
841
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
985
842
|
|
|
986
|
-
:param
|
|
987
|
-
will be sent.
|
|
988
|
-
|
|
989
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
990
|
-
(in the format @channelusername).
|
|
843
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
991
844
|
|
|
992
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
993
|
-
forum supergroups only.
|
|
845
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
994
846
|
|
|
995
|
-
:param
|
|
996
|
-
chats only.
|
|
997
|
-
|
|
998
|
-
:param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the \
|
|
999
|
-
Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
1000
|
-
to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker \
|
|
1001
|
-
using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1002
|
-
Video stickers can only be sent by a file_id. Animated stickers can't be \
|
|
1003
|
-
sent via an HTTP URL.
|
|
847
|
+
:param sticker: Sticker to send. Pass a file_id as String to send a file that exists on theTelegram servers (recommended), pass an HTTP URL as a String for Telegramto get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBMsticker using multipart/form-data. More information on Sending Files:https://core.telegram.org/bots/api#sending-files. Video and animatedstickers can't be sent via an HTTP URL.
|
|
1004
848
|
|
|
1005
849
|
:param emoji: Emoji associated with the sticker; only for just uploaded stickers.
|
|
1006
850
|
|
|
1007
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1008
|
-
|
|
851
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1009
852
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1010
853
|
|
|
854
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
855
|
+
|
|
1011
856
|
:param reply_parameters: Description of the message to reply to.
|
|
1012
857
|
|
|
1013
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1014
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1015
|
-
or to force a reply from the user."""
|
|
858
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1016
859
|
|
|
1017
860
|
...
|
|
1018
861
|
|
|
@@ -1032,7 +875,20 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1032
875
|
disable_notification: bool | None = None,
|
|
1033
876
|
protect_content: bool | None = None,
|
|
1034
877
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1035
|
-
reply_markup:
|
|
878
|
+
reply_markup: InlineKeyboardMarkup
|
|
879
|
+
| ReplyKeyboardMarkup
|
|
880
|
+
| ReplyKeyboardRemove
|
|
881
|
+
| ForceReply
|
|
882
|
+
| None = None,
|
|
883
|
+
duration: int | None = None,
|
|
884
|
+
width: int | None = None,
|
|
885
|
+
height: int | None = None,
|
|
886
|
+
thumbnail: InputFile | str | None = None,
|
|
887
|
+
caption: str | None = None,
|
|
888
|
+
caption_entities: list[MessageEntity] | None = None,
|
|
889
|
+
show_caption_above_media: bool | None = None,
|
|
890
|
+
has_spoiler: bool | None = None,
|
|
891
|
+
supports_streaming: bool | None = None,
|
|
1036
892
|
**other: typing.Any,
|
|
1037
893
|
) -> Result[MessageCute, APIError]:
|
|
1038
894
|
"""Shortcut `API.send_video()`, see the [documentation](https://core.telegram.org/bots/api#sendvideo)
|
|
@@ -1041,62 +897,40 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1041
897
|
(other formats may be sent as Document). On success, the sent Message is
|
|
1042
898
|
returned. Bots can currently send video files of up to 50 MB in size, this
|
|
1043
899
|
limit may be changed in the future.
|
|
900
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1044
901
|
|
|
1045
|
-
:param
|
|
1046
|
-
will be sent.
|
|
1047
|
-
|
|
1048
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1049
|
-
(in the format @channelusername).
|
|
1050
|
-
|
|
1051
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1052
|
-
forum supergroups only.
|
|
902
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1053
903
|
|
|
1054
|
-
:param
|
|
1055
|
-
chats only.
|
|
1056
|
-
|
|
1057
|
-
:param video: Video to send. Pass a file_id as String to send a video that exists on the Telegram \
|
|
1058
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
1059
|
-
video from the Internet, or upload a new video using multipart/form-data. \
|
|
1060
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
904
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1061
905
|
|
|
906
|
+
:param video: Video to send. Pass a file_id as String to send a video that exists on the Telegramservers (recommended), pass an HTTP URL as a String for Telegram to get avideo from the Internet, or upload a new video using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1062
907
|
:param duration: Duration of sent video in seconds.
|
|
1063
908
|
|
|
1064
909
|
:param width: Video width.
|
|
1065
910
|
|
|
1066
911
|
:param height: Video height.
|
|
1067
912
|
|
|
1068
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
1069
|
-
|
|
1070
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
1071
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
1072
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
1073
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
1074
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
913
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
914
|
+
:param caption: Video caption (may also be used when resending videos by file_id), 0-1024characters after entities parsing.
|
|
1075
915
|
|
|
1076
|
-
:param
|
|
1077
|
-
characters after entities parsing.
|
|
916
|
+
:param parse_mode: Mode for parsing entities in the video caption. See formatting optionsfor more details.
|
|
1078
917
|
|
|
1079
|
-
:param
|
|
1080
|
-
for more details.
|
|
918
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
1081
919
|
|
|
1082
|
-
:param
|
|
1083
|
-
which can be specified instead of parse_mode.
|
|
920
|
+
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
1084
921
|
|
|
1085
922
|
:param has_spoiler: Pass True if the video needs to be covered with a spoiler animation.
|
|
1086
923
|
|
|
1087
924
|
:param supports_streaming: Pass True if the uploaded video is suitable for streaming.
|
|
1088
925
|
|
|
1089
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1090
|
-
|
|
1091
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
1092
|
-
|
|
926
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1093
927
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1094
928
|
|
|
929
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
930
|
+
|
|
1095
931
|
:param reply_parameters: Description of the message to reply to.
|
|
1096
932
|
|
|
1097
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1098
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1099
|
-
or to force a reply from the user."""
|
|
933
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1100
934
|
|
|
1101
935
|
...
|
|
1102
936
|
|
|
@@ -1118,7 +952,11 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1118
952
|
disable_notification: bool | None = None,
|
|
1119
953
|
protect_content: bool | None = None,
|
|
1120
954
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1121
|
-
reply_markup:
|
|
955
|
+
reply_markup: InlineKeyboardMarkup
|
|
956
|
+
| ReplyKeyboardMarkup
|
|
957
|
+
| ReplyKeyboardRemove
|
|
958
|
+
| ForceReply
|
|
959
|
+
| None = None,
|
|
1122
960
|
**other: typing.Any,
|
|
1123
961
|
) -> Result[MessageCute, APIError]:
|
|
1124
962
|
"""Shortcut `API.send_video_note()`, see the [documentation](https://core.telegram.org/bots/api#sendvideonote)
|
|
@@ -1126,45 +964,27 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1126
964
|
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up
|
|
1127
965
|
to 1 minute long. Use this method to send video messages. On success, the
|
|
1128
966
|
sent Message is returned.
|
|
967
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1129
968
|
|
|
1130
|
-
:param
|
|
1131
|
-
will be sent.
|
|
969
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1132
970
|
|
|
1133
|
-
:param
|
|
1134
|
-
(in the format @channelusername).
|
|
971
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1135
972
|
|
|
1136
|
-
:param
|
|
1137
|
-
forum supergroups only.
|
|
1138
|
-
|
|
1139
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1140
|
-
chats only.
|
|
1141
|
-
|
|
1142
|
-
:param video_note: Video note to send. Pass a file_id as String to send a video note that exists \
|
|
1143
|
-
on the Telegram servers (recommended) or upload a new video using multipart/form-data. \
|
|
1144
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1145
|
-
Sending video notes by a URL is currently unsupported.
|
|
973
|
+
:param video_note: Video note to send. Pass a file_id as String to send a video note that existson the Telegram servers (recommended) or upload a new video using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.Sending video notes by a URL is currently unsupported.
|
|
1146
974
|
|
|
1147
975
|
:param duration: Duration of sent video in seconds.
|
|
1148
976
|
|
|
1149
977
|
:param length: Video width and height, i.e. diameter of the video message.
|
|
1150
978
|
|
|
1151
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
1152
|
-
|
|
1153
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
1154
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
1155
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
1156
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
1157
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1158
|
-
|
|
1159
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1160
|
-
|
|
979
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
980
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1161
981
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1162
982
|
|
|
983
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
984
|
+
|
|
1163
985
|
:param reply_parameters: Description of the message to reply to.
|
|
1164
986
|
|
|
1165
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1166
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1167
|
-
or to force a reply from the user."""
|
|
987
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1168
988
|
|
|
1169
989
|
...
|
|
1170
990
|
|
|
@@ -1187,53 +1007,44 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1187
1007
|
disable_notification: bool | None = None,
|
|
1188
1008
|
protect_content: bool | None = None,
|
|
1189
1009
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1190
|
-
reply_markup:
|
|
1010
|
+
reply_markup: InlineKeyboardMarkup
|
|
1011
|
+
| ReplyKeyboardMarkup
|
|
1012
|
+
| ReplyKeyboardRemove
|
|
1013
|
+
| ForceReply
|
|
1014
|
+
| None = None,
|
|
1191
1015
|
**other: typing.Any,
|
|
1192
1016
|
) -> Result[MessageCute, APIError]:
|
|
1193
1017
|
"""Shortcut `API.send_voice()`, see the [documentation](https://core.telegram.org/bots/api#sendvoice)
|
|
1194
1018
|
|
|
1195
1019
|
Use this method to send audio files, if you want Telegram clients to display
|
|
1196
1020
|
the file as a playable voice message. For this to work, your audio must be
|
|
1197
|
-
in an .OGG file encoded with OPUS
|
|
1198
|
-
|
|
1199
|
-
messages of up to 50 MB in size, this
|
|
1200
|
-
|
|
1201
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the
|
|
1202
|
-
will be sent.
|
|
1203
|
-
|
|
1204
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1205
|
-
(in the format @channelusername).
|
|
1206
|
-
|
|
1207
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1208
|
-
forum supergroups only.
|
|
1021
|
+
in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other
|
|
1022
|
+
formats may be sent as Audio or Document). On success, the sent Message is
|
|
1023
|
+
returned. Bots can currently send voice messages of up to 50 MB in size, this
|
|
1024
|
+
limit may be changed in the future.
|
|
1025
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1209
1026
|
|
|
1210
|
-
:param
|
|
1211
|
-
chats only.
|
|
1027
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1212
1028
|
|
|
1213
|
-
:param
|
|
1214
|
-
Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
1215
|
-
to get a file from the Internet, or upload a new one using multipart/form-data. \
|
|
1216
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1029
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1217
1030
|
|
|
1031
|
+
:param voice: Audio file to send. Pass a file_id as String to send a file that exists on theTelegram servers (recommended), pass an HTTP URL as a String for Telegramto get a file from the Internet, or upload a new one using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1218
1032
|
:param caption: Voice message caption, 0-1024 characters after entities parsing.
|
|
1219
1033
|
|
|
1220
|
-
:param parse_mode: Mode for parsing entities in the voice message caption. See
|
|
1221
|
-
options for more details.
|
|
1034
|
+
:param parse_mode: Mode for parsing entities in the voice message caption. See formattingoptions for more details.
|
|
1222
1035
|
|
|
1223
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
1224
|
-
which can be specified instead of parse_mode.
|
|
1036
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
1225
1037
|
|
|
1226
1038
|
:param duration: Duration of the voice message in seconds.
|
|
1227
1039
|
|
|
1228
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1229
|
-
|
|
1040
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1230
1041
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1231
1042
|
|
|
1043
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1044
|
+
|
|
1232
1045
|
:param reply_parameters: Description of the message to reply to.
|
|
1233
1046
|
|
|
1234
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1235
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1236
|
-
or to force a reply from the user."""
|
|
1047
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1237
1048
|
|
|
1238
1049
|
...
|
|
1239
1050
|
|
|
@@ -1266,32 +1077,27 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1266
1077
|
disable_notification: bool | None = None,
|
|
1267
1078
|
protect_content: bool | None = None,
|
|
1268
1079
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1269
|
-
reply_markup:
|
|
1080
|
+
reply_markup: InlineKeyboardMarkup
|
|
1081
|
+
| ReplyKeyboardMarkup
|
|
1082
|
+
| ReplyKeyboardRemove
|
|
1083
|
+
| ForceReply
|
|
1084
|
+
| None = None,
|
|
1270
1085
|
**other: typing.Any,
|
|
1271
1086
|
) -> Result[MessageCute, APIError]:
|
|
1272
1087
|
"""Shortcut `API.send_poll()`, see the [documentation](https://core.telegram.org/bots/api#sendpoll)
|
|
1273
1088
|
|
|
1274
1089
|
Use this method to send a native poll. On success, the sent Message is returned.
|
|
1090
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1275
1091
|
|
|
1276
|
-
:param
|
|
1277
|
-
will be sent.
|
|
1092
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1278
1093
|
|
|
1279
|
-
:param
|
|
1280
|
-
(in the format @channelusername).
|
|
1094
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1281
1095
|
|
|
1282
|
-
:param
|
|
1283
|
-
forum supergroups only.
|
|
1284
|
-
|
|
1285
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1286
|
-
chats only.
|
|
1096
|
+
:param question: Poll question, 1-300 characters.
|
|
1287
1097
|
|
|
1288
|
-
:param question_parse_mode: Mode for parsing entities in the question. See formatting options for
|
|
1289
|
-
details. Currently, only custom emoji entities are allowed.
|
|
1098
|
+
:param question_parse_mode: Mode for parsing entities in the question. See formatting options for moredetails. Currently, only custom emoji entities are allowed.
|
|
1290
1099
|
|
|
1291
|
-
:param question_entities: A JSON-serialized list of special entities that appear in the poll question.
|
|
1292
|
-
It can be specified instead of question_parse_mode.
|
|
1293
|
-
|
|
1294
|
-
:param question: Poll question, 1-300 characters.
|
|
1100
|
+
:param question_entities: A JSON-serialized list of special entities that appear in the poll question.It can be specified instead of question_parse_mode.
|
|
1295
1101
|
|
|
1296
1102
|
:param options: A JSON-serialized list of 2-10 answer options.
|
|
1297
1103
|
|
|
@@ -1299,43 +1105,30 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1299
1105
|
|
|
1300
1106
|
:param type: Poll type, `quiz` or `regular`, defaults to `regular`.
|
|
1301
1107
|
|
|
1302
|
-
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,
|
|
1303
|
-
defaults to False.
|
|
1304
|
-
|
|
1305
|
-
:param correct_option_id: 0-based identifier of the correct answer option, required for polls in \
|
|
1306
|
-
quiz mode.
|
|
1108
|
+
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,defaults to False.
|
|
1307
1109
|
|
|
1308
|
-
:param
|
|
1309
|
-
icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after \
|
|
1310
|
-
entities parsing.
|
|
1110
|
+
:param correct_option_id: 0-based identifier of the correct answer option, required for polls inquiz mode.
|
|
1311
1111
|
|
|
1312
|
-
:param
|
|
1313
|
-
more details.
|
|
1112
|
+
:param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lampicon in a quiz-style poll, 0-200 characters with at most 2 line feeds afterentities parsing.
|
|
1314
1113
|
|
|
1315
|
-
:param
|
|
1316
|
-
which can be specified instead of parse_mode.
|
|
1114
|
+
:param explanation_parse_mode: Mode for parsing entities in the explanation. See formatting options formore details.
|
|
1317
1115
|
|
|
1318
|
-
:param
|
|
1319
|
-
Can't be used together with close_date.
|
|
1116
|
+
:param explanation_entities: A JSON-serialized list of special entities that appear in the poll explanation.It can be specified instead of explanation_parse_mode.
|
|
1320
1117
|
|
|
1321
|
-
:param
|
|
1322
|
-
Must be at least 5 and no more than 600 seconds in the future. Can't be used \
|
|
1323
|
-
together with open_period.
|
|
1118
|
+
:param open_period: Amount of time in seconds the poll will be active after creation, 5-600.Can't be used together with close_date.
|
|
1324
1119
|
|
|
1325
|
-
:param
|
|
1326
|
-
poll preview.
|
|
1120
|
+
:param close_date: Point in time (Unix timestamp) when the poll will be automatically closed.Must be at least 5 and no more than 600 seconds in the future. Can't be usedtogether with open_period.
|
|
1327
1121
|
|
|
1328
|
-
:param
|
|
1329
|
-
|
|
1330
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
1122
|
+
:param is_closed: Pass True if the poll needs to be immediately closed. This can be useful forpoll preview.
|
|
1331
1123
|
|
|
1124
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1332
1125
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1333
1126
|
|
|
1127
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1128
|
+
|
|
1334
1129
|
:param reply_parameters: Description of the message to reply to.
|
|
1335
1130
|
|
|
1336
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1337
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1338
|
-
or to force a reply from the user."""
|
|
1131
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1339
1132
|
|
|
1340
1133
|
...
|
|
1341
1134
|
|
|
@@ -1361,25 +1154,22 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1361
1154
|
disable_notification: bool | None = None,
|
|
1362
1155
|
protect_content: bool | None = None,
|
|
1363
1156
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1364
|
-
reply_markup:
|
|
1157
|
+
reply_markup: InlineKeyboardMarkup
|
|
1158
|
+
| ReplyKeyboardMarkup
|
|
1159
|
+
| ReplyKeyboardRemove
|
|
1160
|
+
| ForceReply
|
|
1161
|
+
| None = None,
|
|
1365
1162
|
**other: typing.Any,
|
|
1366
1163
|
) -> Result[MessageCute, APIError]:
|
|
1367
1164
|
"""Shortcut `API.send_venue()`, see the [documentation](https://core.telegram.org/bots/api#sendvenue)
|
|
1368
1165
|
|
|
1369
1166
|
Use this method to send information about a venue. On success, the sent Message
|
|
1370
1167
|
is returned.
|
|
1168
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1371
1169
|
|
|
1372
|
-
:param
|
|
1373
|
-
will be sent.
|
|
1170
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1374
1171
|
|
|
1375
|
-
:param
|
|
1376
|
-
(in the format @channelusername).
|
|
1377
|
-
|
|
1378
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1379
|
-
forum supergroups only.
|
|
1380
|
-
|
|
1381
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1382
|
-
chats only.
|
|
1172
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1383
1173
|
|
|
1384
1174
|
:param latitude: Latitude of the venue.
|
|
1385
1175
|
|
|
@@ -1391,22 +1181,20 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1391
1181
|
|
|
1392
1182
|
:param foursquare_id: Foursquare identifier of the venue.
|
|
1393
1183
|
|
|
1394
|
-
:param foursquare_type: Foursquare type of the venue, if known. (For example, `arts_entertainment/default
|
|
1395
|
-
`arts_entertainment/aquarium` or `food/icecream`.).
|
|
1184
|
+
:param foursquare_type: Foursquare type of the venue, if known. (For example, `arts_entertainment/default`,`arts_entertainment/aquarium` or `food/icecream`.).
|
|
1396
1185
|
|
|
1397
1186
|
:param google_place_id: Google Places identifier of the venue.
|
|
1398
1187
|
|
|
1399
1188
|
:param google_place_type: Google Places type of the venue. (See supported types.).
|
|
1400
1189
|
|
|
1401
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1402
|
-
|
|
1190
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1403
1191
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1404
1192
|
|
|
1193
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1194
|
+
|
|
1405
1195
|
:param reply_parameters: Description of the message to reply to.
|
|
1406
1196
|
|
|
1407
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1408
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1409
|
-
or to force a reply from the user."""
|
|
1197
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1410
1198
|
|
|
1411
1199
|
...
|
|
1412
1200
|
|
|
@@ -1425,39 +1213,32 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1425
1213
|
disable_notification: bool | None = None,
|
|
1426
1214
|
protect_content: bool | None = None,
|
|
1427
1215
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1428
|
-
reply_markup:
|
|
1216
|
+
reply_markup: InlineKeyboardMarkup
|
|
1217
|
+
| ReplyKeyboardMarkup
|
|
1218
|
+
| ReplyKeyboardRemove
|
|
1219
|
+
| ForceReply
|
|
1220
|
+
| None = None,
|
|
1429
1221
|
**other: typing.Any,
|
|
1430
1222
|
) -> Result[MessageCute, APIError]:
|
|
1431
1223
|
"""Shortcut `API.send_dice()`, see the [documentation](https://core.telegram.org/bots/api#senddice)
|
|
1432
1224
|
|
|
1433
1225
|
Use this method to send an animated emoji that will display a random value.
|
|
1434
1226
|
On success, the sent Message is returned.
|
|
1227
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1435
1228
|
|
|
1436
|
-
:param
|
|
1437
|
-
will be sent.
|
|
1438
|
-
|
|
1439
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1440
|
-
(in the format @channelusername).
|
|
1441
|
-
|
|
1442
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1443
|
-
forum supergroups only.
|
|
1444
|
-
|
|
1445
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1446
|
-
chats only.
|
|
1447
|
-
|
|
1448
|
-
:param emoji: Emoji on which the dice throw animation is based. Currently, must be one \
|
|
1449
|
-
of `🎲`, `🎯`, `🏀`, `⚽`, `🎳`, or `🎰`. Dice can have values 1-6 for `🎲`, `🎯` and \
|
|
1450
|
-
`🎳`, values 1-5 for `🏀` and `⚽`, and values 1-64 for `🎰`. Defaults to `🎲`. \
|
|
1229
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1451
1230
|
|
|
1452
|
-
:param
|
|
1231
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1453
1232
|
|
|
1233
|
+
:param emoji: Emoji on which the dice throw animation is based. Currently, must be oneof `🎲`, `🎯`, `🏀`, `⚽`, `🎳`, or `🎰`. Dice can have values 1-6 for `🎲`, `🎯` and`🎳`, values 1-5 for `🏀` and `⚽`, and values 1-64 for `🎰`. Defaults to `🎲`.
|
|
1234
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1454
1235
|
:param protect_content: Protects the contents of the sent message from forwarding.
|
|
1455
1236
|
|
|
1237
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1238
|
+
|
|
1456
1239
|
:param reply_parameters: Description of the message to reply to.
|
|
1457
1240
|
|
|
1458
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1459
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1460
|
-
or to force a reply from the user."""
|
|
1241
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1461
1242
|
|
|
1462
1243
|
...
|
|
1463
1244
|
|
|
@@ -1476,35 +1257,28 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1476
1257
|
disable_notification: bool | None = None,
|
|
1477
1258
|
protect_content: bool | None = None,
|
|
1478
1259
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1479
|
-
reply_markup:
|
|
1260
|
+
reply_markup: InlineKeyboardMarkup | None = None,
|
|
1480
1261
|
**other: typing.Any,
|
|
1481
1262
|
) -> Result[MessageCute, APIError]:
|
|
1482
1263
|
"""Shortcut `API.send_game()`, see the [documentation](https://core.telegram.org/bots/api#sendgame)
|
|
1483
1264
|
|
|
1484
1265
|
Use this method to send a game. On success, the sent Message is returned.
|
|
1485
|
-
|
|
1486
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
1487
|
-
will be sent.
|
|
1266
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1488
1267
|
|
|
1489
1268
|
:param chat_id: Unique identifier for the target chat.
|
|
1490
1269
|
|
|
1491
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
1492
|
-
forum supergroups only.
|
|
1270
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1493
1271
|
|
|
1494
|
-
:param
|
|
1495
|
-
chats only.
|
|
1496
|
-
|
|
1497
|
-
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Set \
|
|
1498
|
-
up your games via @BotFather.
|
|
1499
|
-
|
|
1500
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1272
|
+
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Setup your games via @BotFather.
|
|
1501
1273
|
|
|
1274
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1502
1275
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1503
1276
|
|
|
1277
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1278
|
+
|
|
1504
1279
|
:param reply_parameters: Description of the message to reply to.
|
|
1505
1280
|
|
|
1506
|
-
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'
|
|
1507
|
-
button will be shown. If not empty, the first button must launch the game."""
|
|
1281
|
+
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'button will be shown. If not empty, the first button must launch the game."""
|
|
1508
1282
|
|
|
1509
1283
|
...
|
|
1510
1284
|
|
|
@@ -1548,87 +1322,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1548
1322
|
) -> Result[MessageCute, APIError]:
|
|
1549
1323
|
"""Shortcut `API.send_invoice()`, see the [documentation](https://core.telegram.org/bots/api#sendinvoice)
|
|
1550
1324
|
|
|
1551
|
-
Use this method to send invoices. On success, the sent Message is returned.
|
|
1552
|
-
|
|
1553
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
1554
|
-
will be sent.
|
|
1555
|
-
|
|
1556
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1557
|
-
(in the format @channelusername).
|
|
1558
|
-
|
|
1559
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1560
|
-
forum supergroups only.
|
|
1561
|
-
|
|
1562
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1563
|
-
chats only.
|
|
1564
|
-
|
|
1565
|
-
:param title: Product name, 1-32 characters.
|
|
1566
|
-
|
|
1567
|
-
:param description: Product description, 1-255 characters.
|
|
1568
|
-
|
|
1569
|
-
:param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to \
|
|
1570
|
-
the user, use for your internal processes.
|
|
1571
|
-
|
|
1572
|
-
:param provider_token: Payment provider token, obtained via @BotFather.
|
|
1573
|
-
|
|
1574
|
-
:param currency: Three-letter ISO 4217 currency code, see more on currencies.
|
|
1575
|
-
|
|
1576
|
-
:param prices: Price breakdown, a JSON-serialized list of components (e.g. product price, \
|
|
1577
|
-
tax, discount, delivery cost, delivery tax, bonus, etc.).
|
|
1578
|
-
|
|
1579
|
-
:param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency \
|
|
1580
|
-
(integer, not float/double). For example, for a maximum tip of US$ 1.45 \
|
|
1581
|
-
pass max_tip_amount = 145. See the exp parameter in currencies.json, it \
|
|
1582
|
-
shows the number of digits past the decimal point for each currency (2 for \
|
|
1583
|
-
the majority of currencies). Defaults to 0.
|
|
1584
|
-
|
|
1585
|
-
:param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest units \
|
|
1586
|
-
of the currency (integer, not float/double). At most 4 suggested tip amounts \
|
|
1587
|
-
can be specified. The suggested tip amounts must be positive, passed in \
|
|
1588
|
-
a strictly increased order and must not exceed max_tip_amount.
|
|
1589
|
-
|
|
1590
|
-
:param start_parameter: Unique deep-linking parameter. If left empty, forwarded copies of the \
|
|
1591
|
-
sent message will have a Pay button, allowing multiple users to pay directly \
|
|
1592
|
-
from the forwarded message, using the same invoice. If non-empty, forwarded \
|
|
1593
|
-
copies of the sent message will have a URL button with a deep link to the bot \
|
|
1594
|
-
(instead of a Pay button), with the value used as the start parameter.
|
|
1595
|
-
|
|
1596
|
-
:param provider_data: JSON-serialized data about the invoice, which will be shared with the payment \
|
|
1597
|
-
provider. A detailed description of required fields should be provided \
|
|
1598
|
-
by the payment provider.
|
|
1599
|
-
|
|
1600
|
-
:param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or a marketing \
|
|
1601
|
-
image for a service. People like it better when they see what they are paying \
|
|
1602
|
-
for.
|
|
1603
|
-
|
|
1604
|
-
:param photo_size: Photo size in bytes.
|
|
1605
|
-
|
|
1606
|
-
:param photo_width: Photo width.
|
|
1607
|
-
|
|
1608
|
-
:param photo_height: Photo height.
|
|
1609
|
-
|
|
1610
|
-
:param need_name: Pass True if you require the user's full name to complete the order.
|
|
1611
|
-
|
|
1612
|
-
:param need_phone_number: Pass True if you require the user's phone number to complete the order.
|
|
1613
|
-
|
|
1614
|
-
:param need_email: Pass True if you require the user's email address to complete the order. \
|
|
1615
|
-
|
|
1616
|
-
:param need_shipping_address: Pass True if you require the user's shipping address to complete the order. \
|
|
1617
|
-
|
|
1618
|
-
:param send_phone_number_to_provider: Pass True if the user's phone number should be sent to provider.
|
|
1619
|
-
|
|
1620
|
-
:param send_email_to_provider: Pass True if the user's email address should be sent to provider.
|
|
1621
|
-
|
|
1622
|
-
:param is_flexible: Pass True if the final price depends on the shipping method.
|
|
1623
|
-
|
|
1624
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1625
|
-
|
|
1626
|
-
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1627
|
-
|
|
1628
|
-
:param reply_parameters: Description of the message to reply to.
|
|
1629
|
-
|
|
1630
|
-
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay total \
|
|
1631
|
-
price' button will be shown. If not empty, the first button must be a Pay button."""
|
|
1325
|
+
Use this method to send invoices. On success, the sent Message is returned."""
|
|
1632
1326
|
|
|
1633
1327
|
...
|
|
1634
1328
|
|
|
@@ -1652,21 +1346,12 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1652
1346
|
from your bot, Telegram clients clear its typing status). Returns True
|
|
1653
1347
|
on success. We only recommend using this method when a response from the
|
|
1654
1348
|
bot will take a noticeable amount of time to arrive.
|
|
1349
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the actionwill be sent.
|
|
1655
1350
|
|
|
1656
|
-
:param
|
|
1657
|
-
will be sent.
|
|
1658
|
-
|
|
1659
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1660
|
-
(in the format @channelusername).
|
|
1661
|
-
|
|
1662
|
-
:param message_thread_id: Unique identifier for the target message thread; supergroups only.
|
|
1351
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1663
1352
|
|
|
1664
|
-
:param
|
|
1665
|
-
to receive: typing for text messages, upload_photo for photos,
|
|
1666
|
-
or upload_video for videos, record_voice or upload_voice for voice notes, \
|
|
1667
|
-
upload_document for general files, choose_sticker for stickers, find_location \
|
|
1668
|
-
for location data, record_video_note or upload_video_note for video \
|
|
1669
|
-
notes."""
|
|
1353
|
+
:param message_thread_id: Unique identifier for the target message thread; for supergroups only.
|
|
1354
|
+
:param action: Type of action to broadcast. Choose one, depending on what the user is aboutto receive: typing for text messages, upload_photo for photos, record_videoor upload_video for videos, record_voice or upload_voice for voice notes,upload_document for general files, choose_sticker for stickers, find_locationfor location data, record_video_note or upload_video_note for videonotes."""
|
|
1670
1355
|
|
|
1671
1356
|
...
|
|
1672
1357
|
|
|
@@ -1676,14 +1361,14 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1676
1361
|
)
|
|
1677
1362
|
async def answer_media_group(
|
|
1678
1363
|
self,
|
|
1679
|
-
media:
|
|
1680
|
-
chat_id: int | str
|
|
1364
|
+
media: InputMediaType | list[InputMediaType],
|
|
1365
|
+
chat_id: int | str,
|
|
1681
1366
|
business_connection_id: str | None = None,
|
|
1682
1367
|
message_thread_id: int | None = None,
|
|
1683
1368
|
message_effect_id: str | None = None,
|
|
1684
|
-
caption: str | None = None,
|
|
1685
|
-
parse_mode: str | None = None,
|
|
1686
|
-
caption_entities: list[MessageEntity] | None = None,
|
|
1369
|
+
caption: str | list[str] | None = None,
|
|
1370
|
+
parse_mode: str | list[str] | None = None,
|
|
1371
|
+
caption_entities: list[MessageEntity] | list[list[MessageEntity]] | None = None,
|
|
1687
1372
|
disable_notification: bool | None = None,
|
|
1688
1373
|
protect_content: bool | None = None,
|
|
1689
1374
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
@@ -1694,37 +1379,28 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1694
1379
|
Use this method to send a group of photos, videos, documents or audios as
|
|
1695
1380
|
an album. Documents and audio files can be only grouped in an album with messages
|
|
1696
1381
|
of the same type. On success, an array of Messages that were sent is returned.
|
|
1382
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1697
1383
|
|
|
1698
|
-
:param
|
|
1699
|
-
will be sent.
|
|
1384
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1700
1385
|
|
|
1701
|
-
:param
|
|
1702
|
-
(in the format @channelusername).
|
|
1386
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1703
1387
|
|
|
1704
|
-
:param
|
|
1705
|
-
forum supergroups only.
|
|
1388
|
+
:param media: A JSON-serialized array describing messages to be sent, must include 2-10items.
|
|
1706
1389
|
|
|
1707
|
-
:param
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
:param media: A JSON-serialized array describing messages to be sent, must include 2-10 \
|
|
1711
|
-
items.
|
|
1712
|
-
|
|
1713
|
-
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
1714
|
-
|
|
1715
|
-
:param parse_mode: Mode for parsing entities in the audio caption. See formatting options \
|
|
1716
|
-
for more details.
|
|
1717
|
-
|
|
1718
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
1719
|
-
which can be specified instead of parse_mode.
|
|
1720
|
-
|
|
1721
|
-
:param disable_notification: Sends messages silently. Users will receive a notification with no sound. \
|
|
1722
|
-
|
|
1723
|
-
:param protect_content: Protects the contents of the sent messages from forwarding and saving. \
|
|
1390
|
+
:param disable_notification: Sends messages silently. Users will receive a notification with no sound.
|
|
1391
|
+
:param protect_content: Protects the contents of the sent messages from forwarding and saving.
|
|
1392
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1724
1393
|
|
|
1725
1394
|
:param reply_parameters: Description of the message to reply to."""
|
|
1726
1395
|
|
|
1396
|
+
media = [media] if not isinstance(media, list) else media
|
|
1727
1397
|
params = get_params(locals())
|
|
1398
|
+
caption_entities_lst = typing.cast(
|
|
1399
|
+
list[list[MessageEntity]],
|
|
1400
|
+
[caption_entities]
|
|
1401
|
+
if caption_entities and len(caption_entities) == 1 and not isinstance(caption_entities[0], list)
|
|
1402
|
+
else caption_entities,
|
|
1403
|
+
)
|
|
1728
1404
|
|
|
1729
1405
|
for i, m in enumerate(media[:]):
|
|
1730
1406
|
if isinstance(m, tuple):
|
|
@@ -1732,9 +1408,9 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1732
1408
|
i,
|
|
1733
1409
|
input_media( # type: ignore
|
|
1734
1410
|
*media.pop(i), # type: ignore
|
|
1735
|
-
caption=caption,
|
|
1736
|
-
caption_entities=
|
|
1737
|
-
parse_mode=parse_mode,
|
|
1411
|
+
caption=caption if not isinstance(caption, list) else caption[i],
|
|
1412
|
+
caption_entities=caption_entities_lst[i] if caption_entities_lst else None,
|
|
1413
|
+
parse_mode=parse_mode if not isinstance(parse_mode, list) else parse_mode[i],
|
|
1738
1414
|
),
|
|
1739
1415
|
)
|
|
1740
1416
|
|
|
@@ -1760,49 +1436,40 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1760
1436
|
disable_notification: bool | None = None,
|
|
1761
1437
|
protect_content: bool | None = None,
|
|
1762
1438
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1763
|
-
reply_markup:
|
|
1439
|
+
reply_markup: InlineKeyboardMarkup
|
|
1440
|
+
| ReplyKeyboardMarkup
|
|
1441
|
+
| ReplyKeyboardRemove
|
|
1442
|
+
| ForceReply
|
|
1443
|
+
| None = None,
|
|
1764
1444
|
**other: typing.Any,
|
|
1765
1445
|
) -> Result[MessageCute, APIError]:
|
|
1766
1446
|
"""Shortcut `API.send_location()`, see the [documentation](https://core.telegram.org/bots/api#sendlocation)
|
|
1767
1447
|
|
|
1768
1448
|
Use this method to send point on the map. On success, the sent Message is returned.
|
|
1449
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1769
1450
|
|
|
1770
|
-
:param
|
|
1771
|
-
will be sent.
|
|
1772
|
-
|
|
1773
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1774
|
-
(in the format @channelusername).
|
|
1775
|
-
|
|
1776
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1777
|
-
forum supergroups only.
|
|
1451
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1778
1452
|
|
|
1779
|
-
:param
|
|
1780
|
-
chats only.
|
|
1453
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1781
1454
|
|
|
1782
1455
|
:param latitude: Latitude of the location.
|
|
1783
1456
|
|
|
1784
1457
|
:param longitude: Longitude of the location.
|
|
1785
1458
|
|
|
1786
|
-
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
1459
|
+
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
1460
|
+
:param live_period: Period in seconds during which the location will be updated (see Live Locations,should be between 60 and 86400, or 0x7FFFFFFF for live locations that canbe edited indefinitely.
|
|
1787
1461
|
|
|
1788
|
-
:param
|
|
1789
|
-
should be between 60 and 86400.
|
|
1790
|
-
|
|
1791
|
-
:param heading: For live locations, a direction in which the user is moving, in degrees. \
|
|
1792
|
-
Must be between 1 and 360 if specified.
|
|
1793
|
-
|
|
1794
|
-
:param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approaching \
|
|
1795
|
-
another chat member, in meters. Must be between 1 and 100000 if specified. \
|
|
1796
|
-
|
|
1797
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1462
|
+
:param heading: For live locations, a direction in which the user is moving, in degrees.Must be between 1 and 360 if specified.
|
|
1798
1463
|
|
|
1464
|
+
:param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approachinganother chat member, in meters. Must be between 1 and 100000 if specified.
|
|
1465
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1799
1466
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1800
1467
|
|
|
1468
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1469
|
+
|
|
1801
1470
|
:param reply_parameters: Description of the message to reply to.
|
|
1802
1471
|
|
|
1803
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1804
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1805
|
-
or to force a reply from the user."""
|
|
1472
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1806
1473
|
|
|
1807
1474
|
...
|
|
1808
1475
|
|
|
@@ -1824,24 +1491,21 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1824
1491
|
disable_notification: bool | None = None,
|
|
1825
1492
|
protect_content: bool | None = None,
|
|
1826
1493
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1827
|
-
reply_markup:
|
|
1494
|
+
reply_markup: InlineKeyboardMarkup
|
|
1495
|
+
| ReplyKeyboardMarkup
|
|
1496
|
+
| ReplyKeyboardRemove
|
|
1497
|
+
| ForceReply
|
|
1498
|
+
| None = None,
|
|
1828
1499
|
**other: typing.Any,
|
|
1829
1500
|
) -> Result[MessageCute, APIError]:
|
|
1830
1501
|
"""Shortcut `API.send_contact()`, see the [documentation](https://core.telegram.org/bots/api#sendcontact)
|
|
1831
1502
|
|
|
1832
1503
|
Use this method to send phone contacts. On success, the sent Message is returned.
|
|
1504
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1833
1505
|
|
|
1834
|
-
:param
|
|
1835
|
-
will be sent.
|
|
1836
|
-
|
|
1837
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1838
|
-
(in the format @channelusername).
|
|
1839
|
-
|
|
1840
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1841
|
-
forum supergroups only.
|
|
1506
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1842
1507
|
|
|
1843
|
-
:param
|
|
1844
|
-
chats only.
|
|
1508
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1845
1509
|
|
|
1846
1510
|
:param phone_number: Contact's phone number.
|
|
1847
1511
|
|
|
@@ -1851,15 +1515,14 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1851
1515
|
|
|
1852
1516
|
:param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes.
|
|
1853
1517
|
|
|
1854
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1855
|
-
|
|
1518
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1856
1519
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1857
1520
|
|
|
1521
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1522
|
+
|
|
1858
1523
|
:param reply_parameters: Description of the message to reply to.
|
|
1859
1524
|
|
|
1860
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1861
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1862
|
-
or to force a reply from the user."""
|
|
1525
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1863
1526
|
|
|
1864
1527
|
...
|
|
1865
1528
|
|
|
@@ -1885,41 +1548,32 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1885
1548
|
disable_notification: bool | None = None,
|
|
1886
1549
|
protect_content: bool | None = None,
|
|
1887
1550
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1888
|
-
reply_markup:
|
|
1551
|
+
reply_markup: InlineKeyboardMarkup
|
|
1552
|
+
| ReplyKeyboardMarkup
|
|
1553
|
+
| ReplyKeyboardRemove
|
|
1554
|
+
| ForceReply
|
|
1555
|
+
| None = None,
|
|
1889
1556
|
**other: typing.Any,
|
|
1890
1557
|
) -> Result[MessageCute, APIError]:
|
|
1891
1558
|
"""Shortcut `API.send_audio()`, see the [documentation](https://core.telegram.org/bots/api#sendaudio)
|
|
1892
1559
|
|
|
1893
|
-
Use this method to send
|
|
1560
|
+
Use this method to send audio files, if you want Telegram clients to display
|
|
1894
1561
|
them in the music player. Your audio must be in the .MP3 or .M4A format. On
|
|
1895
1562
|
success, the sent Message is returned. Bots can currently send audio files
|
|
1896
1563
|
of up to 50 MB in size, this limit may be changed in the future. For sending
|
|
1897
1564
|
voice messages, use the sendVoice method instead.
|
|
1565
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1898
1566
|
|
|
1899
|
-
:param
|
|
1900
|
-
will be sent.
|
|
1901
|
-
|
|
1902
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1903
|
-
(in the format @channelusername).
|
|
1904
|
-
|
|
1905
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1906
|
-
forum supergroups only.
|
|
1567
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1907
1568
|
|
|
1908
|
-
:param
|
|
1909
|
-
chats only.
|
|
1910
|
-
|
|
1911
|
-
:param audio: Audio file to send. Pass a file_id as String to send an audio file that exists \
|
|
1912
|
-
on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
1913
|
-
to get an audio file from the Internet, or upload a new one using multipart/form-data. \
|
|
1914
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1569
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1915
1570
|
|
|
1571
|
+
:param audio: Audio file to send. Pass a file_id as String to send an audio file that existson the Telegram servers (recommended), pass an HTTP URL as a String for Telegramto get an audio file from the Internet, or upload a new one using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1916
1572
|
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
1917
1573
|
|
|
1918
|
-
:param parse_mode: Mode for parsing entities in the audio caption. See formatting
|
|
1919
|
-
for more details.
|
|
1574
|
+
:param parse_mode: Mode for parsing entities in the audio caption. See formatting optionsfor more details.
|
|
1920
1575
|
|
|
1921
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
1922
|
-
which can be specified instead of parse_mode.
|
|
1576
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
1923
1577
|
|
|
1924
1578
|
:param duration: Duration of the audio in seconds.
|
|
1925
1579
|
|
|
@@ -1927,23 +1581,15 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1927
1581
|
|
|
1928
1582
|
:param title: Track name.
|
|
1929
1583
|
|
|
1930
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
1931
|
-
|
|
1932
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
1933
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
1934
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
1935
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
1936
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1937
|
-
|
|
1938
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1939
|
-
|
|
1584
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1585
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1940
1586
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1941
1587
|
|
|
1588
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1589
|
+
|
|
1942
1590
|
:param reply_parameters: Description of the message to reply to.
|
|
1943
1591
|
|
|
1944
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1945
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1946
|
-
or to force a reply from the user."""
|
|
1592
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
1947
1593
|
|
|
1948
1594
|
...
|
|
1949
1595
|
|
|
@@ -1971,68 +1617,49 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1971
1617
|
disable_notification: bool | None = None,
|
|
1972
1618
|
protect_content: bool | None = None,
|
|
1973
1619
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1974
|
-
reply_markup:
|
|
1620
|
+
reply_markup: InlineKeyboardMarkup
|
|
1621
|
+
| ReplyKeyboardMarkup
|
|
1622
|
+
| ReplyKeyboardRemove
|
|
1623
|
+
| ForceReply
|
|
1624
|
+
| None = None,
|
|
1975
1625
|
**other: typing.Any,
|
|
1976
1626
|
) -> Result[MessageCute, APIError]:
|
|
1977
1627
|
"""Shortcut `API.send_animation()`, see the [documentation](https://core.telegram.org/bots/api#sendanimation)
|
|
1978
1628
|
|
|
1979
|
-
Use this method to send
|
|
1629
|
+
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without
|
|
1980
1630
|
sound). On success, the sent Message is returned. Bots can currently send
|
|
1981
1631
|
animation files of up to 50 MB in size, this limit may be changed in the future.
|
|
1632
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
1982
1633
|
|
|
1983
|
-
:param
|
|
1984
|
-
will be sent.
|
|
1985
|
-
|
|
1986
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1987
|
-
(in the format @channelusername).
|
|
1634
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1988
1635
|
|
|
1989
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
1990
|
-
forum supergroups only.
|
|
1991
|
-
|
|
1992
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1993
|
-
chats only.
|
|
1994
|
-
|
|
1995
|
-
:param animation: Animation to send. Pass a file_id as String to send an animation that exists \
|
|
1996
|
-
on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
1997
|
-
to get an animation from the Internet, or upload a new animation using multipart/form-data. \
|
|
1998
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1636
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1999
1637
|
|
|
1638
|
+
:param animation: Animation to send. Pass a file_id as String to send an animation that existson the Telegram servers (recommended), pass an HTTP URL as a String for Telegramto get an animation from the Internet, or upload a new animation using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
2000
1639
|
:param duration: Duration of sent animation in seconds.
|
|
2001
1640
|
|
|
2002
1641
|
:param width: Animation width.
|
|
2003
1642
|
|
|
2004
1643
|
:param height: Animation height.
|
|
2005
1644
|
|
|
2006
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
2007
|
-
|
|
2008
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2009
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2010
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2011
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2012
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2013
|
-
|
|
2014
|
-
:param caption: Animation caption (may also be used when resending animation by file_id), \
|
|
2015
|
-
0-1024 characters after entities parsing.
|
|
2016
|
-
|
|
2017
|
-
:param parse_mode: Mode for parsing entities in the animation caption. See formatting options \
|
|
2018
|
-
for more details.
|
|
2019
|
-
|
|
2020
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
2021
|
-
which can be specified instead of parse_mode.
|
|
1645
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1646
|
+
:param caption: Animation caption (may also be used when resending animation by file_id),0-1024 characters after entities parsing.
|
|
2022
1647
|
|
|
2023
|
-
:param
|
|
1648
|
+
:param parse_mode: Mode for parsing entities in the animation caption. See formatting optionsfor more details.
|
|
2024
1649
|
|
|
2025
|
-
:param
|
|
1650
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2026
1651
|
|
|
2027
1652
|
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2028
1653
|
|
|
1654
|
+
:param has_spoiler: Pass True if the animation needs to be covered with a spoiler animation.
|
|
1655
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2029
1656
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2030
1657
|
|
|
1658
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1659
|
+
|
|
2031
1660
|
:param reply_parameters: Description of the message to reply to.
|
|
2032
1661
|
|
|
2033
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2034
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2035
|
-
or to force a reply from the user."""
|
|
1662
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2036
1663
|
|
|
2037
1664
|
...
|
|
2038
1665
|
|
|
@@ -2057,63 +1684,42 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2057
1684
|
disable_notification: bool | None = None,
|
|
2058
1685
|
protect_content: bool | None = None,
|
|
2059
1686
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2060
|
-
reply_markup:
|
|
1687
|
+
reply_markup: InlineKeyboardMarkup
|
|
1688
|
+
| ReplyKeyboardMarkup
|
|
1689
|
+
| ReplyKeyboardRemove
|
|
1690
|
+
| ForceReply
|
|
1691
|
+
| None = None,
|
|
2061
1692
|
**other: typing.Any,
|
|
2062
1693
|
) -> Result[MessageCute, APIError]:
|
|
2063
1694
|
"""Shortcut `API.send_document()`, see the [documentation](https://core.telegram.org/bots/api#senddocument)
|
|
2064
1695
|
|
|
2065
|
-
Use this method to send
|
|
1696
|
+
Use this method to send general files. On success, the sent Message is returned.
|
|
2066
1697
|
Bots can currently send files of any type of up to 50 MB in size, this limit
|
|
2067
1698
|
may be changed in the future.
|
|
1699
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2068
1700
|
|
|
2069
|
-
:param
|
|
2070
|
-
will be sent.
|
|
2071
|
-
|
|
2072
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2073
|
-
(in the format @channelusername).
|
|
2074
|
-
|
|
2075
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2076
|
-
forum supergroups only.
|
|
2077
|
-
|
|
2078
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2079
|
-
chats only.
|
|
2080
|
-
|
|
2081
|
-
:param document: File to send. Pass a file_id as String to send a file that exists on the Telegram \
|
|
2082
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
2083
|
-
file from the Internet, or upload a new one using multipart/form-data. \
|
|
2084
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1701
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2085
1702
|
|
|
2086
|
-
:param
|
|
2087
|
-
file is supported server-side. The thumbnail should be in JPEG format and \
|
|
2088
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2089
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2090
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2091
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2092
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1703
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2093
1704
|
|
|
2094
|
-
:param
|
|
2095
|
-
|
|
1705
|
+
:param document: File to send. Pass a file_id as String to send a file that exists on the Telegramservers (recommended), pass an HTTP URL as a String for Telegram to get afile from the Internet, or upload a new one using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1706
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1707
|
+
:param caption: Document caption (may also be used when resending documents by file_id),0-1024 characters after entities parsing.
|
|
2096
1708
|
|
|
2097
|
-
:param parse_mode: Mode for parsing entities in the document caption. See formatting
|
|
2098
|
-
for more details.
|
|
1709
|
+
:param parse_mode: Mode for parsing entities in the document caption. See formatting optionsfor more details.
|
|
2099
1710
|
|
|
2100
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
2101
|
-
which can be specified instead of parse_mode.
|
|
1711
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2102
1712
|
|
|
2103
|
-
:param disable_content_type_detection: Disables automatic server-side content type detection for files
|
|
2104
|
-
using multipart/form-data.
|
|
2105
|
-
|
|
2106
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2107
|
-
|
|
2108
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
1713
|
+
:param disable_content_type_detection: Disables automatic server-side content type detection for files uploadedusing multipart/form-data.
|
|
2109
1714
|
|
|
1715
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2110
1716
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2111
1717
|
|
|
1718
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1719
|
+
|
|
2112
1720
|
:param reply_parameters: Description of the message to reply to.
|
|
2113
1721
|
|
|
2114
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2115
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2116
|
-
or to force a reply from the user."""
|
|
1722
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2117
1723
|
|
|
2118
1724
|
...
|
|
2119
1725
|
|
|
@@ -2137,54 +1743,41 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2137
1743
|
disable_notification: bool | None = None,
|
|
2138
1744
|
protect_content: bool | None = None,
|
|
2139
1745
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2140
|
-
reply_markup:
|
|
1746
|
+
reply_markup: InlineKeyboardMarkup
|
|
1747
|
+
| ReplyKeyboardMarkup
|
|
1748
|
+
| ReplyKeyboardRemove
|
|
1749
|
+
| ForceReply
|
|
1750
|
+
| None = None,
|
|
2141
1751
|
**other: typing.Any,
|
|
2142
1752
|
) -> Result[MessageCute, APIError]:
|
|
2143
1753
|
"""Shortcut `API.send_photo()`, see the [documentation](https://core.telegram.org/bots/api#sendphoto)
|
|
2144
1754
|
|
|
2145
|
-
Use this method to send
|
|
2146
|
-
|
|
2147
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2148
|
-
will be sent.
|
|
2149
|
-
|
|
2150
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2151
|
-
(in the format @channelusername).
|
|
1755
|
+
Use this method to send photos. On success, the sent Message is returned.
|
|
1756
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2152
1757
|
|
|
2153
|
-
:param
|
|
2154
|
-
forum supergroups only.
|
|
1758
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2155
1759
|
|
|
2156
|
-
:param
|
|
2157
|
-
chats only.
|
|
1760
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2158
1761
|
|
|
2159
|
-
:param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram
|
|
2160
|
-
|
|
2161
|
-
photo from the Internet, or upload a new photo using multipart/form-data. \
|
|
2162
|
-
The photo must be at most 10 MB in size. The photo's width and height must not \
|
|
2163
|
-
exceed 10000 in total. Width and height ratio must be at most 20. More information \
|
|
2164
|
-
on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1762
|
+
:param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegramservers (recommended), pass an HTTP URL as a String for Telegram to get aphoto from the Internet, or upload a new photo using multipart/form-data.The photo must be at most 10 MB in size. The photo's width and height must notexceed 10000 in total. Width and height ratio must be at most 20. More informationon Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1763
|
+
:param caption: Photo caption (may also be used when resending photos by file_id), 0-1024characters after entities parsing.
|
|
2165
1764
|
|
|
2166
|
-
:param
|
|
2167
|
-
characters after entities parsing.
|
|
1765
|
+
:param parse_mode: Mode for parsing entities in the photo caption. See formatting optionsfor more details.
|
|
2168
1766
|
|
|
2169
|
-
:param
|
|
2170
|
-
for more details.
|
|
1767
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2171
1768
|
|
|
2172
|
-
:param
|
|
2173
|
-
which can be specified instead of parse_mode.
|
|
1769
|
+
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2174
1770
|
|
|
2175
1771
|
:param has_spoiler: Pass True if the photo needs to be covered with a spoiler animation.
|
|
2176
1772
|
|
|
2177
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2178
|
-
|
|
2179
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2180
|
-
|
|
1773
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2181
1774
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2182
1775
|
|
|
1776
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1777
|
+
|
|
2183
1778
|
:param reply_parameters: Description of the message to reply to.
|
|
2184
1779
|
|
|
2185
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2186
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2187
|
-
or to force a reply from the user."""
|
|
1780
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2188
1781
|
|
|
2189
1782
|
...
|
|
2190
1783
|
|
|
@@ -2204,44 +1797,35 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2204
1797
|
disable_notification: bool | None = None,
|
|
2205
1798
|
protect_content: bool | None = None,
|
|
2206
1799
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2207
|
-
reply_markup:
|
|
1800
|
+
reply_markup: InlineKeyboardMarkup
|
|
1801
|
+
| ReplyKeyboardMarkup
|
|
1802
|
+
| ReplyKeyboardRemove
|
|
1803
|
+
| ForceReply
|
|
1804
|
+
| None = None,
|
|
2208
1805
|
**other: typing.Any,
|
|
2209
1806
|
) -> Result[MessageCute, APIError]:
|
|
2210
1807
|
"""Shortcut `API.send_sticker()`, see the [documentation](https://core.telegram.org/bots/api#sendsticker)
|
|
2211
1808
|
|
|
2212
|
-
Use this method to send
|
|
1809
|
+
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers.
|
|
2213
1810
|
On success, the sent Message is returned.
|
|
1811
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2214
1812
|
|
|
2215
|
-
:param
|
|
2216
|
-
will be sent.
|
|
2217
|
-
|
|
2218
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2219
|
-
(in the format @channelusername).
|
|
1813
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2220
1814
|
|
|
2221
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
2222
|
-
forum supergroups only.
|
|
1815
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2223
1816
|
|
|
2224
|
-
:param
|
|
2225
|
-
chats only.
|
|
2226
|
-
|
|
2227
|
-
:param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the \
|
|
2228
|
-
Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
2229
|
-
to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker \
|
|
2230
|
-
using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2231
|
-
Video stickers can only be sent by a file_id. Animated stickers can't be \
|
|
2232
|
-
sent via an HTTP URL.
|
|
1817
|
+
:param sticker: Sticker to send. Pass a file_id as String to send a file that exists on theTelegram servers (recommended), pass an HTTP URL as a String for Telegramto get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBMsticker using multipart/form-data. More information on Sending Files:https://core.telegram.org/bots/api#sending-files. Video and animatedstickers can't be sent via an HTTP URL.
|
|
2233
1818
|
|
|
2234
1819
|
:param emoji: Emoji associated with the sticker; only for just uploaded stickers.
|
|
2235
1820
|
|
|
2236
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2237
|
-
|
|
1821
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2238
1822
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2239
1823
|
|
|
1824
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1825
|
+
|
|
2240
1826
|
:param reply_parameters: Description of the message to reply to.
|
|
2241
1827
|
|
|
2242
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2243
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2244
|
-
or to force a reply from the user."""
|
|
1828
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2245
1829
|
|
|
2246
1830
|
...
|
|
2247
1831
|
|
|
@@ -2253,6 +1837,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2253
1837
|
async def reply_video(
|
|
2254
1838
|
self,
|
|
2255
1839
|
sticker: InputFile | str,
|
|
1840
|
+
video: InputFile | str,
|
|
2256
1841
|
chat_id: int | str | None = None,
|
|
2257
1842
|
emoji: str | None = None,
|
|
2258
1843
|
message_thread_id: int | None = None,
|
|
@@ -2261,69 +1846,62 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2261
1846
|
disable_notification: bool | None = None,
|
|
2262
1847
|
protect_content: bool | None = None,
|
|
2263
1848
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2264
|
-
reply_markup:
|
|
1849
|
+
reply_markup: InlineKeyboardMarkup
|
|
1850
|
+
| ReplyKeyboardMarkup
|
|
1851
|
+
| ReplyKeyboardRemove
|
|
1852
|
+
| ForceReply
|
|
1853
|
+
| None = None,
|
|
1854
|
+
duration: int | None = None,
|
|
1855
|
+
width: int | None = None,
|
|
1856
|
+
height: int | None = None,
|
|
1857
|
+
thumbnail: InputFile | str | None = None,
|
|
1858
|
+
caption: str | None = None,
|
|
1859
|
+
caption_entities: list[MessageEntity] | None = None,
|
|
1860
|
+
show_caption_above_media: bool | None = None,
|
|
1861
|
+
has_spoiler: bool | None = None,
|
|
1862
|
+
supports_streaming: bool | None = None,
|
|
2265
1863
|
**other: typing.Any,
|
|
2266
1864
|
) -> Result[MessageCute, APIError]:
|
|
2267
1865
|
"""Shortcut `API.send_video()`, see the [documentation](https://core.telegram.org/bots/api#sendvideo)
|
|
2268
1866
|
|
|
2269
|
-
Use this method to send
|
|
1867
|
+
Use this method to send video files, Telegram clients support MPEG4 videos
|
|
2270
1868
|
(other formats may be sent as Document). On success, the sent Message is
|
|
2271
1869
|
returned. Bots can currently send video files of up to 50 MB in size, this
|
|
2272
1870
|
limit may be changed in the future.
|
|
1871
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2273
1872
|
|
|
2274
|
-
:param
|
|
2275
|
-
will be sent.
|
|
1873
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2276
1874
|
|
|
2277
|
-
:param
|
|
2278
|
-
(in the format @channelusername).
|
|
2279
|
-
|
|
2280
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2281
|
-
forum supergroups only.
|
|
2282
|
-
|
|
2283
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2284
|
-
chats only.
|
|
2285
|
-
|
|
2286
|
-
:param video: Video to send. Pass a file_id as String to send a video that exists on the Telegram \
|
|
2287
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
2288
|
-
video from the Internet, or upload a new video using multipart/form-data. \
|
|
2289
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1875
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2290
1876
|
|
|
1877
|
+
:param video: Video to send. Pass a file_id as String to send a video that exists on the Telegramservers (recommended), pass an HTTP URL as a String for Telegram to get avideo from the Internet, or upload a new video using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
2291
1878
|
:param duration: Duration of sent video in seconds.
|
|
2292
1879
|
|
|
2293
1880
|
:param width: Video width.
|
|
2294
1881
|
|
|
2295
1882
|
:param height: Video height.
|
|
2296
1883
|
|
|
2297
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
2298
|
-
|
|
2299
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2300
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2301
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2302
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2303
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1884
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1885
|
+
:param caption: Video caption (may also be used when resending videos by file_id), 0-1024characters after entities parsing.
|
|
2304
1886
|
|
|
2305
|
-
:param
|
|
2306
|
-
characters after entities parsing.
|
|
1887
|
+
:param parse_mode: Mode for parsing entities in the video caption. See formatting optionsfor more details.
|
|
2307
1888
|
|
|
2308
|
-
:param
|
|
2309
|
-
for more details.
|
|
1889
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2310
1890
|
|
|
2311
|
-
:param
|
|
2312
|
-
which can be specified instead of parse_mode.
|
|
1891
|
+
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2313
1892
|
|
|
2314
1893
|
:param has_spoiler: Pass True if the video needs to be covered with a spoiler animation.
|
|
2315
1894
|
|
|
2316
1895
|
:param supports_streaming: Pass True if the uploaded video is suitable for streaming.
|
|
2317
1896
|
|
|
2318
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2319
|
-
|
|
1897
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2320
1898
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2321
1899
|
|
|
1900
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1901
|
+
|
|
2322
1902
|
:param reply_parameters: Description of the message to reply to.
|
|
2323
1903
|
|
|
2324
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2325
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2326
|
-
or to force a reply from the user."""
|
|
1904
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2327
1905
|
|
|
2328
1906
|
...
|
|
2329
1907
|
|
|
@@ -2345,53 +1923,39 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2345
1923
|
disable_notification: bool | None = None,
|
|
2346
1924
|
protect_content: bool | None = None,
|
|
2347
1925
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2348
|
-
reply_markup:
|
|
1926
|
+
reply_markup: InlineKeyboardMarkup
|
|
1927
|
+
| ReplyKeyboardMarkup
|
|
1928
|
+
| ReplyKeyboardRemove
|
|
1929
|
+
| ForceReply
|
|
1930
|
+
| None = None,
|
|
2349
1931
|
**other: typing.Any,
|
|
2350
1932
|
) -> Result[MessageCute, APIError]:
|
|
2351
1933
|
"""Shortcut `API.send_video_note()`, see the [documentation](https://core.telegram.org/bots/api#sendvideonote)
|
|
2352
1934
|
|
|
2353
1935
|
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up
|
|
2354
|
-
to 1 minute long. Use this method to send
|
|
1936
|
+
to 1 minute long. Use this method to send video messages. On success, the
|
|
2355
1937
|
sent Message is returned.
|
|
1938
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2356
1939
|
|
|
2357
|
-
:param
|
|
2358
|
-
will be sent.
|
|
2359
|
-
|
|
2360
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2361
|
-
(in the format @channelusername).
|
|
2362
|
-
|
|
2363
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2364
|
-
forum supergroups only.
|
|
1940
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2365
1941
|
|
|
2366
|
-
:param
|
|
2367
|
-
chats only.
|
|
1942
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2368
1943
|
|
|
2369
|
-
:param video_note: Video note to send. Pass a file_id as String to send a video note that
|
|
2370
|
-
on the Telegram servers (recommended) or upload a new video using multipart/form-data. \
|
|
2371
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2372
|
-
Sending video notes by a URL is currently unsupported.
|
|
1944
|
+
:param video_note: Video note to send. Pass a file_id as String to send a video note that existson the Telegram servers (recommended) or upload a new video using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.Sending video notes by a URL is currently unsupported.
|
|
2373
1945
|
|
|
2374
1946
|
:param duration: Duration of sent video in seconds.
|
|
2375
1947
|
|
|
2376
1948
|
:param length: Video width and height, i.e. diameter of the video message.
|
|
2377
1949
|
|
|
2378
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
2379
|
-
|
|
2380
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2381
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2382
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2383
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2384
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2385
|
-
|
|
2386
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2387
|
-
|
|
1950
|
+
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for thefile is supported server-side. The thumbnail should be in JPEG format andless than 200 kB in size. A thumbnail's width and height should not exceed320. Ignored if the file is not uploaded using multipart/form-data. Thumbnailscan't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>`if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
1951
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2388
1952
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2389
1953
|
|
|
1954
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1955
|
+
|
|
2390
1956
|
:param reply_parameters: Description of the message to reply to.
|
|
2391
1957
|
|
|
2392
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2393
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2394
|
-
or to force a reply from the user."""
|
|
1958
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2395
1959
|
|
|
2396
1960
|
...
|
|
2397
1961
|
|
|
@@ -2414,53 +1978,44 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2414
1978
|
disable_notification: bool | None = None,
|
|
2415
1979
|
protect_content: bool | None = None,
|
|
2416
1980
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2417
|
-
reply_markup:
|
|
1981
|
+
reply_markup: InlineKeyboardMarkup
|
|
1982
|
+
| ReplyKeyboardMarkup
|
|
1983
|
+
| ReplyKeyboardRemove
|
|
1984
|
+
| ForceReply
|
|
1985
|
+
| None = None,
|
|
2418
1986
|
**other: typing.Any,
|
|
2419
1987
|
) -> Result[MessageCute, APIError]:
|
|
2420
1988
|
"""Shortcut `API.send_voice()`, see the [documentation](https://core.telegram.org/bots/api#sendvoice)
|
|
2421
1989
|
|
|
2422
|
-
Use this method to send
|
|
1990
|
+
Use this method to send audio files, if you want Telegram clients to display
|
|
2423
1991
|
the file as a playable voice message. For this to work, your audio must be
|
|
2424
|
-
in an .OGG file encoded with OPUS
|
|
2425
|
-
|
|
2426
|
-
messages of up to 50 MB in size, this
|
|
2427
|
-
|
|
2428
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the
|
|
2429
|
-
will be sent.
|
|
2430
|
-
|
|
2431
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2432
|
-
(in the format @channelusername).
|
|
2433
|
-
|
|
2434
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2435
|
-
forum supergroups only.
|
|
1992
|
+
in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other
|
|
1993
|
+
formats may be sent as Audio or Document). On success, the sent Message is
|
|
1994
|
+
returned. Bots can currently send voice messages of up to 50 MB in size, this
|
|
1995
|
+
limit may be changed in the future.
|
|
1996
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2436
1997
|
|
|
2437
|
-
:param
|
|
2438
|
-
chats only.
|
|
1998
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2439
1999
|
|
|
2440
|
-
:param
|
|
2441
|
-
Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
2442
|
-
to get a file from the Internet, or upload a new one using multipart/form-data. \
|
|
2443
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2000
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2444
2001
|
|
|
2002
|
+
:param voice: Audio file to send. Pass a file_id as String to send a file that exists on theTelegram servers (recommended), pass an HTTP URL as a String for Telegramto get a file from the Internet, or upload a new one using multipart/form-data.More information on Sending Files: https://core.telegram.org/bots/api#sending-files.
|
|
2445
2003
|
:param caption: Voice message caption, 0-1024 characters after entities parsing.
|
|
2446
2004
|
|
|
2447
|
-
:param parse_mode: Mode for parsing entities in the voice message caption. See
|
|
2448
|
-
options for more details.
|
|
2005
|
+
:param parse_mode: Mode for parsing entities in the voice message caption. See formattingoptions for more details.
|
|
2449
2006
|
|
|
2450
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
2451
|
-
which can be specified instead of parse_mode.
|
|
2007
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2452
2008
|
|
|
2453
2009
|
:param duration: Duration of the voice message in seconds.
|
|
2454
2010
|
|
|
2455
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2456
|
-
|
|
2011
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2457
2012
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2458
2013
|
|
|
2014
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2015
|
+
|
|
2459
2016
|
:param reply_parameters: Description of the message to reply to.
|
|
2460
2017
|
|
|
2461
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2462
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2463
|
-
or to force a reply from the user."""
|
|
2018
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2464
2019
|
|
|
2465
2020
|
...
|
|
2466
2021
|
|
|
@@ -2493,32 +2048,27 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2493
2048
|
disable_notification: bool | None = None,
|
|
2494
2049
|
protect_content: bool | None = None,
|
|
2495
2050
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2496
|
-
reply_markup:
|
|
2051
|
+
reply_markup: InlineKeyboardMarkup
|
|
2052
|
+
| ReplyKeyboardMarkup
|
|
2053
|
+
| ReplyKeyboardRemove
|
|
2054
|
+
| ForceReply
|
|
2055
|
+
| None = None,
|
|
2497
2056
|
**other: typing.Any,
|
|
2498
2057
|
) -> Result[MessageCute, APIError]:
|
|
2499
2058
|
"""Shortcut `API.send_poll()`, see the [documentation](https://core.telegram.org/bots/api#sendpoll)
|
|
2500
2059
|
|
|
2501
|
-
Use this method to send a
|
|
2502
|
-
|
|
2503
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2504
|
-
will be sent.
|
|
2505
|
-
|
|
2506
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2507
|
-
(in the format @channelusername).
|
|
2060
|
+
Use this method to send a native poll. On success, the sent Message is returned.
|
|
2061
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2508
2062
|
|
|
2509
|
-
:param
|
|
2510
|
-
forum supergroups only.
|
|
2063
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2511
2064
|
|
|
2512
|
-
:param
|
|
2513
|
-
chats only.
|
|
2065
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2514
2066
|
|
|
2515
|
-
:param
|
|
2516
|
-
details. Currently, only custom emoji entities are allowed.
|
|
2067
|
+
:param question: Poll question, 1-300 characters.
|
|
2517
2068
|
|
|
2518
|
-
:param
|
|
2519
|
-
It can be specified instead of question_parse_mode.
|
|
2069
|
+
:param question_parse_mode: Mode for parsing entities in the question. See formatting options for moredetails. Currently, only custom emoji entities are allowed.
|
|
2520
2070
|
|
|
2521
|
-
:param
|
|
2071
|
+
:param question_entities: A JSON-serialized list of special entities that appear in the poll question.It can be specified instead of question_parse_mode.
|
|
2522
2072
|
|
|
2523
2073
|
:param options: A JSON-serialized list of 2-10 answer options.
|
|
2524
2074
|
|
|
@@ -2526,43 +2076,30 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2526
2076
|
|
|
2527
2077
|
:param type: Poll type, `quiz` or `regular`, defaults to `regular`.
|
|
2528
2078
|
|
|
2529
|
-
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,
|
|
2530
|
-
defaults to False.
|
|
2531
|
-
|
|
2532
|
-
:param correct_option_id: 0-based identifier of the correct answer option, required for polls in \
|
|
2533
|
-
quiz mode.
|
|
2079
|
+
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,defaults to False.
|
|
2534
2080
|
|
|
2535
|
-
:param
|
|
2536
|
-
icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after \
|
|
2537
|
-
entities parsing.
|
|
2081
|
+
:param correct_option_id: 0-based identifier of the correct answer option, required for polls inquiz mode.
|
|
2538
2082
|
|
|
2539
|
-
:param
|
|
2540
|
-
more details.
|
|
2083
|
+
:param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lampicon in a quiz-style poll, 0-200 characters with at most 2 line feeds afterentities parsing.
|
|
2541
2084
|
|
|
2542
|
-
:param
|
|
2543
|
-
which can be specified instead of parse_mode.
|
|
2085
|
+
:param explanation_parse_mode: Mode for parsing entities in the explanation. See formatting options formore details.
|
|
2544
2086
|
|
|
2545
|
-
:param
|
|
2546
|
-
Can't be used together with close_date.
|
|
2087
|
+
:param explanation_entities: A JSON-serialized list of special entities that appear in the poll explanation.It can be specified instead of explanation_parse_mode.
|
|
2547
2088
|
|
|
2548
|
-
:param
|
|
2549
|
-
Must be at least 5 and no more than 600 seconds in the future. Can't be used \
|
|
2550
|
-
together with open_period.
|
|
2089
|
+
:param open_period: Amount of time in seconds the poll will be active after creation, 5-600.Can't be used together with close_date.
|
|
2551
2090
|
|
|
2552
|
-
:param
|
|
2553
|
-
poll preview.
|
|
2091
|
+
:param close_date: Point in time (Unix timestamp) when the poll will be automatically closed.Must be at least 5 and no more than 600 seconds in the future. Can't be usedtogether with open_period.
|
|
2554
2092
|
|
|
2555
|
-
:param
|
|
2556
|
-
|
|
2557
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2093
|
+
:param is_closed: Pass True if the poll needs to be immediately closed. This can be useful forpoll preview.
|
|
2558
2094
|
|
|
2095
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2559
2096
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2560
2097
|
|
|
2098
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2099
|
+
|
|
2561
2100
|
:param reply_parameters: Description of the message to reply to.
|
|
2562
2101
|
|
|
2563
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2564
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2565
|
-
or to force a reply from the user."""
|
|
2102
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2566
2103
|
|
|
2567
2104
|
...
|
|
2568
2105
|
|
|
@@ -2588,25 +2125,22 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2588
2125
|
disable_notification: bool | None = None,
|
|
2589
2126
|
protect_content: bool | None = None,
|
|
2590
2127
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2591
|
-
reply_markup:
|
|
2128
|
+
reply_markup: InlineKeyboardMarkup
|
|
2129
|
+
| ReplyKeyboardMarkup
|
|
2130
|
+
| ReplyKeyboardRemove
|
|
2131
|
+
| ForceReply
|
|
2132
|
+
| None = None,
|
|
2592
2133
|
**other: typing.Any,
|
|
2593
2134
|
) -> Result[MessageCute, APIError]:
|
|
2594
2135
|
"""Shortcut `API.send_venue()`, see the [documentation](https://core.telegram.org/bots/api#sendvenue)
|
|
2595
2136
|
|
|
2596
|
-
Use this method to send
|
|
2137
|
+
Use this method to send information about a venue. On success, the sent Message
|
|
2597
2138
|
is returned.
|
|
2139
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2598
2140
|
|
|
2599
|
-
:param
|
|
2600
|
-
will be sent.
|
|
2601
|
-
|
|
2602
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2603
|
-
(in the format @channelusername).
|
|
2604
|
-
|
|
2605
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2606
|
-
forum supergroups only.
|
|
2141
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2607
2142
|
|
|
2608
|
-
:param
|
|
2609
|
-
chats only.
|
|
2143
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2610
2144
|
|
|
2611
2145
|
:param latitude: Latitude of the venue.
|
|
2612
2146
|
|
|
@@ -2618,22 +2152,20 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2618
2152
|
|
|
2619
2153
|
:param foursquare_id: Foursquare identifier of the venue.
|
|
2620
2154
|
|
|
2621
|
-
:param foursquare_type: Foursquare type of the venue, if known. (For example, `arts_entertainment/default
|
|
2622
|
-
`arts_entertainment/aquarium` or `food/icecream`.).
|
|
2155
|
+
:param foursquare_type: Foursquare type of the venue, if known. (For example, `arts_entertainment/default`,`arts_entertainment/aquarium` or `food/icecream`.).
|
|
2623
2156
|
|
|
2624
2157
|
:param google_place_id: Google Places identifier of the venue.
|
|
2625
2158
|
|
|
2626
2159
|
:param google_place_type: Google Places type of the venue. (See supported types.).
|
|
2627
2160
|
|
|
2628
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2629
|
-
|
|
2161
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2630
2162
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2631
2163
|
|
|
2164
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2165
|
+
|
|
2632
2166
|
:param reply_parameters: Description of the message to reply to.
|
|
2633
2167
|
|
|
2634
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2635
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2636
|
-
or to force a reply from the user."""
|
|
2168
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2637
2169
|
|
|
2638
2170
|
...
|
|
2639
2171
|
|
|
@@ -2652,39 +2184,32 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2652
2184
|
disable_notification: bool | None = None,
|
|
2653
2185
|
protect_content: bool | None = None,
|
|
2654
2186
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2655
|
-
reply_markup:
|
|
2187
|
+
reply_markup: InlineKeyboardMarkup
|
|
2188
|
+
| ReplyKeyboardMarkup
|
|
2189
|
+
| ReplyKeyboardRemove
|
|
2190
|
+
| ForceReply
|
|
2191
|
+
| None = None,
|
|
2656
2192
|
**other: typing.Any,
|
|
2657
2193
|
) -> Result[MessageCute, APIError]:
|
|
2658
2194
|
"""Shortcut `API.send_dice()`, see the [documentation](https://core.telegram.org/bots/api#senddice)
|
|
2659
2195
|
|
|
2660
|
-
Use this method to send
|
|
2196
|
+
Use this method to send an animated emoji that will display a random value.
|
|
2661
2197
|
On success, the sent Message is returned.
|
|
2198
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2662
2199
|
|
|
2663
|
-
:param
|
|
2664
|
-
will be sent.
|
|
2665
|
-
|
|
2666
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2667
|
-
(in the format @channelusername).
|
|
2668
|
-
|
|
2669
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2670
|
-
forum supergroups only.
|
|
2200
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2671
2201
|
|
|
2672
|
-
:param
|
|
2673
|
-
chats only.
|
|
2674
|
-
|
|
2675
|
-
:param emoji: Emoji on which the dice throw animation is based. Currently, must be one \
|
|
2676
|
-
of `🎲`, `🎯`, `🏀`, `⚽`, `🎳`, or `🎰`. Dice can have values 1-6 for `🎲`, `🎯` and \
|
|
2677
|
-
`🎳`, values 1-5 for `🏀` and `⚽`, and values 1-64 for `🎰`. Defaults to `🎲`. \
|
|
2678
|
-
|
|
2679
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2202
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2680
2203
|
|
|
2204
|
+
:param emoji: Emoji on which the dice throw animation is based. Currently, must be oneof `🎲`, `🎯`, `🏀`, `⚽`, `🎳`, or `🎰`. Dice can have values 1-6 for `🎲`, `🎯` and`🎳`, values 1-5 for `🏀` and `⚽`, and values 1-64 for `🎰`. Defaults to `🎲`.
|
|
2205
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2681
2206
|
:param protect_content: Protects the contents of the sent message from forwarding.
|
|
2682
2207
|
|
|
2208
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2209
|
+
|
|
2683
2210
|
:param reply_parameters: Description of the message to reply to.
|
|
2684
2211
|
|
|
2685
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2686
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2687
|
-
or to force a reply from the user."""
|
|
2212
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2688
2213
|
|
|
2689
2214
|
...
|
|
2690
2215
|
|
|
@@ -2703,35 +2228,28 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2703
2228
|
disable_notification: bool | None = None,
|
|
2704
2229
|
protect_content: bool | None = None,
|
|
2705
2230
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2706
|
-
reply_markup:
|
|
2231
|
+
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2707
2232
|
**other: typing.Any,
|
|
2708
2233
|
) -> Result[MessageCute, APIError]:
|
|
2709
2234
|
"""Shortcut `API.send_game()`, see the [documentation](https://core.telegram.org/bots/api#sendgame)
|
|
2710
2235
|
|
|
2711
|
-
Use this method to send a
|
|
2712
|
-
|
|
2713
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2714
|
-
will be sent.
|
|
2236
|
+
Use this method to send a game. On success, the sent Message is returned.
|
|
2237
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2715
2238
|
|
|
2716
2239
|
:param chat_id: Unique identifier for the target chat.
|
|
2717
2240
|
|
|
2718
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
2719
|
-
forum supergroups only.
|
|
2720
|
-
|
|
2721
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2722
|
-
chats only.
|
|
2723
|
-
|
|
2724
|
-
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Set \
|
|
2725
|
-
up your games via @BotFather.
|
|
2241
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2726
2242
|
|
|
2727
|
-
:param
|
|
2243
|
+
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Setup your games via @BotFather.
|
|
2728
2244
|
|
|
2245
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2729
2246
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2730
2247
|
|
|
2248
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2249
|
+
|
|
2731
2250
|
:param reply_parameters: Description of the message to reply to.
|
|
2732
2251
|
|
|
2733
|
-
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'
|
|
2734
|
-
button will be shown. If not empty, the first button must launch the game."""
|
|
2252
|
+
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'button will be shown. If not empty, the first button must launch the game."""
|
|
2735
2253
|
|
|
2736
2254
|
...
|
|
2737
2255
|
|
|
@@ -2775,87 +2293,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2775
2293
|
) -> Result[MessageCute, APIError]:
|
|
2776
2294
|
"""Shortcut `API.send_invoice()`, see the [documentation](https://core.telegram.org/bots/api#sendinvoice)
|
|
2777
2295
|
|
|
2778
|
-
Use this method to send
|
|
2779
|
-
|
|
2780
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2781
|
-
will be sent.
|
|
2782
|
-
|
|
2783
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2784
|
-
(in the format @channelusername).
|
|
2785
|
-
|
|
2786
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2787
|
-
forum supergroups only.
|
|
2788
|
-
|
|
2789
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2790
|
-
chats only.
|
|
2791
|
-
|
|
2792
|
-
:param title: Product name, 1-32 characters.
|
|
2793
|
-
|
|
2794
|
-
:param description: Product description, 1-255 characters.
|
|
2795
|
-
|
|
2796
|
-
:param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to \
|
|
2797
|
-
the user, use for your internal processes.
|
|
2798
|
-
|
|
2799
|
-
:param provider_token: Payment provider token, obtained via @BotFather.
|
|
2800
|
-
|
|
2801
|
-
:param currency: Three-letter ISO 4217 currency code, see more on currencies.
|
|
2802
|
-
|
|
2803
|
-
:param prices: Price breakdown, a JSON-serialized list of components (e.g. product price, \
|
|
2804
|
-
tax, discount, delivery cost, delivery tax, bonus, etc.).
|
|
2805
|
-
|
|
2806
|
-
:param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency \
|
|
2807
|
-
(integer, not float/double). For example, for a maximum tip of US$ 1.45 \
|
|
2808
|
-
pass max_tip_amount = 145. See the exp parameter in currencies.json, it \
|
|
2809
|
-
shows the number of digits past the decimal point for each currency (2 for \
|
|
2810
|
-
the majority of currencies). Defaults to 0.
|
|
2811
|
-
|
|
2812
|
-
:param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest units \
|
|
2813
|
-
of the currency (integer, not float/double). At most 4 suggested tip amounts \
|
|
2814
|
-
can be specified. The suggested tip amounts must be positive, passed in \
|
|
2815
|
-
a strictly increased order and must not exceed max_tip_amount.
|
|
2816
|
-
|
|
2817
|
-
:param start_parameter: Unique deep-linking parameter. If left empty, forwarded copies of the \
|
|
2818
|
-
sent message will have a Pay button, allowing multiple users to pay directly \
|
|
2819
|
-
from the forwarded message, using the same invoice. If non-empty, forwarded \
|
|
2820
|
-
copies of the sent message will have a URL button with a deep link to the bot \
|
|
2821
|
-
(instead of a Pay button), with the value used as the start parameter.
|
|
2822
|
-
|
|
2823
|
-
:param provider_data: JSON-serialized data about the invoice, which will be shared with the payment \
|
|
2824
|
-
provider. A detailed description of required fields should be provided \
|
|
2825
|
-
by the payment provider.
|
|
2826
|
-
|
|
2827
|
-
:param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or a marketing \
|
|
2828
|
-
image for a service. People like it better when they see what they are paying \
|
|
2829
|
-
for.
|
|
2830
|
-
|
|
2831
|
-
:param photo_size: Photo size in bytes.
|
|
2832
|
-
|
|
2833
|
-
:param photo_width: Photo width.
|
|
2834
|
-
|
|
2835
|
-
:param photo_height: Photo height.
|
|
2836
|
-
|
|
2837
|
-
:param need_name: Pass True if you require the user's full name to complete the order.
|
|
2838
|
-
|
|
2839
|
-
:param need_phone_number: Pass True if you require the user's phone number to complete the order.
|
|
2840
|
-
|
|
2841
|
-
:param need_email: Pass True if you require the user's email address to complete the order. \
|
|
2842
|
-
|
|
2843
|
-
:param need_shipping_address: Pass True if you require the user's shipping address to complete the order. \
|
|
2844
|
-
|
|
2845
|
-
:param send_phone_number_to_provider: Pass True if the user's phone number should be sent to provider.
|
|
2846
|
-
|
|
2847
|
-
:param send_email_to_provider: Pass True if the user's email address should be sent to provider.
|
|
2848
|
-
|
|
2849
|
-
:param is_flexible: Pass True if the final price depends on the shipping method.
|
|
2850
|
-
|
|
2851
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2852
|
-
|
|
2853
|
-
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2854
|
-
|
|
2855
|
-
:param reply_parameters: Description of the message to reply to.
|
|
2856
|
-
|
|
2857
|
-
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay total \
|
|
2858
|
-
price' button will be shown. If not empty, the first button must be a Pay button."""
|
|
2296
|
+
Use this method to send invoices. On success, the sent Message is returned."""
|
|
2859
2297
|
|
|
2860
2298
|
...
|
|
2861
2299
|
|
|
@@ -2873,13 +2311,13 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2873
2311
|
)
|
|
2874
2312
|
async def reply_media_group(
|
|
2875
2313
|
self,
|
|
2876
|
-
media:
|
|
2314
|
+
media: InputMediaType | list[InputMediaType],
|
|
2877
2315
|
chat_id: int | str | None = None,
|
|
2878
2316
|
business_connection_id: str | None = None,
|
|
2879
2317
|
message_thread_id: int | None = None,
|
|
2880
2318
|
message_effect_id: str | None = None,
|
|
2881
|
-
caption: str | None = None,
|
|
2882
|
-
parse_mode: str | None = None,
|
|
2319
|
+
caption: str | list[str] | None = None,
|
|
2320
|
+
parse_mode: str | list[str] | None = None,
|
|
2883
2321
|
caption_entities: list[MessageEntity] | None = None,
|
|
2884
2322
|
disable_notification: bool | None = None,
|
|
2885
2323
|
protect_content: bool | None = None,
|
|
@@ -2888,36 +2326,20 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2888
2326
|
) -> Result[list[MessageCute], APIError]:
|
|
2889
2327
|
"""Shortcut `API.send_media_group()`, see the [documentation](https://core.telegram.org/bots/api#sendmediagroup)
|
|
2890
2328
|
|
|
2891
|
-
Use this method to send a
|
|
2329
|
+
Use this method to send a group of photos, videos, documents or audios as
|
|
2892
2330
|
an album. Documents and audio files can be only grouped in an album with messages
|
|
2893
2331
|
of the same type. On success, an array of Messages that were sent is returned.
|
|
2332
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2894
2333
|
|
|
2895
|
-
:param
|
|
2896
|
-
will be sent.
|
|
2897
|
-
|
|
2898
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2899
|
-
(in the format @channelusername).
|
|
2334
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2900
2335
|
|
|
2901
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
2902
|
-
forum supergroups only.
|
|
2336
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2903
2337
|
|
|
2904
|
-
:param
|
|
2905
|
-
chats only.
|
|
2906
|
-
|
|
2907
|
-
:param media: A JSON-serialized array describing messages to be sent, must include 2-10 \
|
|
2908
|
-
items.
|
|
2909
|
-
|
|
2910
|
-
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
2338
|
+
:param media: A JSON-serialized array describing messages to be sent, must include 2-10items.
|
|
2911
2339
|
|
|
2912
|
-
:param
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
2916
|
-
which can be specified instead of parse_mode.
|
|
2917
|
-
|
|
2918
|
-
:param disable_notification: Sends messages silently. Users will receive a notification with no sound. \
|
|
2919
|
-
|
|
2920
|
-
:param protect_content: Protects the contents of the sent messages from forwarding and saving. \
|
|
2340
|
+
:param disable_notification: Sends messages silently. Users will receive a notification with no sound.
|
|
2341
|
+
:param protect_content: Protects the contents of the sent messages from forwarding and saving.
|
|
2342
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2921
2343
|
|
|
2922
2344
|
:param reply_parameters: Description of the message to reply to."""
|
|
2923
2345
|
|
|
@@ -2945,49 +2367,40 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2945
2367
|
disable_notification: bool | None = None,
|
|
2946
2368
|
protect_content: bool | None = None,
|
|
2947
2369
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2948
|
-
reply_markup:
|
|
2370
|
+
reply_markup: InlineKeyboardMarkup
|
|
2371
|
+
| ReplyKeyboardMarkup
|
|
2372
|
+
| ReplyKeyboardRemove
|
|
2373
|
+
| ForceReply
|
|
2374
|
+
| None = None,
|
|
2949
2375
|
**other: typing.Any,
|
|
2950
2376
|
) -> Result[MessageCute, APIError]:
|
|
2951
2377
|
"""Shortcut `API.send_location()`, see the [documentation](https://core.telegram.org/bots/api#sendlocation)
|
|
2952
2378
|
|
|
2953
|
-
Use this method to send
|
|
2954
|
-
|
|
2955
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2956
|
-
will be sent.
|
|
2957
|
-
|
|
2958
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2959
|
-
(in the format @channelusername).
|
|
2379
|
+
Use this method to send point on the map. On success, the sent Message is returned.
|
|
2380
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2960
2381
|
|
|
2961
|
-
:param
|
|
2962
|
-
forum supergroups only.
|
|
2382
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2963
2383
|
|
|
2964
|
-
:param
|
|
2965
|
-
chats only.
|
|
2384
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2966
2385
|
|
|
2967
2386
|
:param latitude: Latitude of the location.
|
|
2968
2387
|
|
|
2969
2388
|
:param longitude: Longitude of the location.
|
|
2970
2389
|
|
|
2971
|
-
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
2972
|
-
|
|
2973
|
-
:param live_period: Period in seconds for which the location will be updated (see Live Locations, \
|
|
2974
|
-
should be between 60 and 86400.
|
|
2975
|
-
|
|
2976
|
-
:param heading: For live locations, a direction in which the user is moving, in degrees. \
|
|
2977
|
-
Must be between 1 and 360 if specified.
|
|
2390
|
+
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
2391
|
+
:param live_period: Period in seconds during which the location will be updated (see Live Locations,should be between 60 and 86400, or 0x7FFFFFFF for live locations that canbe edited indefinitely.
|
|
2978
2392
|
|
|
2979
|
-
:param
|
|
2980
|
-
another chat member, in meters. Must be between 1 and 100000 if specified. \
|
|
2981
|
-
|
|
2982
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2393
|
+
:param heading: For live locations, a direction in which the user is moving, in degrees.Must be between 1 and 360 if specified.
|
|
2983
2394
|
|
|
2395
|
+
:param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approachinganother chat member, in meters. Must be between 1 and 100000 if specified.
|
|
2396
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2984
2397
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2985
2398
|
|
|
2399
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2400
|
+
|
|
2986
2401
|
:param reply_parameters: Description of the message to reply to.
|
|
2987
2402
|
|
|
2988
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2989
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2990
|
-
or to force a reply from the user."""
|
|
2403
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
2991
2404
|
|
|
2992
2405
|
...
|
|
2993
2406
|
|
|
@@ -3009,24 +2422,21 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3009
2422
|
disable_notification: bool | None = None,
|
|
3010
2423
|
protect_content: bool | None = None,
|
|
3011
2424
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
3012
|
-
reply_markup:
|
|
2425
|
+
reply_markup: InlineKeyboardMarkup
|
|
2426
|
+
| ReplyKeyboardMarkup
|
|
2427
|
+
| ReplyKeyboardRemove
|
|
2428
|
+
| ForceReply
|
|
2429
|
+
| None = None,
|
|
3013
2430
|
**other: typing.Any,
|
|
3014
2431
|
) -> Result[MessageCute, APIError]:
|
|
3015
2432
|
"""Shortcut `API.send_contact()`, see the [documentation](https://core.telegram.org/bots/api#sendcontact)
|
|
3016
2433
|
|
|
3017
|
-
Use this method to send
|
|
3018
|
-
|
|
3019
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
3020
|
-
will be sent.
|
|
3021
|
-
|
|
3022
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
3023
|
-
(in the format @channelusername).
|
|
2434
|
+
Use this method to send phone contacts. On success, the sent Message is returned.
|
|
2435
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
3024
2436
|
|
|
3025
|
-
:param
|
|
3026
|
-
forum supergroups only.
|
|
2437
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
3027
2438
|
|
|
3028
|
-
:param
|
|
3029
|
-
chats only.
|
|
2439
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
3030
2440
|
|
|
3031
2441
|
:param phone_number: Contact's phone number.
|
|
3032
2442
|
|
|
@@ -3036,15 +2446,14 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3036
2446
|
|
|
3037
2447
|
:param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes.
|
|
3038
2448
|
|
|
3039
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
3040
|
-
|
|
2449
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
3041
2450
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
3042
2451
|
|
|
2452
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2453
|
+
|
|
3043
2454
|
:param reply_parameters: Description of the message to reply to.
|
|
3044
2455
|
|
|
3045
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
3046
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
3047
|
-
or to force a reply from the user."""
|
|
2456
|
+
:param reply_markup: Additional interface options. A JSON-serialized object for an inlinekeyboard, custom reply keyboard, instructions to remove a reply keyboardor to force a reply from the user."""
|
|
3048
2457
|
|
|
3049
2458
|
...
|
|
3050
2459
|
|
|
@@ -3066,6 +2475,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3066
2475
|
heading: int | None = None,
|
|
3067
2476
|
proximity_alert_radius: int | None = None,
|
|
3068
2477
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2478
|
+
business_connection_id: str | None = None,
|
|
3069
2479
|
**other: typing.Any,
|
|
3070
2480
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3071
2481
|
"""Shortcut `API.edit_message_live_location()`, see the [documentation](https://core.telegram.org/bots/api#editmessagelivelocation)
|
|
@@ -3074,37 +2484,23 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3074
2484
|
until its live_period expires or editing is explicitly disabled by a call
|
|
3075
2485
|
to stopMessageLiveLocation. On success, if the edited message is not an
|
|
3076
2486
|
inline message, the edited Message is returned, otherwise True is returned.
|
|
2487
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messageto be edited was sent.
|
|
3077
2488
|
|
|
3078
|
-
:param chat_id: Required if inline_message_id is not specified. Unique identifier
|
|
3079
|
-
|
|
2489
|
+
:param chat_id: Required if inline_message_id is not specified. Unique identifier forthe target chat or username of the target channel (in the format @channelusername).
|
|
2490
|
+
:param message_id: Required if inline_message_id is not specified. Identifier of the messageto edit.
|
|
3080
2491
|
|
|
3081
|
-
:param
|
|
3082
|
-
to edit.
|
|
3083
|
-
|
|
3084
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
3085
|
-
forum supergroups only.
|
|
3086
|
-
|
|
3087
|
-
:param live_period: New period in seconds during which the location can be updated, starting \
|
|
3088
|
-
from the message send date. If 0x7FFFFFFF is specified, then the location \
|
|
3089
|
-
can be updated forever. Otherwise, the new value must not exceed the current \
|
|
3090
|
-
live_period by more than a day, and the live location expiration date must \
|
|
3091
|
-
remain within the next 90 days. If not specified, then live_period remains \
|
|
3092
|
-
unchanged.
|
|
3093
|
-
|
|
3094
|
-
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the \
|
|
3095
|
-
inline message.
|
|
2492
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3096
2493
|
|
|
3097
2494
|
:param latitude: Latitude of new location.
|
|
3098
2495
|
|
|
3099
2496
|
:param longitude: Longitude of new location.
|
|
3100
2497
|
|
|
3101
|
-
:param
|
|
2498
|
+
:param live_period: New period in seconds during which the location can be updated, startingfrom the message send date. If 0x7FFFFFFF is specified, then the locationcan be updated forever. Otherwise, the new value must not exceed the currentlive_period by more than a day, and the live location expiration date mustremain within the next 90 days. If not specified, then live_period remainsunchanged.
|
|
3102
2499
|
|
|
3103
|
-
:param
|
|
3104
|
-
|
|
2500
|
+
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
2501
|
+
:param heading: Direction in which the user is moving, in degrees. Must be between 1 and 360if specified.
|
|
3105
2502
|
|
|
3106
|
-
:param proximity_alert_radius: The maximum distance for proximity alerts about approaching another
|
|
3107
|
-
member, in meters. Must be between 1 and 100000 if specified.
|
|
2503
|
+
:param proximity_alert_radius: The maximum distance for proximity alerts about approaching another chatmember, in meters. Must be between 1 and 100000 if specified.
|
|
3108
2504
|
|
|
3109
2505
|
:param reply_markup: A JSON-serialized object for a new inline keyboard."""
|
|
3110
2506
|
|
|
@@ -3117,7 +2513,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3117
2513
|
)
|
|
3118
2514
|
async def edit_caption(
|
|
3119
2515
|
self,
|
|
3120
|
-
caption: str,
|
|
2516
|
+
caption: str | None = None,
|
|
3121
2517
|
chat_id: int | str | None = None,
|
|
3122
2518
|
message_id: int | None = None,
|
|
3123
2519
|
message_thread_id: int | None = None,
|
|
@@ -3125,32 +2521,30 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3125
2521
|
caption_entities: list[MessageEntity] | None = None,
|
|
3126
2522
|
show_caption_above_media: bool | None = None,
|
|
3127
2523
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2524
|
+
business_connection_id: str | None = None,
|
|
2525
|
+
inline_message_id: str | None = None,
|
|
3128
2526
|
**other: typing.Any,
|
|
3129
2527
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3130
2528
|
"""Shortcut `API.edit_message_caption()`, see the [documentation](https://core.telegram.org/bots/api#editmessagecaption)
|
|
3131
2529
|
|
|
3132
2530
|
Use this method to edit captions of messages. On success, if the edited message
|
|
3133
2531
|
is not an inline message, the edited Message is returned, otherwise True
|
|
3134
|
-
is returned.
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
the
|
|
2532
|
+
is returned. Note that business messages that were not sent by the bot and
|
|
2533
|
+
do not contain an inline keyboard can only be edited within 48 hours from
|
|
2534
|
+
the time they were sent.
|
|
2535
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messageto be edited was sent.
|
|
3138
2536
|
|
|
3139
|
-
:param
|
|
3140
|
-
|
|
2537
|
+
:param chat_id: Required if inline_message_id is not specified. Unique identifier forthe target chat or username of the target channel (in the format @channelusername).
|
|
2538
|
+
:param message_id: Required if inline_message_id is not specified. Identifier of the messageto edit.
|
|
3141
2539
|
|
|
3142
|
-
:param
|
|
3143
|
-
forum supergroups only.
|
|
2540
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3144
2541
|
|
|
3145
|
-
:param caption: New caption of the message, 0-1024 characters after entities parsing.
|
|
2542
|
+
:param caption: New caption of the message, 0-1024 characters after entities parsing.
|
|
2543
|
+
:param parse_mode: Mode for parsing entities in the message caption. See formatting optionsfor more details.
|
|
3146
2544
|
|
|
3147
|
-
:param
|
|
3148
|
-
for more details.
|
|
2545
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
3149
2546
|
|
|
3150
|
-
:param
|
|
3151
|
-
which can be specified instead of parse_mode.
|
|
3152
|
-
|
|
3153
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2547
|
+
:param show_caption_above_media: Pass True, if the caption must be shown above the message media. Supportedonly for animation, photo and video messages.
|
|
3154
2548
|
|
|
3155
2549
|
:param reply_markup: A JSON-serialized object for an inline keyboard."""
|
|
3156
2550
|
|
|
@@ -3180,6 +2574,8 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3180
2574
|
message_id: int | None = None,
|
|
3181
2575
|
message_thread_id: int | None = None,
|
|
3182
2576
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2577
|
+
business_connection_id: str | None = None,
|
|
2578
|
+
inline_message_id: str | None = None,
|
|
3183
2579
|
**other: typing.Any,
|
|
3184
2580
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3185
2581
|
"""Shortcut `API.edit_message_media()`, see the [documentation](https://core.telegram.org/bots/api#editmessagemedia)
|
|
@@ -3190,30 +2586,18 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3190
2586
|
a video otherwise. When an inline message is edited, a new file can't be uploaded;
|
|
3191
2587
|
use a previously uploaded file via its file_id or specify a URL. On success,
|
|
3192
2588
|
if the edited message is not an inline message, the edited Message is returned,
|
|
3193
|
-
otherwise True is returned.
|
|
3194
|
-
|
|
3195
|
-
|
|
3196
|
-
the
|
|
2589
|
+
otherwise True is returned. Note that business messages that were not sent
|
|
2590
|
+
by the bot and do not contain an inline keyboard can only be edited within
|
|
2591
|
+
48 hours from the time they were sent.
|
|
2592
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messageto be edited was sent.
|
|
3197
2593
|
|
|
3198
|
-
:param
|
|
3199
|
-
|
|
2594
|
+
:param chat_id: Required if inline_message_id is not specified. Unique identifier forthe target chat or username of the target channel (in the format @channelusername).
|
|
2595
|
+
:param message_id: Required if inline_message_id is not specified. Identifier of the messageto edit.
|
|
3200
2596
|
|
|
3201
|
-
:param
|
|
3202
|
-
forum supergroups only.
|
|
2597
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3203
2598
|
|
|
3204
2599
|
:param media: A JSON-serialized object for a new media content of the message.
|
|
3205
2600
|
|
|
3206
|
-
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
3207
|
-
|
|
3208
|
-
:param parse_mode: Mode for parsing entities in the audio caption. See formatting options \
|
|
3209
|
-
for more details.
|
|
3210
|
-
|
|
3211
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
3212
|
-
which can be specified instead of parse_mode.
|
|
3213
|
-
|
|
3214
|
-
:param type: Required if media is not an `str | InputMedia` object. Type of the media, \
|
|
3215
|
-
must be one of `photo`, `video`, `animation`, `audio`, `document`.
|
|
3216
|
-
|
|
3217
2601
|
:param reply_markup: A JSON-serialized object for a new inline keyboard."""
|
|
3218
2602
|
|
|
3219
2603
|
params = get_params(locals())
|
|
@@ -3241,22 +2625,23 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3241
2625
|
message_id: int | None = None,
|
|
3242
2626
|
message_thread_id: int | None = None,
|
|
3243
2627
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2628
|
+
business_connection_id: str | None = None,
|
|
2629
|
+
inline_message_id: str | None = None,
|
|
3244
2630
|
**other: typing.Any,
|
|
3245
2631
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3246
2632
|
"""Shortcut `API.edit_message_reply_markup()`, see the [documentation](https://core.telegram.org/bots/api#editmessagereplymarkup)
|
|
3247
2633
|
|
|
3248
2634
|
Use this method to edit only the reply markup of messages. On success, if
|
|
3249
2635
|
the edited message is not an inline message, the edited Message is returned,
|
|
3250
|
-
otherwise True is returned.
|
|
3251
|
-
|
|
3252
|
-
|
|
3253
|
-
the
|
|
2636
|
+
otherwise True is returned. Note that business messages that were not sent
|
|
2637
|
+
by the bot and do not contain an inline keyboard can only be edited within
|
|
2638
|
+
48 hours from the time they were sent.
|
|
2639
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messageto be edited was sent.
|
|
3254
2640
|
|
|
3255
|
-
:param
|
|
3256
|
-
|
|
2641
|
+
:param chat_id: Required if inline_message_id is not specified. Unique identifier forthe target chat or username of the target channel (in the format @channelusername).
|
|
2642
|
+
:param message_id: Required if inline_message_id is not specified. Identifier of the messageto edit.
|
|
3257
2643
|
|
|
3258
|
-
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of
|
|
3259
|
-
inline message.
|
|
2644
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3260
2645
|
|
|
3261
2646
|
:param reply_markup: A JSON-serialized object for an inline keyboard."""
|
|
3262
2647
|
|