2020-03-21 14:43:32 +00:00
|
|
|
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
|
|
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
|
2018-05-07 12:30:55 +00:00
|
|
|
#
|
2020-03-21 14:43:32 +00:00
|
|
|
# This file is part of Pyrogram.
|
2018-05-07 12:30:55 +00:00
|
|
|
#
|
2020-03-21 14:43:32 +00:00
|
|
|
# Pyrogram is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Lesser General Public License as published
|
|
|
|
# by the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
2018-05-07 12:30:55 +00:00
|
|
|
#
|
2020-03-21 14:43:32 +00:00
|
|
|
# Pyrogram is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU Lesser General Public License for more details.
|
2018-05-07 12:30:55 +00:00
|
|
|
#
|
2020-03-21 14:43:32 +00:00
|
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
|
|
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
|
2018-05-07 12:30:55 +00:00
|
|
|
|
2020-11-29 14:48:29 +00:00
|
|
|
from typing import Union, List
|
2018-12-19 13:50:23 +00:00
|
|
|
|
2020-11-29 14:48:29 +00:00
|
|
|
from pyrogram import raw, utils
|
2020-08-22 06:05:05 +00:00
|
|
|
from pyrogram import types
|
|
|
|
from pyrogram.scaffold import Scaffold
|
2018-05-07 12:30:55 +00:00
|
|
|
|
|
|
|
|
2020-08-22 06:05:05 +00:00
|
|
|
class SendMessage(Scaffold):
|
2020-08-21 05:28:27 +00:00
|
|
|
async def send_message(
|
2019-03-16 18:23:23 +00:00
|
|
|
self,
|
|
|
|
chat_id: Union[int, str],
|
|
|
|
text: str,
|
2019-07-11 17:28:33 +00:00
|
|
|
parse_mode: Union[str, None] = object,
|
2020-11-29 14:48:29 +00:00
|
|
|
entities: List["types.MessageEntity"] = None,
|
2019-03-16 18:23:23 +00:00
|
|
|
disable_web_page_preview: bool = None,
|
|
|
|
disable_notification: bool = None,
|
|
|
|
reply_to_message_id: int = None,
|
2019-09-07 13:56:37 +00:00
|
|
|
schedule_date: int = None,
|
2019-03-16 18:23:23 +00:00
|
|
|
reply_markup: Union[
|
2020-08-22 06:05:05 +00:00
|
|
|
"types.InlineKeyboardMarkup",
|
|
|
|
"types.ReplyKeyboardMarkup",
|
|
|
|
"types.ReplyKeyboardRemove",
|
|
|
|
"types.ForceReply"
|
2019-03-16 18:23:23 +00:00
|
|
|
] = None
|
2020-08-22 06:05:05 +00:00
|
|
|
) -> "types.Message":
|
2019-05-12 17:49:06 +00:00
|
|
|
"""Send text messages.
|
2018-05-07 12:30:55 +00:00
|
|
|
|
2019-05-09 02:28:46 +00:00
|
|
|
Parameters:
|
2018-05-07 12:30:55 +00:00
|
|
|
chat_id (``int`` | ``str``):
|
|
|
|
Unique identifier (int) or username (str) of the target chat.
|
|
|
|
For your personal cloud (Saved Messages) you can simply use "me" or "self".
|
|
|
|
For a contact that exists in your Telegram address book you can use his phone number (str).
|
|
|
|
|
|
|
|
text (``str``):
|
|
|
|
Text of the message to be sent.
|
|
|
|
|
2018-05-09 11:04:02 +00:00
|
|
|
parse_mode (``str``, *optional*):
|
2019-06-26 14:36:24 +00:00
|
|
|
By default, texts are parsed using both Markdown and HTML styles.
|
|
|
|
You can combine both syntaxes together.
|
2019-07-10 18:03:10 +00:00
|
|
|
Pass "markdown" or "md" to enable Markdown-style parsing only.
|
2019-06-26 14:36:24 +00:00
|
|
|
Pass "html" to enable HTML-style parsing only.
|
|
|
|
Pass None to completely disable style parsing.
|
2018-05-07 12:30:55 +00:00
|
|
|
|
2020-11-29 14:48:29 +00:00
|
|
|
entities (List of :obj:`~pyrogram.types.MessageEntity`):
|
|
|
|
List of special entities that appear in message text, which can be specified instead of __parse_mode__.
|
|
|
|
|
2018-05-07 12:30:55 +00:00
|
|
|
disable_web_page_preview (``bool``, *optional*):
|
|
|
|
Disables link previews for links in this message.
|
|
|
|
|
|
|
|
disable_notification (``bool``, *optional*):
|
|
|
|
Sends the message silently.
|
|
|
|
Users will receive a notification with no sound.
|
|
|
|
|
2018-05-09 11:04:02 +00:00
|
|
|
reply_to_message_id (``int``, *optional*):
|
2018-05-07 12:30:55 +00:00
|
|
|
If the message is a reply, ID of the original message.
|
|
|
|
|
2019-09-07 13:56:37 +00:00
|
|
|
schedule_date (``int``, *optional*):
|
|
|
|
Date when the message will be automatically sent. Unix time.
|
|
|
|
|
2020-08-22 06:05:05 +00:00
|
|
|
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*):
|
2018-05-07 12:30:55 +00:00
|
|
|
Additional interface options. An object for an inline keyboard, custom reply keyboard,
|
|
|
|
instructions to remove reply keyboard or to force a reply from the user.
|
|
|
|
|
|
|
|
Returns:
|
2020-08-22 06:05:05 +00:00
|
|
|
:obj:`~pyrogram.types.Message`: On success, the sent text message is returned.
|
2018-05-07 12:30:55 +00:00
|
|
|
|
2019-07-25 09:22:14 +00:00
|
|
|
Example:
|
|
|
|
.. code-block:: python
|
2020-03-30 12:39:36 +00:00
|
|
|
:emphasize-lines: 2,5,8,11,21-23,26-32
|
2019-07-25 09:22:14 +00:00
|
|
|
|
|
|
|
# Simple example
|
|
|
|
app.send_message("haskell", "Thanks for creating **Pyrogram**!")
|
|
|
|
|
|
|
|
# Disable web page previews
|
|
|
|
app.send_message("me", "https://docs.pyrogram.org", disable_web_page_preview=True)
|
|
|
|
|
|
|
|
# Reply to a message using its id
|
|
|
|
app.send_message("me", "this is a reply", reply_to_message_id=12345)
|
|
|
|
|
|
|
|
# Force HTML-only styles for this request only
|
|
|
|
app.send_message("me", "**not bold**, <i>italic<i>", parse_mode="html")
|
|
|
|
|
|
|
|
##
|
|
|
|
# For bots only, send messages with keyboards attached
|
|
|
|
##
|
|
|
|
|
2020-10-31 18:29:39 +00:00
|
|
|
from pyrogram.types import (
|
2019-07-25 09:22:14 +00:00
|
|
|
ReplyKeyboardMarkup, InlineKeyboardMarkup, InlineKeyboardButton)
|
|
|
|
|
|
|
|
# Send a normal keyboard
|
|
|
|
app.send_message(
|
|
|
|
chat_id, "Look at that button!",
|
|
|
|
reply_markup=ReplyKeyboardMarkup([["Nice!"]]))
|
|
|
|
|
|
|
|
# Send an inline keyboard
|
|
|
|
app.send_message(
|
|
|
|
chat_id, "These are inline buttons",
|
|
|
|
reply_markup=InlineKeyboardMarkup(
|
|
|
|
[
|
|
|
|
[InlineKeyboardButton("Data", callback_data="hidden_callback_data")],
|
|
|
|
[InlineKeyboardButton("Docs", url="https://docs.pyrogram.org")]
|
|
|
|
]))
|
2018-05-07 12:30:55 +00:00
|
|
|
"""
|
2019-07-25 09:22:14 +00:00
|
|
|
|
2020-11-29 14:48:29 +00:00
|
|
|
message, entities = (await utils.parse_text_entities(self, text, parse_mode, entities)).values()
|
2018-05-07 12:30:55 +00:00
|
|
|
|
2020-08-21 05:28:27 +00:00
|
|
|
r = await self.send(
|
2020-08-22 06:05:05 +00:00
|
|
|
raw.functions.messages.SendMessage(
|
2020-08-21 05:28:27 +00:00
|
|
|
peer=await self.resolve_peer(chat_id),
|
2018-05-07 12:30:55 +00:00
|
|
|
no_webpage=disable_web_page_preview or None,
|
|
|
|
silent=disable_notification or None,
|
|
|
|
reply_to_msg_id=reply_to_message_id,
|
|
|
|
random_id=self.rnd_id(),
|
2019-09-07 13:56:37 +00:00
|
|
|
schedule_date=schedule_date,
|
2018-05-07 12:30:55 +00:00
|
|
|
reply_markup=reply_markup.write() if reply_markup else None,
|
2018-11-20 15:52:59 +00:00
|
|
|
message=message,
|
|
|
|
entities=entities
|
2018-05-07 12:30:55 +00:00
|
|
|
)
|
|
|
|
)
|
|
|
|
|
2020-08-22 06:05:05 +00:00
|
|
|
if isinstance(r, raw.types.UpdateShortSentMessage):
|
2020-08-21 05:28:27 +00:00
|
|
|
peer = await self.resolve_peer(chat_id)
|
2019-01-10 17:22:37 +00:00
|
|
|
|
|
|
|
peer_id = (
|
|
|
|
peer.user_id
|
2020-08-22 06:05:05 +00:00
|
|
|
if isinstance(peer, raw.types.InputPeerUser)
|
2019-01-10 17:22:37 +00:00
|
|
|
else -peer.chat_id
|
|
|
|
)
|
|
|
|
|
2020-08-22 06:05:05 +00:00
|
|
|
return types.Message(
|
2018-05-07 12:30:55 +00:00
|
|
|
message_id=r.id,
|
2020-08-22 06:05:05 +00:00
|
|
|
chat=types.Chat(
|
2019-01-10 17:22:37 +00:00
|
|
|
id=peer_id,
|
2018-12-18 08:45:49 +00:00
|
|
|
type="private",
|
|
|
|
client=self
|
|
|
|
),
|
2018-11-20 15:52:59 +00:00
|
|
|
text=message,
|
2018-05-07 12:30:55 +00:00
|
|
|
date=r.date,
|
|
|
|
outgoing=r.out,
|
2020-04-12 11:30:59 +00:00
|
|
|
entities=[
|
2020-08-22 06:05:05 +00:00
|
|
|
types.MessageEntity._parse(None, entity, {})
|
2020-04-12 11:30:59 +00:00
|
|
|
for entity in entities
|
|
|
|
],
|
2018-11-20 15:52:59 +00:00
|
|
|
client=self
|
2018-05-07 12:30:55 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
for i in r.updates:
|
2020-08-22 06:05:05 +00:00
|
|
|
if isinstance(i, (raw.types.UpdateNewMessage,
|
|
|
|
raw.types.UpdateNewChannelMessage,
|
|
|
|
raw.types.UpdateNewScheduledMessage)):
|
|
|
|
return await types.Message._parse(
|
2018-05-09 17:29:23 +00:00
|
|
|
self, i.message,
|
|
|
|
{i.id: i for i in r.users},
|
2019-09-07 13:56:37 +00:00
|
|
|
{i.id: i for i in r.chats},
|
2020-08-22 06:05:05 +00:00
|
|
|
is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage)
|
2018-05-09 17:29:23 +00:00
|
|
|
)
|