telegrinder 0.2.2__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 +24 -2
- telegrinder/bot/__init__.py +16 -0
- 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 +14 -104
- telegrinder/bot/cute_types/inline_query.py +5 -14
- telegrinder/bot/cute_types/message.py +605 -1227
- telegrinder/bot/dispatch/__init__.py +22 -1
- telegrinder/bot/dispatch/abc.py +7 -0
- telegrinder/bot/dispatch/dispatch.py +7 -0
- 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 +87 -99
- telegrinder/bot/dispatch/waiter_machine/middleware.py +23 -35
- telegrinder/bot/dispatch/waiter_machine/short_state.py +9 -9
- telegrinder/bot/scenario/checkbox.py +2 -2
- telegrinder/model.py +6 -4
- telegrinder/msgspec_json.py +1 -1
- telegrinder/msgspec_utils.py +51 -0
- telegrinder/node/event.py +2 -0
- telegrinder/tools/functional.py +9 -0
- telegrinder/tools/state_storage/memory.py +3 -3
- {telegrinder-0.2.2.dist-info → telegrinder-0.3.0.dist-info}/METADATA +2 -2
- {telegrinder-0.2.2.dist-info → telegrinder-0.3.0.dist-info}/RECORD +31 -24
- {telegrinder-0.2.2.dist-info → telegrinder-0.3.0.dist-info}/LICENSE +0 -0
- {telegrinder-0.2.2.dist-info → telegrinder-0.3.0.dist-info}/WHEEL +0 -0
|
@@ -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
|
|
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.
|
|
216
221
|
|
|
217
|
-
:param
|
|
218
|
-
will be sent.
|
|
222
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
219
223
|
|
|
220
|
-
:param
|
|
221
|
-
(in the format @channelusername).
|
|
224
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
222
225
|
|
|
223
|
-
:param
|
|
224
|
-
|
|
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.
|
|
225
228
|
|
|
226
|
-
:param
|
|
227
|
-
|
|
228
|
-
:param parse_mode: Mode for parsing entities in the message text. See formatting options for \
|
|
229
|
-
more details.
|
|
230
|
-
|
|
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).
|
|
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.
|
|
282
274
|
|
|
283
|
-
:param
|
|
284
|
-
forum supergroups only.
|
|
275
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
285
276
|
|
|
286
|
-
:param
|
|
277
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
287
278
|
|
|
288
|
-
:param
|
|
289
|
-
|
|
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.
|
|
290
281
|
|
|
291
|
-
:param entities: A JSON-serialized list of special entities that appear in message text,
|
|
292
|
-
which can be specified instead of parse_mode.
|
|
293
|
-
|
|
294
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
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.
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
the
|
|
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.
|
|
374
354
|
|
|
375
|
-
:param
|
|
376
|
-
|
|
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.
|
|
377
357
|
|
|
378
|
-
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of
|
|
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.
|
|
731
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
842
732
|
|
|
843
|
-
:param
|
|
844
|
-
chats only.
|
|
733
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
845
734
|
|
|
846
|
-
:param
|
|
847
|
-
|
|
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.
|
|
848
738
|
|
|
849
|
-
:param
|
|
850
|
-
forum supergroups only.
|
|
739
|
+
:param parse_mode: Mode for parsing entities in the document caption. See formatting optionsfor more details.
|
|
851
740
|
|
|
852
|
-
:param
|
|
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. \
|
|
741
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
856
742
|
|
|
857
|
-
:param
|
|
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. \
|
|
864
|
-
|
|
865
|
-
:param caption: Document caption (may also be used when resending documents by file_id), \
|
|
866
|
-
0-1024 characters after entities parsing.
|
|
867
|
-
|
|
868
|
-
:param parse_mode: Mode for parsing entities in the document caption. See formatting options \
|
|
869
|
-
for more details.
|
|
870
|
-
|
|
871
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
872
|
-
which can be specified instead of parse_mode.
|
|
873
|
-
|
|
874
|
-
:param disable_content_type_detection: Disables automatic server-side content type detection for files uploaded \
|
|
875
|
-
using multipart/form-data.
|
|
876
|
-
|
|
877
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
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).
|
|
902
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1050
903
|
|
|
1051
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
1052
|
-
forum supergroups only.
|
|
1053
|
-
|
|
1054
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
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.
|
|
1132
|
-
|
|
1133
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1134
|
-
(in the format @channelusername).
|
|
1135
|
-
|
|
1136
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1137
|
-
forum supergroups only.
|
|
969
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1138
970
|
|
|
1139
|
-
:param
|
|
1140
|
-
chats only.
|
|
971
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1141
972
|
|
|
1142
|
-
:param video_note: Video note to send. Pass a file_id as String to send a video note that
|
|
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.
|
|
1278
|
-
|
|
1279
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1280
|
-
(in the format @channelusername).
|
|
1281
|
-
|
|
1282
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1283
|
-
forum supergroups only.
|
|
1092
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1284
1093
|
|
|
1285
|
-
:param
|
|
1286
|
-
chats only.
|
|
1094
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1287
1095
|
|
|
1288
|
-
:param
|
|
1289
|
-
details. Currently, only custom emoji entities are allowed.
|
|
1096
|
+
:param question: Poll question, 1-300 characters.
|
|
1290
1097
|
|
|
1291
|
-
:param
|
|
1292
|
-
It can be specified instead of question_parse_mode.
|
|
1098
|
+
:param question_parse_mode: Mode for parsing entities in the question. See formatting options for moredetails. Currently, only custom emoji entities are allowed.
|
|
1293
1099
|
|
|
1294
|
-
:param
|
|
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.
|
|
1108
|
+
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,defaults to False.
|
|
1304
1109
|
|
|
1305
|
-
:param correct_option_id: 0-based identifier of the correct answer option, required for polls
|
|
1306
|
-
quiz mode.
|
|
1110
|
+
:param correct_option_id: 0-based identifier of the correct answer option, required for polls inquiz mode.
|
|
1307
1111
|
|
|
1308
|
-
:param explanation: Text that is shown when a user chooses an incorrect answer or taps on the
|
|
1309
|
-
icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after \
|
|
1310
|
-
entities parsing.
|
|
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.
|
|
1311
1113
|
|
|
1312
|
-
:param explanation_parse_mode: Mode for parsing entities in the explanation. See formatting options
|
|
1313
|
-
more details.
|
|
1114
|
+
:param explanation_parse_mode: Mode for parsing entities in the explanation. See formatting options formore details.
|
|
1314
1115
|
|
|
1315
|
-
:param explanation_entities: A JSON-serialized list of special entities that appear in the poll explanation
|
|
1316
|
-
which can be specified instead of parse_mode.
|
|
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.
|
|
1317
1117
|
|
|
1318
|
-
:param open_period: Amount of time in seconds the poll will be active after creation, 5-600.
|
|
1319
|
-
Can't be used together with close_date.
|
|
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.
|
|
1320
1119
|
|
|
1321
|
-
:param close_date: Point in time (Unix timestamp) when the poll will be automatically closed.
|
|
1322
|
-
Must be at least 5 and no more than 600 seconds in the future. Can't be used \
|
|
1323
|
-
together with open_period.
|
|
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.
|
|
1324
1121
|
|
|
1325
|
-
:param is_closed: Pass True if the poll needs to be immediately closed. This can be useful
|
|
1326
|
-
poll preview.
|
|
1327
|
-
|
|
1328
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
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.
|
|
1374
|
-
|
|
1375
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
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.
|
|
1170
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1380
1171
|
|
|
1381
|
-
:param
|
|
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.
|
|
1229
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1447
1230
|
|
|
1448
|
-
:param
|
|
1449
|
-
of `🎲`, `🎯`, `🏀`, `⚽`, `🎳`, or `🎰`. Dice can have values 1-6 for `🎲`, `🎯` and \
|
|
1450
|
-
`🎳`, values 1-5 for `🏀` and `⚽`, and values 1-64 for `🎰`. Defaults to `🎲`. \
|
|
1451
|
-
|
|
1452
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
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.
|
|
1493
|
-
|
|
1494
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1495
|
-
chats only.
|
|
1270
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1496
1271
|
|
|
1497
|
-
:param game_short_name: Short name of the game, serves as the unique identifier for the game.
|
|
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.
|
|
1351
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1658
1352
|
|
|
1659
|
-
:param
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
:param message_thread_id: Unique identifier for the target message thread; supergroups only.
|
|
1663
|
-
|
|
1664
|
-
:param action: Type of action to broadcast. Choose one, depending on what the user is about \
|
|
1665
|
-
to receive: typing for text messages, upload_photo for photos, record_video \
|
|
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
|
|
|
@@ -1677,7 +1362,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1677
1362
|
async def answer_media_group(
|
|
1678
1363
|
self,
|
|
1679
1364
|
media: InputMediaType | list[InputMediaType],
|
|
1680
|
-
chat_id: int | str
|
|
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,
|
|
@@ -1694,33 +1379,17 @@ 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.
|
|
1700
|
-
|
|
1701
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1702
|
-
(in the format @channelusername).
|
|
1384
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1703
1385
|
|
|
1704
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
1705
|
-
forum supergroups only.
|
|
1386
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1706
1387
|
|
|
1707
|
-
:param
|
|
1708
|
-
chats only.
|
|
1388
|
+
:param media: A JSON-serialized array describing messages to be sent, must include 2-10items.
|
|
1709
1389
|
|
|
1710
|
-
:param
|
|
1711
|
-
|
|
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
|
|
|
@@ -1767,49 +1436,40 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1767
1436
|
disable_notification: bool | None = None,
|
|
1768
1437
|
protect_content: bool | None = None,
|
|
1769
1438
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1770
|
-
reply_markup:
|
|
1439
|
+
reply_markup: InlineKeyboardMarkup
|
|
1440
|
+
| ReplyKeyboardMarkup
|
|
1441
|
+
| ReplyKeyboardRemove
|
|
1442
|
+
| ForceReply
|
|
1443
|
+
| None = None,
|
|
1771
1444
|
**other: typing.Any,
|
|
1772
1445
|
) -> Result[MessageCute, APIError]:
|
|
1773
1446
|
"""Shortcut `API.send_location()`, see the [documentation](https://core.telegram.org/bots/api#sendlocation)
|
|
1774
1447
|
|
|
1775
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.
|
|
1776
1450
|
|
|
1777
|
-
:param
|
|
1778
|
-
will be sent.
|
|
1779
|
-
|
|
1780
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1781
|
-
(in the format @channelusername).
|
|
1782
|
-
|
|
1783
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1784
|
-
forum supergroups only.
|
|
1451
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1785
1452
|
|
|
1786
|
-
:param
|
|
1787
|
-
chats only.
|
|
1453
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1788
1454
|
|
|
1789
1455
|
:param latitude: Latitude of the location.
|
|
1790
1456
|
|
|
1791
1457
|
:param longitude: Longitude of the location.
|
|
1792
1458
|
|
|
1793
|
-
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
1794
|
-
|
|
1795
|
-
:param live_period: Period in seconds for which the location will be updated (see Live Locations, \
|
|
1796
|
-
should be between 60 and 86400.
|
|
1797
|
-
|
|
1798
|
-
:param heading: For live locations, a direction in which the user is moving, in degrees. \
|
|
1799
|
-
Must be between 1 and 360 if specified.
|
|
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.
|
|
1800
1461
|
|
|
1801
|
-
:param
|
|
1802
|
-
another chat member, in meters. Must be between 1 and 100000 if specified. \
|
|
1803
|
-
|
|
1804
|
-
: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.
|
|
1805
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.
|
|
1806
1466
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1807
1467
|
|
|
1468
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1469
|
+
|
|
1808
1470
|
:param reply_parameters: Description of the message to reply to.
|
|
1809
1471
|
|
|
1810
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1811
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1812
|
-
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."""
|
|
1813
1473
|
|
|
1814
1474
|
...
|
|
1815
1475
|
|
|
@@ -1831,24 +1491,21 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1831
1491
|
disable_notification: bool | None = None,
|
|
1832
1492
|
protect_content: bool | None = None,
|
|
1833
1493
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1834
|
-
reply_markup:
|
|
1494
|
+
reply_markup: InlineKeyboardMarkup
|
|
1495
|
+
| ReplyKeyboardMarkup
|
|
1496
|
+
| ReplyKeyboardRemove
|
|
1497
|
+
| ForceReply
|
|
1498
|
+
| None = None,
|
|
1835
1499
|
**other: typing.Any,
|
|
1836
1500
|
) -> Result[MessageCute, APIError]:
|
|
1837
1501
|
"""Shortcut `API.send_contact()`, see the [documentation](https://core.telegram.org/bots/api#sendcontact)
|
|
1838
1502
|
|
|
1839
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.
|
|
1840
1505
|
|
|
1841
|
-
:param
|
|
1842
|
-
will be sent.
|
|
1843
|
-
|
|
1844
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1845
|
-
(in the format @channelusername).
|
|
1506
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1846
1507
|
|
|
1847
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
1848
|
-
forum supergroups only.
|
|
1849
|
-
|
|
1850
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
1851
|
-
chats only.
|
|
1508
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
1852
1509
|
|
|
1853
1510
|
:param phone_number: Contact's phone number.
|
|
1854
1511
|
|
|
@@ -1858,15 +1515,14 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1858
1515
|
|
|
1859
1516
|
:param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes.
|
|
1860
1517
|
|
|
1861
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1862
|
-
|
|
1518
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
1863
1519
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1864
1520
|
|
|
1521
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1522
|
+
|
|
1865
1523
|
:param reply_parameters: Description of the message to reply to.
|
|
1866
1524
|
|
|
1867
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1868
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1869
|
-
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."""
|
|
1870
1526
|
|
|
1871
1527
|
...
|
|
1872
1528
|
|
|
@@ -1892,41 +1548,32 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1892
1548
|
disable_notification: bool | None = None,
|
|
1893
1549
|
protect_content: bool | None = None,
|
|
1894
1550
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1895
|
-
reply_markup:
|
|
1551
|
+
reply_markup: InlineKeyboardMarkup
|
|
1552
|
+
| ReplyKeyboardMarkup
|
|
1553
|
+
| ReplyKeyboardRemove
|
|
1554
|
+
| ForceReply
|
|
1555
|
+
| None = None,
|
|
1896
1556
|
**other: typing.Any,
|
|
1897
1557
|
) -> Result[MessageCute, APIError]:
|
|
1898
1558
|
"""Shortcut `API.send_audio()`, see the [documentation](https://core.telegram.org/bots/api#sendaudio)
|
|
1899
1559
|
|
|
1900
|
-
Use this method to send
|
|
1560
|
+
Use this method to send audio files, if you want Telegram clients to display
|
|
1901
1561
|
them in the music player. Your audio must be in the .MP3 or .M4A format. On
|
|
1902
1562
|
success, the sent Message is returned. Bots can currently send audio files
|
|
1903
1563
|
of up to 50 MB in size, this limit may be changed in the future. For sending
|
|
1904
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.
|
|
1905
1566
|
|
|
1906
|
-
:param
|
|
1907
|
-
will be sent.
|
|
1908
|
-
|
|
1909
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1910
|
-
(in the format @channelusername).
|
|
1911
|
-
|
|
1912
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1913
|
-
forum supergroups only.
|
|
1567
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
1914
1568
|
|
|
1915
|
-
:param
|
|
1916
|
-
chats only.
|
|
1917
|
-
|
|
1918
|
-
:param audio: Audio file to send. Pass a file_id as String to send an audio file that exists \
|
|
1919
|
-
on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
1920
|
-
to get an audio file from the Internet, or upload a new one using multipart/form-data. \
|
|
1921
|
-
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.
|
|
1922
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.
|
|
1923
1572
|
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
1924
1573
|
|
|
1925
|
-
:param parse_mode: Mode for parsing entities in the audio caption. See formatting
|
|
1926
|
-
for more details.
|
|
1574
|
+
:param parse_mode: Mode for parsing entities in the audio caption. See formatting optionsfor more details.
|
|
1927
1575
|
|
|
1928
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
1929
|
-
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.
|
|
1930
1577
|
|
|
1931
1578
|
:param duration: Duration of the audio in seconds.
|
|
1932
1579
|
|
|
@@ -1934,23 +1581,15 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1934
1581
|
|
|
1935
1582
|
:param title: Track name.
|
|
1936
1583
|
|
|
1937
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
1938
|
-
|
|
1939
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
1940
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
1941
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
1942
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
1943
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1944
|
-
|
|
1945
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1946
|
-
|
|
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.
|
|
1947
1586
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
1948
1587
|
|
|
1588
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1589
|
+
|
|
1949
1590
|
:param reply_parameters: Description of the message to reply to.
|
|
1950
1591
|
|
|
1951
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
1952
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
1953
|
-
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."""
|
|
1954
1593
|
|
|
1955
1594
|
...
|
|
1956
1595
|
|
|
@@ -1978,68 +1617,49 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
1978
1617
|
disable_notification: bool | None = None,
|
|
1979
1618
|
protect_content: bool | None = None,
|
|
1980
1619
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
1981
|
-
reply_markup:
|
|
1620
|
+
reply_markup: InlineKeyboardMarkup
|
|
1621
|
+
| ReplyKeyboardMarkup
|
|
1622
|
+
| ReplyKeyboardRemove
|
|
1623
|
+
| ForceReply
|
|
1624
|
+
| None = None,
|
|
1982
1625
|
**other: typing.Any,
|
|
1983
1626
|
) -> Result[MessageCute, APIError]:
|
|
1984
1627
|
"""Shortcut `API.send_animation()`, see the [documentation](https://core.telegram.org/bots/api#sendanimation)
|
|
1985
1628
|
|
|
1986
|
-
Use this method to send
|
|
1629
|
+
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without
|
|
1987
1630
|
sound). On success, the sent Message is returned. Bots can currently send
|
|
1988
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.
|
|
1989
1633
|
|
|
1990
|
-
:param
|
|
1991
|
-
will be sent.
|
|
1992
|
-
|
|
1993
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
1994
|
-
(in the format @channelusername).
|
|
1995
|
-
|
|
1996
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
1997
|
-
forum supergroups only.
|
|
1998
|
-
|
|
1999
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2000
|
-
chats only.
|
|
1634
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2001
1635
|
|
|
2002
|
-
:param
|
|
2003
|
-
on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
2004
|
-
to get an animation from the Internet, or upload a new animation using multipart/form-data. \
|
|
2005
|
-
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.
|
|
2006
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.
|
|
2007
1639
|
:param duration: Duration of sent animation in seconds.
|
|
2008
1640
|
|
|
2009
1641
|
:param width: Animation width.
|
|
2010
1642
|
|
|
2011
1643
|
:param height: Animation height.
|
|
2012
1644
|
|
|
2013
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
2014
|
-
|
|
2015
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2016
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2017
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2018
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2019
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
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.
|
|
2020
1647
|
|
|
2021
|
-
:param
|
|
2022
|
-
0-1024 characters after entities parsing.
|
|
1648
|
+
:param parse_mode: Mode for parsing entities in the animation caption. See formatting optionsfor more details.
|
|
2023
1649
|
|
|
2024
|
-
:param
|
|
2025
|
-
for more details.
|
|
2026
|
-
|
|
2027
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
2028
|
-
which can be specified instead of parse_mode.
|
|
2029
|
-
|
|
2030
|
-
:param has_spoiler: Pass True if the animation needs to be covered with a spoiler animation. \
|
|
2031
|
-
|
|
2032
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
1650
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2033
1651
|
|
|
2034
1652
|
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2035
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.
|
|
2036
1656
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2037
1657
|
|
|
1658
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1659
|
+
|
|
2038
1660
|
:param reply_parameters: Description of the message to reply to.
|
|
2039
1661
|
|
|
2040
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2041
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2042
|
-
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."""
|
|
2043
1663
|
|
|
2044
1664
|
...
|
|
2045
1665
|
|
|
@@ -2064,63 +1684,42 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2064
1684
|
disable_notification: bool | None = None,
|
|
2065
1685
|
protect_content: bool | None = None,
|
|
2066
1686
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2067
|
-
reply_markup:
|
|
1687
|
+
reply_markup: InlineKeyboardMarkup
|
|
1688
|
+
| ReplyKeyboardMarkup
|
|
1689
|
+
| ReplyKeyboardRemove
|
|
1690
|
+
| ForceReply
|
|
1691
|
+
| None = None,
|
|
2068
1692
|
**other: typing.Any,
|
|
2069
1693
|
) -> Result[MessageCute, APIError]:
|
|
2070
1694
|
"""Shortcut `API.send_document()`, see the [documentation](https://core.telegram.org/bots/api#senddocument)
|
|
2071
1695
|
|
|
2072
|
-
Use this method to send
|
|
1696
|
+
Use this method to send general files. On success, the sent Message is returned.
|
|
2073
1697
|
Bots can currently send files of any type of up to 50 MB in size, this limit
|
|
2074
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.
|
|
2075
1700
|
|
|
2076
|
-
:param
|
|
2077
|
-
will be sent.
|
|
1701
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2078
1702
|
|
|
2079
|
-
:param
|
|
2080
|
-
(in the format @channelusername).
|
|
1703
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2081
1704
|
|
|
2082
|
-
:param
|
|
2083
|
-
|
|
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.
|
|
2084
1708
|
|
|
2085
|
-
:param
|
|
2086
|
-
chats only.
|
|
1709
|
+
:param parse_mode: Mode for parsing entities in the document caption. See formatting optionsfor more details.
|
|
2087
1710
|
|
|
2088
|
-
:param
|
|
2089
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
2090
|
-
file from the Internet, or upload a new one using multipart/form-data. \
|
|
2091
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
1711
|
+
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,which can be specified instead of parse_mode.
|
|
2092
1712
|
|
|
2093
|
-
:param
|
|
2094
|
-
file is supported server-side. The thumbnail should be in JPEG format and \
|
|
2095
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2096
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2097
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2098
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2099
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2100
|
-
|
|
2101
|
-
:param caption: Document caption (may also be used when resending documents by file_id), \
|
|
2102
|
-
0-1024 characters after entities parsing.
|
|
2103
|
-
|
|
2104
|
-
:param parse_mode: Mode for parsing entities in the document caption. See formatting options \
|
|
2105
|
-
for more details.
|
|
2106
|
-
|
|
2107
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
2108
|
-
which can be specified instead of parse_mode.
|
|
2109
|
-
|
|
2110
|
-
:param disable_content_type_detection: Disables automatic server-side content type detection for files uploaded \
|
|
2111
|
-
using multipart/form-data.
|
|
2112
|
-
|
|
2113
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2114
|
-
|
|
2115
|
-
: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.
|
|
2116
1714
|
|
|
1715
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2117
1716
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2118
1717
|
|
|
1718
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1719
|
+
|
|
2119
1720
|
:param reply_parameters: Description of the message to reply to.
|
|
2120
1721
|
|
|
2121
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2122
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2123
|
-
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."""
|
|
2124
1723
|
|
|
2125
1724
|
...
|
|
2126
1725
|
|
|
@@ -2144,54 +1743,41 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2144
1743
|
disable_notification: bool | None = None,
|
|
2145
1744
|
protect_content: bool | None = None,
|
|
2146
1745
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2147
|
-
reply_markup:
|
|
1746
|
+
reply_markup: InlineKeyboardMarkup
|
|
1747
|
+
| ReplyKeyboardMarkup
|
|
1748
|
+
| ReplyKeyboardRemove
|
|
1749
|
+
| ForceReply
|
|
1750
|
+
| None = None,
|
|
2148
1751
|
**other: typing.Any,
|
|
2149
1752
|
) -> Result[MessageCute, APIError]:
|
|
2150
1753
|
"""Shortcut `API.send_photo()`, see the [documentation](https://core.telegram.org/bots/api#sendphoto)
|
|
2151
1754
|
|
|
2152
|
-
Use this method to send
|
|
2153
|
-
|
|
2154
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2155
|
-
will be sent.
|
|
2156
|
-
|
|
2157
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2158
|
-
(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.
|
|
2159
1757
|
|
|
2160
|
-
:param
|
|
2161
|
-
forum supergroups only.
|
|
1758
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2162
1759
|
|
|
2163
|
-
:param
|
|
2164
|
-
chats only.
|
|
1760
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2165
1761
|
|
|
2166
|
-
:param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram
|
|
2167
|
-
|
|
2168
|
-
photo from the Internet, or upload a new photo using multipart/form-data. \
|
|
2169
|
-
The photo must be at most 10 MB in size. The photo's width and height must not \
|
|
2170
|
-
exceed 10000 in total. Width and height ratio must be at most 20. More information \
|
|
2171
|
-
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.
|
|
2172
1764
|
|
|
2173
|
-
:param
|
|
2174
|
-
characters after entities parsing.
|
|
1765
|
+
:param parse_mode: Mode for parsing entities in the photo caption. See formatting optionsfor more details.
|
|
2175
1766
|
|
|
2176
|
-
:param
|
|
2177
|
-
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.
|
|
2178
1768
|
|
|
2179
|
-
:param
|
|
2180
|
-
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.
|
|
2181
1770
|
|
|
2182
1771
|
:param has_spoiler: Pass True if the photo needs to be covered with a spoiler animation.
|
|
2183
1772
|
|
|
2184
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2185
|
-
|
|
2186
|
-
:param show_caption_above_media: Pass True, if the caption must be shown above the message media.
|
|
2187
|
-
|
|
1773
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2188
1774
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2189
1775
|
|
|
1776
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1777
|
+
|
|
2190
1778
|
:param reply_parameters: Description of the message to reply to.
|
|
2191
1779
|
|
|
2192
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2193
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2194
|
-
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."""
|
|
2195
1781
|
|
|
2196
1782
|
...
|
|
2197
1783
|
|
|
@@ -2211,44 +1797,35 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2211
1797
|
disable_notification: bool | None = None,
|
|
2212
1798
|
protect_content: bool | None = None,
|
|
2213
1799
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2214
|
-
reply_markup:
|
|
1800
|
+
reply_markup: InlineKeyboardMarkup
|
|
1801
|
+
| ReplyKeyboardMarkup
|
|
1802
|
+
| ReplyKeyboardRemove
|
|
1803
|
+
| ForceReply
|
|
1804
|
+
| None = None,
|
|
2215
1805
|
**other: typing.Any,
|
|
2216
1806
|
) -> Result[MessageCute, APIError]:
|
|
2217
1807
|
"""Shortcut `API.send_sticker()`, see the [documentation](https://core.telegram.org/bots/api#sendsticker)
|
|
2218
1808
|
|
|
2219
|
-
Use this method to send
|
|
1809
|
+
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers.
|
|
2220
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.
|
|
2221
1812
|
|
|
2222
|
-
:param
|
|
2223
|
-
will be sent.
|
|
2224
|
-
|
|
2225
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2226
|
-
(in the format @channelusername).
|
|
2227
|
-
|
|
2228
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2229
|
-
forum supergroups only.
|
|
1813
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2230
1814
|
|
|
2231
|
-
:param
|
|
2232
|
-
chats only.
|
|
1815
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2233
1816
|
|
|
2234
|
-
:param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the
|
|
2235
|
-
Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
2236
|
-
to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker \
|
|
2237
|
-
using multipart/form-data. More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2238
|
-
Video stickers can only be sent by a file_id. Animated stickers can't be \
|
|
2239
|
-
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.
|
|
2240
1818
|
|
|
2241
1819
|
:param emoji: Emoji associated with the sticker; only for just uploaded stickers.
|
|
2242
1820
|
|
|
2243
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2244
|
-
|
|
1821
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2245
1822
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2246
1823
|
|
|
1824
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1825
|
+
|
|
2247
1826
|
:param reply_parameters: Description of the message to reply to.
|
|
2248
1827
|
|
|
2249
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2250
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2251
|
-
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."""
|
|
2252
1829
|
|
|
2253
1830
|
...
|
|
2254
1831
|
|
|
@@ -2260,6 +1837,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2260
1837
|
async def reply_video(
|
|
2261
1838
|
self,
|
|
2262
1839
|
sticker: InputFile | str,
|
|
1840
|
+
video: InputFile | str,
|
|
2263
1841
|
chat_id: int | str | None = None,
|
|
2264
1842
|
emoji: str | None = None,
|
|
2265
1843
|
message_thread_id: int | None = None,
|
|
@@ -2268,69 +1846,62 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2268
1846
|
disable_notification: bool | None = None,
|
|
2269
1847
|
protect_content: bool | None = None,
|
|
2270
1848
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2271
|
-
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,
|
|
2272
1863
|
**other: typing.Any,
|
|
2273
1864
|
) -> Result[MessageCute, APIError]:
|
|
2274
1865
|
"""Shortcut `API.send_video()`, see the [documentation](https://core.telegram.org/bots/api#sendvideo)
|
|
2275
1866
|
|
|
2276
|
-
Use this method to send
|
|
1867
|
+
Use this method to send video files, Telegram clients support MPEG4 videos
|
|
2277
1868
|
(other formats may be sent as Document). On success, the sent Message is
|
|
2278
1869
|
returned. Bots can currently send video files of up to 50 MB in size, this
|
|
2279
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.
|
|
2280
1872
|
|
|
2281
|
-
:param
|
|
2282
|
-
will be sent.
|
|
2283
|
-
|
|
2284
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2285
|
-
(in the format @channelusername).
|
|
1873
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2286
1874
|
|
|
2287
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
2288
|
-
forum supergroups only.
|
|
2289
|
-
|
|
2290
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2291
|
-
chats only.
|
|
2292
|
-
|
|
2293
|
-
:param video: Video to send. Pass a file_id as String to send a video that exists on the Telegram \
|
|
2294
|
-
servers (recommended), pass an HTTP URL as a String for Telegram to get a \
|
|
2295
|
-
video from the Internet, or upload a new video using multipart/form-data. \
|
|
2296
|
-
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.
|
|
2297
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.
|
|
2298
1878
|
:param duration: Duration of sent video in seconds.
|
|
2299
1879
|
|
|
2300
1880
|
:param width: Video width.
|
|
2301
1881
|
|
|
2302
1882
|
:param height: Video height.
|
|
2303
1883
|
|
|
2304
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
2305
|
-
|
|
2306
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2307
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2308
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2309
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2310
|
-
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.
|
|
2311
1886
|
|
|
2312
|
-
:param
|
|
2313
|
-
characters after entities parsing.
|
|
1887
|
+
:param parse_mode: Mode for parsing entities in the video caption. See formatting optionsfor more details.
|
|
2314
1888
|
|
|
2315
|
-
:param
|
|
2316
|
-
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.
|
|
2317
1890
|
|
|
2318
|
-
:param
|
|
2319
|
-
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.
|
|
2320
1892
|
|
|
2321
1893
|
:param has_spoiler: Pass True if the video needs to be covered with a spoiler animation.
|
|
2322
1894
|
|
|
2323
1895
|
:param supports_streaming: Pass True if the uploaded video is suitable for streaming.
|
|
2324
1896
|
|
|
2325
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2326
|
-
|
|
1897
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2327
1898
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2328
1899
|
|
|
1900
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1901
|
+
|
|
2329
1902
|
:param reply_parameters: Description of the message to reply to.
|
|
2330
1903
|
|
|
2331
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2332
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2333
|
-
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."""
|
|
2334
1905
|
|
|
2335
1906
|
...
|
|
2336
1907
|
|
|
@@ -2352,53 +1923,39 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2352
1923
|
disable_notification: bool | None = None,
|
|
2353
1924
|
protect_content: bool | None = None,
|
|
2354
1925
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2355
|
-
reply_markup:
|
|
1926
|
+
reply_markup: InlineKeyboardMarkup
|
|
1927
|
+
| ReplyKeyboardMarkup
|
|
1928
|
+
| ReplyKeyboardRemove
|
|
1929
|
+
| ForceReply
|
|
1930
|
+
| None = None,
|
|
2356
1931
|
**other: typing.Any,
|
|
2357
1932
|
) -> Result[MessageCute, APIError]:
|
|
2358
1933
|
"""Shortcut `API.send_video_note()`, see the [documentation](https://core.telegram.org/bots/api#sendvideonote)
|
|
2359
1934
|
|
|
2360
1935
|
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up
|
|
2361
|
-
to 1 minute long. Use this method to send
|
|
1936
|
+
to 1 minute long. Use this method to send video messages. On success, the
|
|
2362
1937
|
sent Message is returned.
|
|
1938
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2363
1939
|
|
|
2364
|
-
:param
|
|
2365
|
-
will be sent.
|
|
1940
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2366
1941
|
|
|
2367
|
-
:param
|
|
2368
|
-
(in the format @channelusername).
|
|
1942
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2369
1943
|
|
|
2370
|
-
:param
|
|
2371
|
-
forum supergroups only.
|
|
2372
|
-
|
|
2373
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2374
|
-
chats only.
|
|
2375
|
-
|
|
2376
|
-
:param video_note: Video note to send. Pass a file_id as String to send a video note that exists \
|
|
2377
|
-
on the Telegram servers (recommended) or upload a new video using multipart/form-data. \
|
|
2378
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2379
|
-
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.
|
|
2380
1945
|
|
|
2381
1946
|
:param duration: Duration of sent video in seconds.
|
|
2382
1947
|
|
|
2383
1948
|
:param length: Video width and height, i.e. diameter of the video message.
|
|
2384
1949
|
|
|
2385
|
-
:param thumbnail: Thumbnail of the file sent; can be ignored if thumbnail generation for the
|
|
2386
|
-
|
|
2387
|
-
less than 200 kB in size. A thumbnail's width and height should not exceed \
|
|
2388
|
-
320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails \
|
|
2389
|
-
can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` \
|
|
2390
|
-
if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. \
|
|
2391
|
-
More information on Sending Files: https://core.telegram.org/bots/api#sending-files. \
|
|
2392
|
-
|
|
2393
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2394
|
-
|
|
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.
|
|
2395
1952
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2396
1953
|
|
|
1954
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
1955
|
+
|
|
2397
1956
|
:param reply_parameters: Description of the message to reply to.
|
|
2398
1957
|
|
|
2399
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2400
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2401
|
-
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."""
|
|
2402
1959
|
|
|
2403
1960
|
...
|
|
2404
1961
|
|
|
@@ -2421,53 +1978,44 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2421
1978
|
disable_notification: bool | None = None,
|
|
2422
1979
|
protect_content: bool | None = None,
|
|
2423
1980
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2424
|
-
reply_markup:
|
|
1981
|
+
reply_markup: InlineKeyboardMarkup
|
|
1982
|
+
| ReplyKeyboardMarkup
|
|
1983
|
+
| ReplyKeyboardRemove
|
|
1984
|
+
| ForceReply
|
|
1985
|
+
| None = None,
|
|
2425
1986
|
**other: typing.Any,
|
|
2426
1987
|
) -> Result[MessageCute, APIError]:
|
|
2427
1988
|
"""Shortcut `API.send_voice()`, see the [documentation](https://core.telegram.org/bots/api#sendvoice)
|
|
2428
1989
|
|
|
2429
|
-
Use this method to send
|
|
1990
|
+
Use this method to send audio files, if you want Telegram clients to display
|
|
2430
1991
|
the file as a playable voice message. For this to work, your audio must be
|
|
2431
|
-
in an .OGG file encoded with OPUS
|
|
2432
|
-
|
|
2433
|
-
messages of up to 50 MB in size, this
|
|
2434
|
-
|
|
2435
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the
|
|
2436
|
-
will be sent.
|
|
2437
|
-
|
|
2438
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2439
|
-
(in the format @channelusername).
|
|
2440
|
-
|
|
2441
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2442
|
-
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.
|
|
2443
1997
|
|
|
2444
|
-
:param
|
|
2445
|
-
chats only.
|
|
1998
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2446
1999
|
|
|
2447
|
-
:param
|
|
2448
|
-
Telegram servers (recommended), pass an HTTP URL as a String for Telegram \
|
|
2449
|
-
to get a file from the Internet, or upload a new one using multipart/form-data. \
|
|
2450
|
-
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.
|
|
2451
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.
|
|
2452
2003
|
:param caption: Voice message caption, 0-1024 characters after entities parsing.
|
|
2453
2004
|
|
|
2454
|
-
:param parse_mode: Mode for parsing entities in the voice message caption. See
|
|
2455
|
-
options for more details.
|
|
2005
|
+
:param parse_mode: Mode for parsing entities in the voice message caption. See formattingoptions for more details.
|
|
2456
2006
|
|
|
2457
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption,
|
|
2458
|
-
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.
|
|
2459
2008
|
|
|
2460
2009
|
:param duration: Duration of the voice message in seconds.
|
|
2461
2010
|
|
|
2462
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2463
|
-
|
|
2011
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2464
2012
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2465
2013
|
|
|
2014
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2015
|
+
|
|
2466
2016
|
:param reply_parameters: Description of the message to reply to.
|
|
2467
2017
|
|
|
2468
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2469
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2470
|
-
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."""
|
|
2471
2019
|
|
|
2472
2020
|
...
|
|
2473
2021
|
|
|
@@ -2500,32 +2048,27 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2500
2048
|
disable_notification: bool | None = None,
|
|
2501
2049
|
protect_content: bool | None = None,
|
|
2502
2050
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2503
|
-
reply_markup:
|
|
2051
|
+
reply_markup: InlineKeyboardMarkup
|
|
2052
|
+
| ReplyKeyboardMarkup
|
|
2053
|
+
| ReplyKeyboardRemove
|
|
2054
|
+
| ForceReply
|
|
2055
|
+
| None = None,
|
|
2504
2056
|
**other: typing.Any,
|
|
2505
2057
|
) -> Result[MessageCute, APIError]:
|
|
2506
2058
|
"""Shortcut `API.send_poll()`, see the [documentation](https://core.telegram.org/bots/api#sendpoll)
|
|
2507
2059
|
|
|
2508
|
-
Use this method to send a
|
|
2509
|
-
|
|
2510
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2511
|
-
will be sent.
|
|
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.
|
|
2512
2062
|
|
|
2513
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel
|
|
2514
|
-
(in the format @channelusername).
|
|
2063
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2515
2064
|
|
|
2516
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
2517
|
-
forum supergroups only.
|
|
2065
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2518
2066
|
|
|
2519
|
-
:param
|
|
2520
|
-
chats only.
|
|
2067
|
+
:param question: Poll question, 1-300 characters.
|
|
2521
2068
|
|
|
2522
|
-
:param question_parse_mode: Mode for parsing entities in the question. See formatting options for
|
|
2523
|
-
details. Currently, only custom emoji entities are allowed.
|
|
2069
|
+
:param question_parse_mode: Mode for parsing entities in the question. See formatting options for moredetails. Currently, only custom emoji entities are allowed.
|
|
2524
2070
|
|
|
2525
|
-
:param question_entities: A JSON-serialized list of special entities that appear in the poll question.
|
|
2526
|
-
It can be specified instead of question_parse_mode.
|
|
2527
|
-
|
|
2528
|
-
:param question: Poll question, 1-300 characters.
|
|
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.
|
|
2529
2072
|
|
|
2530
2073
|
:param options: A JSON-serialized list of 2-10 answer options.
|
|
2531
2074
|
|
|
@@ -2533,43 +2076,30 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2533
2076
|
|
|
2534
2077
|
:param type: Poll type, `quiz` or `regular`, defaults to `regular`.
|
|
2535
2078
|
|
|
2536
|
-
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,
|
|
2537
|
-
defaults to False.
|
|
2538
|
-
|
|
2539
|
-
:param correct_option_id: 0-based identifier of the correct answer option, required for polls in \
|
|
2540
|
-
quiz mode.
|
|
2079
|
+
:param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode,defaults to False.
|
|
2541
2080
|
|
|
2542
|
-
:param
|
|
2543
|
-
icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after \
|
|
2544
|
-
entities parsing.
|
|
2081
|
+
:param correct_option_id: 0-based identifier of the correct answer option, required for polls inquiz mode.
|
|
2545
2082
|
|
|
2546
|
-
:param
|
|
2547
|
-
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.
|
|
2548
2084
|
|
|
2549
|
-
:param
|
|
2550
|
-
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.
|
|
2551
2086
|
|
|
2552
|
-
:param
|
|
2553
|
-
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.
|
|
2554
2088
|
|
|
2555
|
-
:param
|
|
2556
|
-
Must be at least 5 and no more than 600 seconds in the future. Can't be used \
|
|
2557
|
-
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.
|
|
2558
2090
|
|
|
2559
|
-
:param
|
|
2560
|
-
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.
|
|
2561
2092
|
|
|
2562
|
-
:param
|
|
2563
|
-
|
|
2564
|
-
: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.
|
|
2565
2094
|
|
|
2095
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2566
2096
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2567
2097
|
|
|
2098
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2099
|
+
|
|
2568
2100
|
:param reply_parameters: Description of the message to reply to.
|
|
2569
2101
|
|
|
2570
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2571
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2572
|
-
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."""
|
|
2573
2103
|
|
|
2574
2104
|
...
|
|
2575
2105
|
|
|
@@ -2595,25 +2125,22 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2595
2125
|
disable_notification: bool | None = None,
|
|
2596
2126
|
protect_content: bool | None = None,
|
|
2597
2127
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2598
|
-
reply_markup:
|
|
2128
|
+
reply_markup: InlineKeyboardMarkup
|
|
2129
|
+
| ReplyKeyboardMarkup
|
|
2130
|
+
| ReplyKeyboardRemove
|
|
2131
|
+
| ForceReply
|
|
2132
|
+
| None = None,
|
|
2599
2133
|
**other: typing.Any,
|
|
2600
2134
|
) -> Result[MessageCute, APIError]:
|
|
2601
2135
|
"""Shortcut `API.send_venue()`, see the [documentation](https://core.telegram.org/bots/api#sendvenue)
|
|
2602
2136
|
|
|
2603
|
-
Use this method to send
|
|
2137
|
+
Use this method to send information about a venue. On success, the sent Message
|
|
2604
2138
|
is returned.
|
|
2139
|
+
:param business_connection_id: Unique identifier of the business connection on behalf of which the messagewill be sent.
|
|
2605
2140
|
|
|
2606
|
-
:param
|
|
2607
|
-
will be sent.
|
|
2608
|
-
|
|
2609
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2610
|
-
(in the format @channelusername).
|
|
2611
|
-
|
|
2612
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2613
|
-
forum supergroups only.
|
|
2141
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2614
2142
|
|
|
2615
|
-
:param
|
|
2616
|
-
chats only.
|
|
2143
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2617
2144
|
|
|
2618
2145
|
:param latitude: Latitude of the venue.
|
|
2619
2146
|
|
|
@@ -2625,22 +2152,20 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2625
2152
|
|
|
2626
2153
|
:param foursquare_id: Foursquare identifier of the venue.
|
|
2627
2154
|
|
|
2628
|
-
:param foursquare_type: Foursquare type of the venue, if known. (For example, `arts_entertainment/default
|
|
2629
|
-
`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`.).
|
|
2630
2156
|
|
|
2631
2157
|
:param google_place_id: Google Places identifier of the venue.
|
|
2632
2158
|
|
|
2633
2159
|
:param google_place_type: Google Places type of the venue. (See supported types.).
|
|
2634
2160
|
|
|
2635
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2636
|
-
|
|
2161
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2637
2162
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2638
2163
|
|
|
2164
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2165
|
+
|
|
2639
2166
|
:param reply_parameters: Description of the message to reply to.
|
|
2640
2167
|
|
|
2641
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2642
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2643
|
-
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."""
|
|
2644
2169
|
|
|
2645
2170
|
...
|
|
2646
2171
|
|
|
@@ -2659,39 +2184,32 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2659
2184
|
disable_notification: bool | None = None,
|
|
2660
2185
|
protect_content: bool | None = None,
|
|
2661
2186
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2662
|
-
reply_markup:
|
|
2187
|
+
reply_markup: InlineKeyboardMarkup
|
|
2188
|
+
| ReplyKeyboardMarkup
|
|
2189
|
+
| ReplyKeyboardRemove
|
|
2190
|
+
| ForceReply
|
|
2191
|
+
| None = None,
|
|
2663
2192
|
**other: typing.Any,
|
|
2664
2193
|
) -> Result[MessageCute, APIError]:
|
|
2665
2194
|
"""Shortcut `API.send_dice()`, see the [documentation](https://core.telegram.org/bots/api#senddice)
|
|
2666
2195
|
|
|
2667
|
-
Use this method to send
|
|
2196
|
+
Use this method to send an animated emoji that will display a random value.
|
|
2668
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.
|
|
2669
2199
|
|
|
2670
|
-
:param
|
|
2671
|
-
will be sent.
|
|
2672
|
-
|
|
2673
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2674
|
-
(in the format @channelusername).
|
|
2675
|
-
|
|
2676
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2677
|
-
forum supergroups only.
|
|
2200
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2678
2201
|
|
|
2679
|
-
:param
|
|
2680
|
-
chats only.
|
|
2681
|
-
|
|
2682
|
-
:param emoji: Emoji on which the dice throw animation is based. Currently, must be one \
|
|
2683
|
-
of `🎲`, `🎯`, `🏀`, `⚽`, `🎳`, or `🎰`. Dice can have values 1-6 for `🎲`, `🎯` and \
|
|
2684
|
-
`🎳`, values 1-5 for `🏀` and `⚽`, and values 1-64 for `🎰`. Defaults to `🎲`. \
|
|
2685
|
-
|
|
2686
|
-
: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.
|
|
2687
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.
|
|
2688
2206
|
:param protect_content: Protects the contents of the sent message from forwarding.
|
|
2689
2207
|
|
|
2208
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2209
|
+
|
|
2690
2210
|
:param reply_parameters: Description of the message to reply to.
|
|
2691
2211
|
|
|
2692
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2693
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2694
|
-
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."""
|
|
2695
2213
|
|
|
2696
2214
|
...
|
|
2697
2215
|
|
|
@@ -2710,35 +2228,28 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2710
2228
|
disable_notification: bool | None = None,
|
|
2711
2229
|
protect_content: bool | None = None,
|
|
2712
2230
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2713
|
-
reply_markup:
|
|
2231
|
+
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2714
2232
|
**other: typing.Any,
|
|
2715
2233
|
) -> Result[MessageCute, APIError]:
|
|
2716
2234
|
"""Shortcut `API.send_game()`, see the [documentation](https://core.telegram.org/bots/api#sendgame)
|
|
2717
2235
|
|
|
2718
|
-
Use this method to send a
|
|
2719
|
-
|
|
2720
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2721
|
-
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.
|
|
2722
2238
|
|
|
2723
2239
|
:param chat_id: Unique identifier for the target chat.
|
|
2724
2240
|
|
|
2725
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum;
|
|
2726
|
-
forum supergroups only.
|
|
2727
|
-
|
|
2728
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2729
|
-
chats only.
|
|
2730
|
-
|
|
2731
|
-
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Set \
|
|
2732
|
-
up your games via @BotFather.
|
|
2241
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2733
2242
|
|
|
2734
|
-
:param
|
|
2243
|
+
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Setup your games via @BotFather.
|
|
2735
2244
|
|
|
2245
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
2736
2246
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2737
2247
|
|
|
2248
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2249
|
+
|
|
2738
2250
|
:param reply_parameters: Description of the message to reply to.
|
|
2739
2251
|
|
|
2740
|
-
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'
|
|
2741
|
-
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."""
|
|
2742
2253
|
|
|
2743
2254
|
...
|
|
2744
2255
|
|
|
@@ -2782,87 +2293,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2782
2293
|
) -> Result[MessageCute, APIError]:
|
|
2783
2294
|
"""Shortcut `API.send_invoice()`, see the [documentation](https://core.telegram.org/bots/api#sendinvoice)
|
|
2784
2295
|
|
|
2785
|
-
Use this method to send
|
|
2786
|
-
|
|
2787
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2788
|
-
will be sent.
|
|
2789
|
-
|
|
2790
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2791
|
-
(in the format @channelusername).
|
|
2792
|
-
|
|
2793
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2794
|
-
forum supergroups only.
|
|
2795
|
-
|
|
2796
|
-
:param message_effect_id: Unique identifier of the message effect to be added to the message; for private \
|
|
2797
|
-
chats only.
|
|
2798
|
-
|
|
2799
|
-
:param title: Product name, 1-32 characters.
|
|
2800
|
-
|
|
2801
|
-
:param description: Product description, 1-255 characters.
|
|
2802
|
-
|
|
2803
|
-
:param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to \
|
|
2804
|
-
the user, use for your internal processes.
|
|
2805
|
-
|
|
2806
|
-
:param provider_token: Payment provider token, obtained via @BotFather.
|
|
2807
|
-
|
|
2808
|
-
:param currency: Three-letter ISO 4217 currency code, see more on currencies.
|
|
2809
|
-
|
|
2810
|
-
:param prices: Price breakdown, a JSON-serialized list of components (e.g. product price, \
|
|
2811
|
-
tax, discount, delivery cost, delivery tax, bonus, etc.).
|
|
2812
|
-
|
|
2813
|
-
:param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency \
|
|
2814
|
-
(integer, not float/double). For example, for a maximum tip of US$ 1.45 \
|
|
2815
|
-
pass max_tip_amount = 145. See the exp parameter in currencies.json, it \
|
|
2816
|
-
shows the number of digits past the decimal point for each currency (2 for \
|
|
2817
|
-
the majority of currencies). Defaults to 0.
|
|
2818
|
-
|
|
2819
|
-
:param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest units \
|
|
2820
|
-
of the currency (integer, not float/double). At most 4 suggested tip amounts \
|
|
2821
|
-
can be specified. The suggested tip amounts must be positive, passed in \
|
|
2822
|
-
a strictly increased order and must not exceed max_tip_amount.
|
|
2823
|
-
|
|
2824
|
-
:param start_parameter: Unique deep-linking parameter. If left empty, forwarded copies of the \
|
|
2825
|
-
sent message will have a Pay button, allowing multiple users to pay directly \
|
|
2826
|
-
from the forwarded message, using the same invoice. If non-empty, forwarded \
|
|
2827
|
-
copies of the sent message will have a URL button with a deep link to the bot \
|
|
2828
|
-
(instead of a Pay button), with the value used as the start parameter.
|
|
2829
|
-
|
|
2830
|
-
:param provider_data: JSON-serialized data about the invoice, which will be shared with the payment \
|
|
2831
|
-
provider. A detailed description of required fields should be provided \
|
|
2832
|
-
by the payment provider.
|
|
2833
|
-
|
|
2834
|
-
:param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or a marketing \
|
|
2835
|
-
image for a service. People like it better when they see what they are paying \
|
|
2836
|
-
for.
|
|
2837
|
-
|
|
2838
|
-
:param photo_size: Photo size in bytes.
|
|
2839
|
-
|
|
2840
|
-
:param photo_width: Photo width.
|
|
2841
|
-
|
|
2842
|
-
:param photo_height: Photo height.
|
|
2843
|
-
|
|
2844
|
-
:param need_name: Pass True if you require the user's full name to complete the order.
|
|
2845
|
-
|
|
2846
|
-
:param need_phone_number: Pass True if you require the user's phone number to complete the order.
|
|
2847
|
-
|
|
2848
|
-
:param need_email: Pass True if you require the user's email address to complete the order. \
|
|
2849
|
-
|
|
2850
|
-
:param need_shipping_address: Pass True if you require the user's shipping address to complete the order. \
|
|
2851
|
-
|
|
2852
|
-
:param send_phone_number_to_provider: Pass True if the user's phone number should be sent to provider.
|
|
2853
|
-
|
|
2854
|
-
:param send_email_to_provider: Pass True if the user's email address should be sent to provider.
|
|
2855
|
-
|
|
2856
|
-
:param is_flexible: Pass True if the final price depends on the shipping method.
|
|
2857
|
-
|
|
2858
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound. \
|
|
2859
|
-
|
|
2860
|
-
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2861
|
-
|
|
2862
|
-
:param reply_parameters: Description of the message to reply to.
|
|
2863
|
-
|
|
2864
|
-
:param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay total \
|
|
2865
|
-
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."""
|
|
2866
2297
|
|
|
2867
2298
|
...
|
|
2868
2299
|
|
|
@@ -2895,36 +2326,20 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2895
2326
|
) -> Result[list[MessageCute], APIError]:
|
|
2896
2327
|
"""Shortcut `API.send_media_group()`, see the [documentation](https://core.telegram.org/bots/api#sendmediagroup)
|
|
2897
2328
|
|
|
2898
|
-
Use this method to send a
|
|
2329
|
+
Use this method to send a group of photos, videos, documents or audios as
|
|
2899
2330
|
an album. Documents and audio files can be only grouped in an album with messages
|
|
2900
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.
|
|
2901
2333
|
|
|
2902
|
-
:param
|
|
2903
|
-
will be sent.
|
|
2904
|
-
|
|
2905
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2906
|
-
(in the format @channelusername).
|
|
2907
|
-
|
|
2908
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
2909
|
-
forum supergroups only.
|
|
2334
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2910
2335
|
|
|
2911
|
-
:param
|
|
2912
|
-
chats only.
|
|
2913
|
-
|
|
2914
|
-
:param media: A JSON-serialized array describing messages to be sent, must include 2-10 \
|
|
2915
|
-
items.
|
|
2916
|
-
|
|
2917
|
-
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
2336
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2918
2337
|
|
|
2919
|
-
:param
|
|
2920
|
-
for more details.
|
|
2338
|
+
:param media: A JSON-serialized array describing messages to be sent, must include 2-10items.
|
|
2921
2339
|
|
|
2922
|
-
:param
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
:param disable_notification: Sends messages silently. Users will receive a notification with no sound. \
|
|
2926
|
-
|
|
2927
|
-
: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.
|
|
2928
2343
|
|
|
2929
2344
|
:param reply_parameters: Description of the message to reply to."""
|
|
2930
2345
|
|
|
@@ -2952,49 +2367,40 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
2952
2367
|
disable_notification: bool | None = None,
|
|
2953
2368
|
protect_content: bool | None = None,
|
|
2954
2369
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
2955
|
-
reply_markup:
|
|
2370
|
+
reply_markup: InlineKeyboardMarkup
|
|
2371
|
+
| ReplyKeyboardMarkup
|
|
2372
|
+
| ReplyKeyboardRemove
|
|
2373
|
+
| ForceReply
|
|
2374
|
+
| None = None,
|
|
2956
2375
|
**other: typing.Any,
|
|
2957
2376
|
) -> Result[MessageCute, APIError]:
|
|
2958
2377
|
"""Shortcut `API.send_location()`, see the [documentation](https://core.telegram.org/bots/api#sendlocation)
|
|
2959
2378
|
|
|
2960
|
-
Use this method to send
|
|
2961
|
-
|
|
2962
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
2963
|
-
will be sent.
|
|
2964
|
-
|
|
2965
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
2966
|
-
(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.
|
|
2967
2381
|
|
|
2968
|
-
:param
|
|
2969
|
-
forum supergroups only.
|
|
2382
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
2970
2383
|
|
|
2971
|
-
:param
|
|
2972
|
-
chats only.
|
|
2384
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
2973
2385
|
|
|
2974
2386
|
:param latitude: Latitude of the location.
|
|
2975
2387
|
|
|
2976
2388
|
:param longitude: Longitude of the location.
|
|
2977
2389
|
|
|
2978
|
-
:param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500.
|
|
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.
|
|
2979
2392
|
|
|
2980
|
-
:param
|
|
2981
|
-
should be between 60 and 86400.
|
|
2982
|
-
|
|
2983
|
-
:param heading: For live locations, a direction in which the user is moving, in degrees. \
|
|
2984
|
-
Must be between 1 and 360 if specified.
|
|
2985
|
-
|
|
2986
|
-
:param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approaching \
|
|
2987
|
-
another chat member, in meters. Must be between 1 and 100000 if specified. \
|
|
2988
|
-
|
|
2989
|
-
: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.
|
|
2990
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.
|
|
2991
2397
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
2992
2398
|
|
|
2399
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2400
|
+
|
|
2993
2401
|
:param reply_parameters: Description of the message to reply to.
|
|
2994
2402
|
|
|
2995
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
2996
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
2997
|
-
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."""
|
|
2998
2404
|
|
|
2999
2405
|
...
|
|
3000
2406
|
|
|
@@ -3016,24 +2422,21 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3016
2422
|
disable_notification: bool | None = None,
|
|
3017
2423
|
protect_content: bool | None = None,
|
|
3018
2424
|
reply_parameters: ReplyParameters | dict[str, typing.Any] | None = None,
|
|
3019
|
-
reply_markup:
|
|
2425
|
+
reply_markup: InlineKeyboardMarkup
|
|
2426
|
+
| ReplyKeyboardMarkup
|
|
2427
|
+
| ReplyKeyboardRemove
|
|
2428
|
+
| ForceReply
|
|
2429
|
+
| None = None,
|
|
3020
2430
|
**other: typing.Any,
|
|
3021
2431
|
) -> Result[MessageCute, APIError]:
|
|
3022
2432
|
"""Shortcut `API.send_contact()`, see the [documentation](https://core.telegram.org/bots/api#sendcontact)
|
|
3023
2433
|
|
|
3024
|
-
Use this method to send
|
|
3025
|
-
|
|
3026
|
-
:param business_connection_id: Unique identifier of the business connection on behalf of which the message \
|
|
3027
|
-
will be sent.
|
|
3028
|
-
|
|
3029
|
-
:param chat_id: Unique identifier for the target chat or username of the target channel \
|
|
3030
|
-
(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.
|
|
3031
2436
|
|
|
3032
|
-
:param
|
|
3033
|
-
forum supergroups only.
|
|
2437
|
+
:param chat_id: Unique identifier for the target chat or username of the target channel(in the format @channelusername).
|
|
3034
2438
|
|
|
3035
|
-
:param
|
|
3036
|
-
chats only.
|
|
2439
|
+
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; forforum supergroups only.
|
|
3037
2440
|
|
|
3038
2441
|
:param phone_number: Contact's phone number.
|
|
3039
2442
|
|
|
@@ -3043,15 +2446,14 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3043
2446
|
|
|
3044
2447
|
:param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes.
|
|
3045
2448
|
|
|
3046
|
-
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
3047
|
-
|
|
2449
|
+
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
|
|
3048
2450
|
:param protect_content: Protects the contents of the sent message from forwarding and saving.
|
|
3049
2451
|
|
|
2452
|
+
:param message_effect_id: Unique identifier of the message effect to be added to the message; for privatechats only.
|
|
2453
|
+
|
|
3050
2454
|
:param reply_parameters: Description of the message to reply to.
|
|
3051
2455
|
|
|
3052
|
-
:param reply_markup: Additional interface options. A JSON-serialized object for an
|
|
3053
|
-
keyboard, custom reply keyboard, instructions to remove reply keyboard \
|
|
3054
|
-
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."""
|
|
3055
2457
|
|
|
3056
2458
|
...
|
|
3057
2459
|
|
|
@@ -3073,6 +2475,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3073
2475
|
heading: int | None = None,
|
|
3074
2476
|
proximity_alert_radius: int | None = None,
|
|
3075
2477
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2478
|
+
business_connection_id: str | None = None,
|
|
3076
2479
|
**other: typing.Any,
|
|
3077
2480
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3078
2481
|
"""Shortcut `API.edit_message_live_location()`, see the [documentation](https://core.telegram.org/bots/api#editmessagelivelocation)
|
|
@@ -3081,37 +2484,23 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3081
2484
|
until its live_period expires or editing is explicitly disabled by a call
|
|
3082
2485
|
to stopMessageLiveLocation. On success, if the edited message is not an
|
|
3083
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.
|
|
3084
2488
|
|
|
3085
|
-
:param chat_id: Required if inline_message_id is not specified. Unique identifier
|
|
3086
|
-
|
|
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.
|
|
3087
2491
|
|
|
3088
|
-
:param
|
|
3089
|
-
to edit.
|
|
3090
|
-
|
|
3091
|
-
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for \
|
|
3092
|
-
forum supergroups only.
|
|
3093
|
-
|
|
3094
|
-
:param live_period: New period in seconds during which the location can be updated, starting \
|
|
3095
|
-
from the message send date. If 0x7FFFFFFF is specified, then the location \
|
|
3096
|
-
can be updated forever. Otherwise, the new value must not exceed the current \
|
|
3097
|
-
live_period by more than a day, and the live location expiration date must \
|
|
3098
|
-
remain within the next 90 days. If not specified, then live_period remains \
|
|
3099
|
-
unchanged.
|
|
3100
|
-
|
|
3101
|
-
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the \
|
|
3102
|
-
inline message.
|
|
2492
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3103
2493
|
|
|
3104
2494
|
:param latitude: Latitude of new location.
|
|
3105
2495
|
|
|
3106
2496
|
:param longitude: Longitude of new location.
|
|
3107
2497
|
|
|
3108
|
-
: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.
|
|
3109
2499
|
|
|
3110
|
-
:param
|
|
3111
|
-
|
|
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.
|
|
3112
2502
|
|
|
3113
|
-
:param proximity_alert_radius: The maximum distance for proximity alerts about approaching another
|
|
3114
|
-
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.
|
|
3115
2504
|
|
|
3116
2505
|
:param reply_markup: A JSON-serialized object for a new inline keyboard."""
|
|
3117
2506
|
|
|
@@ -3124,7 +2513,7 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3124
2513
|
)
|
|
3125
2514
|
async def edit_caption(
|
|
3126
2515
|
self,
|
|
3127
|
-
caption: str,
|
|
2516
|
+
caption: str | None = None,
|
|
3128
2517
|
chat_id: int | str | None = None,
|
|
3129
2518
|
message_id: int | None = None,
|
|
3130
2519
|
message_thread_id: int | None = None,
|
|
@@ -3132,32 +2521,30 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3132
2521
|
caption_entities: list[MessageEntity] | None = None,
|
|
3133
2522
|
show_caption_above_media: bool | None = None,
|
|
3134
2523
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2524
|
+
business_connection_id: str | None = None,
|
|
2525
|
+
inline_message_id: str | None = None,
|
|
3135
2526
|
**other: typing.Any,
|
|
3136
2527
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3137
2528
|
"""Shortcut `API.edit_message_caption()`, see the [documentation](https://core.telegram.org/bots/api#editmessagecaption)
|
|
3138
2529
|
|
|
3139
2530
|
Use this method to edit captions of messages. On success, if the edited message
|
|
3140
2531
|
is not an inline message, the edited Message is returned, otherwise True
|
|
3141
|
-
is returned.
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
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.
|
|
3145
2536
|
|
|
3146
|
-
:param
|
|
3147
|
-
|
|
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.
|
|
3148
2539
|
|
|
3149
|
-
:param
|
|
3150
|
-
forum supergroups only.
|
|
2540
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3151
2541
|
|
|
3152
|
-
: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.
|
|
3153
2544
|
|
|
3154
|
-
:param
|
|
3155
|
-
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.
|
|
3156
2546
|
|
|
3157
|
-
:param
|
|
3158
|
-
which can be specified instead of parse_mode.
|
|
3159
|
-
|
|
3160
|
-
: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.
|
|
3161
2548
|
|
|
3162
2549
|
:param reply_markup: A JSON-serialized object for an inline keyboard."""
|
|
3163
2550
|
|
|
@@ -3187,6 +2574,8 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3187
2574
|
message_id: int | None = None,
|
|
3188
2575
|
message_thread_id: int | None = None,
|
|
3189
2576
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2577
|
+
business_connection_id: str | None = None,
|
|
2578
|
+
inline_message_id: str | None = None,
|
|
3190
2579
|
**other: typing.Any,
|
|
3191
2580
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3192
2581
|
"""Shortcut `API.edit_message_media()`, see the [documentation](https://core.telegram.org/bots/api#editmessagemedia)
|
|
@@ -3197,30 +2586,18 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3197
2586
|
a video otherwise. When an inline message is edited, a new file can't be uploaded;
|
|
3198
2587
|
use a previously uploaded file via its file_id or specify a URL. On success,
|
|
3199
2588
|
if the edited message is not an inline message, the edited Message is returned,
|
|
3200
|
-
otherwise True is returned.
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
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.
|
|
3204
2593
|
|
|
3205
|
-
:param
|
|
3206
|
-
|
|
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.
|
|
3207
2596
|
|
|
3208
|
-
:param
|
|
3209
|
-
forum supergroups only.
|
|
2597
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3210
2598
|
|
|
3211
2599
|
:param media: A JSON-serialized object for a new media content of the message.
|
|
3212
2600
|
|
|
3213
|
-
:param caption: Audio caption, 0-1024 characters after entities parsing.
|
|
3214
|
-
|
|
3215
|
-
:param parse_mode: Mode for parsing entities in the audio caption. See formatting options \
|
|
3216
|
-
for more details.
|
|
3217
|
-
|
|
3218
|
-
:param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
|
|
3219
|
-
which can be specified instead of parse_mode.
|
|
3220
|
-
|
|
3221
|
-
:param type: Required if media is not an `str | InputMedia` object. Type of the media, \
|
|
3222
|
-
must be one of `photo`, `video`, `animation`, `audio`, `document`.
|
|
3223
|
-
|
|
3224
2601
|
:param reply_markup: A JSON-serialized object for a new inline keyboard."""
|
|
3225
2602
|
|
|
3226
2603
|
params = get_params(locals())
|
|
@@ -3248,22 +2625,23 @@ class MessageCute(BaseCute[Message], Message, kw_only=True):
|
|
|
3248
2625
|
message_id: int | None = None,
|
|
3249
2626
|
message_thread_id: int | None = None,
|
|
3250
2627
|
reply_markup: InlineKeyboardMarkup | None = None,
|
|
2628
|
+
business_connection_id: str | None = None,
|
|
2629
|
+
inline_message_id: str | None = None,
|
|
3251
2630
|
**other: typing.Any,
|
|
3252
2631
|
) -> Result[Variative[MessageCute, bool], APIError]:
|
|
3253
2632
|
"""Shortcut `API.edit_message_reply_markup()`, see the [documentation](https://core.telegram.org/bots/api#editmessagereplymarkup)
|
|
3254
2633
|
|
|
3255
2634
|
Use this method to edit only the reply markup of messages. On success, if
|
|
3256
2635
|
the edited message is not an inline message, the edited Message is returned,
|
|
3257
|
-
otherwise True is returned.
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
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.
|
|
3261
2640
|
|
|
3262
|
-
:param
|
|
3263
|
-
|
|
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.
|
|
3264
2643
|
|
|
3265
|
-
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of
|
|
3266
|
-
inline message.
|
|
2644
|
+
:param inline_message_id: Required if chat_id and message_id are not specified. Identifier of theinline message.
|
|
3267
2645
|
|
|
3268
2646
|
:param reply_markup: A JSON-serialized object for an inline keyboard."""
|
|
3269
2647
|
|