# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
# This file is part of Pyrogram.
#
# 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.
#
# 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.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import logging
import pyrogram
from pyrogram import enums, raw, types, utils
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime
log = logging.getLogger(__name__)
class SendInvoice:
async def send_invoice(
self: pyrogram.Client,
chat_id: int | str,
title: str,
description: str,
payload: str | bytes,
currency: str,
prices: list[types.LabeledPrice],
message_thread_id: int | None = None,
provider_token: str | None = None,
max_tip_amount: int | None = None,
suggested_tip_amounts: list[int] | None = None,
start_parameter: str | None = None,
provider_data: str | None = None,
photo_url: str | None = None,
photo_size: int | None = None,
photo_width: int | None = None,
photo_height: int | None = None,
need_name: bool | None = None,
need_phone_number: bool | None = None,
need_email: bool | None = None,
need_shipping_address: bool | None = None,
send_phone_number_to_provider: bool | None = None,
send_email_to_provider: bool | None = None,
is_flexible: bool | None = None,
disable_notification: bool | None = None,
protect_content: bool | None = None,
effect_id: int | None = None,
reply_parameters: types.ReplyParameters | None = None,
allow_paid_broadcast: bool | None = None,
paid_message_star_count: int | None = None,
direct_messages_topic_id: int | None = None,
suggested_post_parameters: types.SuggestedPostParameters | None = None,
subscription_period: int | None = None,
terms_url: str | None = None,
reply_markup: types.InlineKeyboardMarkup
| types.ReplyKeyboardMarkup
| types.ReplyKeyboardRemove
| types.ForceReply
| None = None,
caption: str = "",
parse_mode: enums.ParseMode | None = None,
caption_entities: list[types.MessageEntity] | None = None,
business_connection_id: str | None = None,
background: bool | None = None,
clear_draft: bool | None = None,
update_stickersets_order: bool | None = None,
send_as: int | str | None = None,
quick_reply_shortcut: int | None = None,
repeat_period: int | None = None,
schedule_date: datetime | None = None,
reply_to_message_id: int | None = None,
) -> types.Message:
"""Use this method to send invoices.
.. include:: /_includes/usable-by/bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
title (``str``):
Product name, 1-32 characters.
description (``str``):
Product description, 1-255 characters.
payload (``str`` | ``bytes``):
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
currency (``str``):
Three-letter ISO 4217 currency code, see `more on currencies <https://core.telegram.org/bots/payments#supported-currencies>`_. Pass ``XTR`` for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
prices (List of :obj:`~pyrogram.types.LabeledPrice`):
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
message_thread_id (``int``, *optional*):
If the message is in a thread, ID of the original message.
reply_parameters (:obj:`~pyrogram.types.ReplyParameters`, *optional*):
Describes reply parameters for the message that is being sent.
provider_token (``str``, *optional*):
Payment provider token, obtained via `@BotFather <https://t.me/botfather>`_. Pass an empty string for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
max_tip_amount (``int``, *optional*):
The maximum accepted amount for tips in the smallest units of the currency (integer, **not** float/double). For example, for a maximum tip of ``US$ 1.45`` pass ``max_tip_amount = 145``. See the exp parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
suggested_tip_amounts (List of ``int``, *optional*):
An array of suggested amounts of tips in the smallest units of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed ``max_tip_amount``. Must be passed together with ``max_tip_amount``: the two share a single flag in the invoice payload, so one without the other is not representable.
start_parameter (``str``, *optional*):
Unique deep-linking parameter. If left empty, **forwarded copies** of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.
provider_data (``str``, *optional*):
JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photo_url (``str``, *optional*):
URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
photo_size (``int``, *optional*):
Photo size in bytes.
photo_width (``int``, *optional*):
Photo width.
photo_height (``int``, *optional*):
Photo height.
need_name (``bool``, *optional*):
Pass True if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
need_phone_number (``bool``, *optional*):
Pass True if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
need_email (``bool``, *optional*):
Pass True if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
need_shipping_address (``bool``, *optional*):
Pass True if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
send_phone_number_to_provider (``bool``, *optional*):
Pass True if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
send_email_to_provider (``bool``, *optional*):
Pass True if the user's email address should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
is_flexible (``bool``, *optional*):
Pass True if the final price depends on the shipping method. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.
disable_notification (``bool``, *optional*):
Sends the message silently.
Users will receive a notification with no sound.
protect_content (``bool``, *optional*):
Protects the contents of the sent message from forwarding and saving.
effect_id (``int`` ``64-bit``, *optional*):
Unique identifier of the message effect to be added to the message; for private chats only.
allow_paid_broadcast (``bool``, *optional*):
If True, you will be allowed to send up to 1000 messages per second.
Ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message.
The relevant Stars will be withdrawn from the bot's balance.
direct_messages_topic_id (``int``, *optional*):
Unique identifier of the topic in a channel direct messages chat administered by the current user.
For directs only only.
suggested_post_parameters (:obj:`~pyrogram.types.SuggestedPostParameters`, *optional*):
Information about the suggested post.
subscription_period (``int``, *optional*):
Period of the subscription in seconds (e.g. 30*24*60*60 = 2592000 for 1 month).
For recurring payments only.
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*):
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.
caption (``str``, *optional*):
Document caption, 0-1024 characters.
parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
caption_entities (List of :obj:`~pyrogram.types.MessageEntity`):
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
background (``bool``, *optional*):
Send the message in background.
clear_draft (``bool``, *optional*):
Clear the draft of the chat.
update_stickersets_order (``bool``, *optional*):
Move the sticker set to the top of the list.
send_as (``int`` | ``str``, *optional*):
Unique identifier (int) or username (str) of the chat or channel to send the message as.
quick_reply_shortcut (``int``, *optional*):
Unique identifier of the quick reply shortcut to use.
repeat_period (``int``, *optional*):
Period in seconds for the message to be sent repeatedly.
schedule_date (:py:obj:`~datetime.datetime`, *optional*):
Date when the message will be automatically sent.
paid_message_star_count (``int``, *optional*):
The number of Telegram Stars the user agreed to pay to send the messages.
terms_url (``str``, *optional*):
URL of the terms of service the buyer has to accept before paying.
business_connection_id (``str``, *optional*):
Unique identifier of the business connection.
reply_to_message_id (``int``, *optional*):
If the message is a reply, ID of the original message.
Returns:
:obj:`~pyrogram.types.Message`: On success, the sent invoice message is returned.
"""
if (max_tip_amount is not None) != bool(suggested_tip_amounts):
raise ValueError("max_tip_amount and suggested_tip_amounts must be passed together")
if reply_parameters is None:
if reply_to_message_id is not None:
log.warning(
"`reply_to_message_id` is deprecated and will be removed in future updates. Use `reply_parameters` instead."
)
reply_parameters = types.ReplyParameters(message_id=reply_to_message_id)
media = raw.types.InputMediaInvoice(
title=title,
description=description,
photo=raw.types.InputWebDocument(
url=photo_url,
mime_type="image/jpg",
size=photo_size or 0,
attributes=[
raw.types.DocumentAttributeImageSize(w=photo_width or 0, h=photo_height or 0)
],
)
if photo_url
else None,
invoice=raw.types.Invoice(
currency=currency,
prices=[i.write() for i in prices],
test=self.test_mode,
name_requested=need_name,
phone_requested=need_phone_number,
email_requested=need_email,
shipping_address_requested=need_shipping_address,
flexible=is_flexible,
phone_to_provider=send_phone_number_to_provider,
email_to_provider=send_email_to_provider,
max_tip_amount=max_tip_amount,
suggested_tip_amounts=suggested_tip_amounts,
recurring=True if subscription_period is not None else None,
subscription_period=subscription_period,
terms_url=terms_url,
),
payload=payload.encode() if isinstance(payload, str) else payload,
provider=provider_token,
provider_data=raw.types.DataJSON(
data=provider_data if provider_data is not None else "{}"
),
start_param=start_parameter,
)
rpc = raw.functions.messages.SendMedia(
peer=await self.resolve_peer(chat_id),
media=media,
silent=disable_notification if disable_notification is not None else None,
reply_to=await utils.get_reply_to(
self,
reply_parameters,
message_thread_id,
direct_messages_topic_id=direct_messages_topic_id,
),
random_id=self.rnd_id(),
noforwards=protect_content,
allow_paid_floodskip=allow_paid_broadcast if allow_paid_broadcast is not None else None,
allow_paid_stars=paid_message_star_count
if paid_message_star_count is not None
else None,
reply_markup=await reply_markup.write(self) if reply_markup else None,
effect=effect_id,
suggested_post=suggested_post_parameters.write() if suggested_post_parameters else None,
background=background,
clear_draft=clear_draft,
update_stickersets_order=update_stickersets_order,
send_as=await self.resolve_peer(send_as) if send_as is not None else None,
quick_reply_shortcut=raw.types.InputQuickReplyShortcutId(
shortcut_id=quick_reply_shortcut
)
if quick_reply_shortcut is not None
else None,
schedule_repeat_period=repeat_period,
schedule_date=utils.datetime_to_timestamp(schedule_date),
**await utils.parse_text_entities(self, caption, parse_mode, caption_entities),
)
r = await self.invoke(
rpc, sleep_threshold=60, business_connection_id=business_connection_id
)
messages = await utils.parse_messages(client=self, messages=r)
return messages[0] if messages else None