mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
* Added API changes * Added changelog * Oops. Move changelog * Update tests * Remove experimental * Added message content type * Update message aliases * Update changes * Update texts * Bump version * Remove versionadded badge
55 lines
2.3 KiB
Python
55 lines
2.3 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, Dict, Optional, Union
|
|
|
|
from ..types import (
|
|
ForceReply,
|
|
InlineKeyboardMarkup,
|
|
Message,
|
|
ReplyKeyboardMarkup,
|
|
ReplyKeyboardRemove,
|
|
)
|
|
from .base import Request, TelegramMethod
|
|
|
|
if TYPE_CHECKING:
|
|
from ..client.bot import Bot
|
|
|
|
|
|
class SendContact(TelegramMethod[Message]):
|
|
"""
|
|
Use this method to send phone contacts. On success, the sent :class:`aiogram.types.message.Message` is returned.
|
|
|
|
Source: https://core.telegram.org/bots/api#sendcontact
|
|
"""
|
|
|
|
__returning__ = Message
|
|
|
|
chat_id: Union[int, str]
|
|
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
phone_number: str
|
|
"""Contact's phone number"""
|
|
first_name: str
|
|
"""Contact's first name"""
|
|
message_thread_id: Optional[int] = None
|
|
"""Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
|
|
last_name: Optional[str] = None
|
|
"""Contact's last name"""
|
|
vcard: Optional[str] = None
|
|
"""Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_, 0-2048 bytes"""
|
|
disable_notification: Optional[bool] = None
|
|
"""Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound."""
|
|
protect_content: Optional[bool] = None
|
|
"""Protects the contents of the sent message from forwarding and saving"""
|
|
reply_to_message_id: Optional[int] = None
|
|
"""If the message is a reply, ID of the original message"""
|
|
allow_sending_without_reply: Optional[bool] = None
|
|
"""Pass :code:`True` if the message should be sent even if the specified replied-to message is not found"""
|
|
reply_markup: Optional[
|
|
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
|
|
] = None
|
|
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user."""
|
|
|
|
def build_request(self, bot: Bot) -> Request:
|
|
data: Dict[str, Any] = self.dict()
|
|
|
|
return Request(method="sendContact", data=data)
|