Cluster · разработчикам

TL payments · методы

Каталог и общие правила · Справочник SDK

payments.ApplyGiftCode

Аргументы

• slug: str, обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ApplyGiftCode(slug=slug)

Описание Telegram

payments.AssignAppStoreTransaction

Аргументы

• purpose: 'TypeInputStorePaymentPurpose', обязательный.
• receipt: bytes, обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.AssignAppStoreTransaction(purpose=purpose, receipt=receipt)

Описание Telegram

payments.AssignPlayMarketTransaction

Аргументы

• purpose: 'TypeInputStorePaymentPurpose', обязательный.
• receipt: 'TypeDataJSON', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.AssignPlayMarketTransaction(purpose=purpose, receipt=receipt)

Описание Telegram

payments.BotCancelStarsSubscription

Аргументы

• charge_id: str, обязательный.
• restore: Optional[bool], необязательный; значение None.
• user_id: 'TypeInputUser', обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.BotCancelStarsSubscription(charge_id=charge_id, user_id=user_id)

Описание Telegram

payments.CanPurchaseStore

Аргументы

• purpose: 'TypeInputStorePaymentPurpose', обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.CanPurchaseStore(purpose=purpose)

Описание Telegram

payments.ChangeStarsSubscription

Аргументы

• canceled: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.
• subscription_id: str, обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ChangeStarsSubscription(peer=peer, subscription_id=subscription_id)

Описание Telegram

payments.CheckCanSendGift

Аргументы

• gift_id: int, обязательный.

Результат

payments.CheckCanSendGiftResult, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.CheckCanSendGift(gift_id=gift_id)

Описание Telegram

payments.CheckGiftCode

Аргументы

• slug: str, обязательный.

Результат

payments.CheckedGiftCode, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.CheckGiftCode(slug=slug)

Описание Telegram

payments.ClearSavedInfo

Аргументы

• credentials: Optional[bool], необязательный; значение None.
• info: Optional[bool], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ClearSavedInfo()

Описание Telegram

payments.ConnectStarRefBot

Аргументы

• bot: 'TypeInputUser', обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.ConnectedStarRefBots, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ConnectStarRefBot(bot=bot, peer=peer)

Описание Telegram

payments.ConvertStarGift

Аргументы

• stargift: 'TypeInputSavedStarGift', обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ConvertStarGift(stargift=stargift)

Описание Telegram

payments.CraftStarGift

Аргументы

• stargift: List[ForwardRef('TypeInputSavedStarGift')], обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.CraftStarGift(stargift=stargift)

Описание Telegram

payments.CreateStarGiftCollection

Аргументы

• peer: 'TypeInputPeer', обязательный.
• stargift: List[ForwardRef('TypeInputSavedStarGift')], обязательный.
• title: str, обязательный.

Результат

StarGiftCollection, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.CreateStarGiftCollection(peer=peer, stargift=stargift, title=title)

Описание Telegram

payments.DeleteStarGiftCollection

Аргументы

• collection_id: int, обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.DeleteStarGiftCollection(collection_id=collection_id, peer=peer)

Описание Telegram

payments.EditConnectedStarRefBot

Аргументы

• link: str, обязательный.
• peer: 'TypeInputPeer', обязательный.
• revoked: Optional[bool], необязательный; значение None.

Результат

payments.ConnectedStarRefBots, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.EditConnectedStarRefBot(link=link, peer=peer)

Описание Telegram

payments.ExportInvoice

Аргументы

• invoice_media: 'TypeInputMedia', обязательный.

Результат

payments.ExportedInvoice, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ExportInvoice(invoice_media=invoice_media)

Описание Telegram

payments.FulfillStarsSubscription

Аргументы

• peer: 'TypeInputPeer', обязательный.
• subscription_id: str, обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.FulfillStarsSubscription(peer=peer, subscription_id=subscription_id)

Описание Telegram

payments.GetBankCardData

Аргументы

• number: str, обязательный.

Результат

payments.BankCardData, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetBankCardData(number=number)

Описание Telegram

payments.GetConnectedStarRefBot

Аргументы

• bot: 'TypeInputUser', обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.ConnectedStarRefBots, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetConnectedStarRefBot(bot=bot, peer=peer)

Описание Telegram

payments.GetConnectedStarRefBots

Аргументы

• limit: int, обязательный.
• offset_date: Optional[datetime.datetime], необязательный; значение None.
• offset_link: Optional[str], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.ConnectedStarRefBots, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetConnectedStarRefBots(limit=limit, peer=peer)

Описание Telegram

payments.GetCraftStarGifts

Аргументы

• gift_id: int, обязательный.
• limit: int, обязательный.
• offset: str, обязательный.

Результат

payments.SavedStarGifts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetCraftStarGifts(gift_id=gift_id, limit=limit, offset=offset)

Описание Telegram

payments.GetGiveawayInfo

Аргументы

• msg_id: int, обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.GiveawayInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetGiveawayInfo(msg_id=msg_id, peer=peer)

Описание Telegram

payments.GetPaymentForm

Аргументы

• invoice: 'TypeInputInvoice', обязательный.
• theme_params: Optional[ForwardRef('TypeDataJSON')], необязательный; значение None.

Результат

payments.PaymentForm, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetPaymentForm(invoice=invoice)

Описание Telegram

payments.GetPaymentReceipt

Аргументы

• msg_id: int, обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.PaymentReceipt, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetPaymentReceipt(msg_id=msg_id, peer=peer)

Описание Telegram

payments.GetPremiumGiftCodeOptions

Аргументы

• boost_peer: Optional[ForwardRef('TypeInputPeer')], необязательный; значение None.

Результат

Vector<PremiumGiftCodeOption>, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetPremiumGiftCodeOptions()

Описание Telegram

payments.GetResaleStarGifts

Аргументы

• attributes: Optional[List[ForwardRef('TypeStarGiftAttributeId')]], необязательный; значение None.
• attributes_hash: Optional[int], необязательный; значение None.
• for_craft: Optional[bool], необязательный; значение None.
• gift_id: int, обязательный.
• limit: int, обязательный.
• offset: str, обязательный.
• sort_by_num: Optional[bool], необязательный; значение None.
• sort_by_price: Optional[bool], необязательный; значение None.
• stars_only: Optional[bool], необязательный; значение None.

Результат

payments.ResaleStarGifts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetResaleStarGifts(gift_id=gift_id, limit=limit, offset=offset)

Описание Telegram

payments.GetSavedInfo

Аргументы

Нет.

Результат

payments.SavedInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetSavedInfo()

Описание Telegram

payments.GetSavedStarGift

Аргументы

• stargift: List[ForwardRef('TypeInputSavedStarGift')], обязательный.

Результат

payments.SavedStarGifts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetSavedStarGift(stargift=stargift)

Описание Telegram

payments.GetSavedStarGifts

Аргументы

• collection_id: Optional[int], необязательный; значение None.
• exclude_hosted: Optional[bool], необязательный; значение None.
• exclude_saved: Optional[bool], необязательный; значение None.
• exclude_unique: Optional[bool], необязательный; значение None.
• exclude_unlimited: Optional[bool], необязательный; значение None.
• exclude_unsaved: Optional[bool], необязательный; значение None.
• exclude_unupgradable: Optional[bool], необязательный; значение None.
• exclude_upgradable: Optional[bool], необязательный; значение None.
• limit: int, обязательный.
• offset: str, обязательный.
• peer: 'TypeInputPeer', обязательный.
• peer_color_available: Optional[bool], необязательный; значение None.
• sort_by_value: Optional[bool], необязательный; значение None.

Результат

payments.SavedStarGifts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetSavedStarGifts(limit=limit, offset=offset, peer=peer)

Описание Telegram

payments.GetStarGiftActiveAuctions

Аргументы

• hash: int, обязательный.

Результат

payments.StarGiftActiveAuctions, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftActiveAuctions(hash=hash)

Описание Telegram

payments.GetStarGiftAuctionAcquiredGifts

Аргументы

• gift_id: int, обязательный.

Результат

payments.StarGiftAuctionAcquiredGifts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftAuctionAcquiredGifts(gift_id=gift_id)

Описание Telegram

payments.GetStarGiftAuctionState

Аргументы

• auction: 'TypeInputStarGiftAuction', обязательный.
• version: int, обязательный.

Результат

payments.StarGiftAuctionState, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftAuctionState(auction=auction, version=version)

Описание Telegram

payments.GetStarGiftCollections

Аргументы

• hash: int, обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.StarGiftCollections, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftCollections(hash=hash, peer=peer)

Описание Telegram

payments.GetStarGiftUpgradeAttributes

Аргументы

• gift_id: int, обязательный.

Результат

payments.StarGiftUpgradeAttributes, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftUpgradeAttributes(gift_id=gift_id)

Описание Telegram

payments.GetStarGiftUpgradePreview

Аргументы

• gift_id: int, обязательный.

Результат

payments.StarGiftUpgradePreview, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftUpgradePreview(gift_id=gift_id)

Описание Telegram

payments.GetStarGiftWithdrawalUrl

Аргументы

• password: 'TypeInputCheckPasswordSRP', обязательный.
• stargift: 'TypeInputSavedStarGift', обязательный.

Результат

payments.StarGiftWithdrawalUrl, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGiftWithdrawalUrl(password=password, stargift=stargift)

Описание Telegram

payments.GetStarGifts

Аргументы

• hash: int, обязательный.

Результат

payments.StarGifts, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarGifts(hash=hash)

Описание Telegram

payments.GetStarsGiftOptions

Аргументы

• user_id: Optional[ForwardRef('TypeInputUser')], необязательный; значение None.

Результат

Vector<StarsGiftOption>, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsGiftOptions()

Описание Telegram

payments.GetStarsGiveawayOptions

Аргументы

Нет.

Результат

Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsGiveawayOptions()

Описание Telegram

payments.GetStarsRevenueAdsAccountUrl

Аргументы

• peer: 'TypeInputPeer', обязательный.

Результат

payments.StarsRevenueAdsAccountUrl, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsRevenueAdsAccountUrl(peer=peer)

Описание Telegram

payments.GetStarsRevenueStats

Аргументы

• dark: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.
• ton: Optional[bool], необязательный; значение None.

Результат

payments.StarsRevenueStats, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsRevenueStats(peer=peer)

Описание Telegram

payments.GetStarsRevenueWithdrawalUrl

Аргументы

• amount: Optional[int], необязательный; значение None.
• password: 'TypeInputCheckPasswordSRP', обязательный.
• peer: 'TypeInputPeer', обязательный.
• ton: Optional[bool], необязательный; значение None.

Результат

payments.StarsRevenueWithdrawalUrl, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsRevenueWithdrawalUrl(password=password, peer=peer)

Описание Telegram

payments.GetStarsStatus

Аргументы

• peer: 'TypeInputPeer', обязательный.
• ton: Optional[bool], необязательный; значение None.

Результат

payments.StarsStatus, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsStatus(peer=peer)

Описание Telegram

payments.GetStarsSubscriptions

Аргументы

• missing_balance: Optional[bool], необязательный; значение None.
• offset: str, обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.StarsStatus, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsSubscriptions(offset=offset, peer=peer)

Описание Telegram

payments.GetStarsTopupOptions

Аргументы

Нет.

Результат

Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsTopupOptions()

Описание Telegram

payments.GetStarsTransactions

Аргументы

• ascending: Optional[bool], необязательный; значение None.
• inbound: Optional[bool], необязательный; значение None.
• limit: int, обязательный.
• offset: str, обязательный.
• outbound: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.
• subscription_id: Optional[str], необязательный; значение None.
• ton: Optional[bool], необязательный; значение None.

Результат

payments.StarsStatus, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsTransactions(limit=limit, offset=offset, peer=peer)

Описание Telegram

payments.GetStarsTransactionsByID

Аргументы

• id: List[ForwardRef('TypeInputStarsTransaction')], обязательный.
• peer: 'TypeInputPeer', обязательный.
• ton: Optional[bool], необязательный; значение None.

Результат

payments.StarsStatus, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetStarsTransactionsByID(id=id, peer=peer)

Описание Telegram

payments.GetSuggestedStarRefBots

Аргументы

• limit: int, обязательный.
• offset: str, обязательный.
• order_by_date: Optional[bool], необязательный; значение None.
• order_by_revenue: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.

Результат

payments.SuggestedStarRefBots, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetSuggestedStarRefBots(limit=limit, offset=offset, peer=peer)

Описание Telegram

payments.GetUniqueStarGift

Аргументы

• slug: str, обязательный.

Результат

payments.UniqueStarGift, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetUniqueStarGift(slug=slug)

Описание Telegram

payments.GetUniqueStarGiftValueInfo

Аргументы

• slug: str, обязательный.

Результат

payments.UniqueStarGiftValueInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.GetUniqueStarGiftValueInfo(slug=slug)

Описание Telegram

payments.LaunchPrepaidGiveaway

Аргументы

• giveaway_id: int, обязательный.
• peer: 'TypeInputPeer', обязательный.
• purpose: 'TypeInputStorePaymentPurpose', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.LaunchPrepaidGiveaway(giveaway_id=giveaway_id, peer=peer, purpose=purpose)

Описание Telegram

payments.RefundStarsCharge

Аргументы

• charge_id: str, обязательный.
• user_id: 'TypeInputUser', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.RefundStarsCharge(charge_id=charge_id, user_id=user_id)

Описание Telegram

payments.ReorderStarGiftCollections

Аргументы

• order: List[int], обязательный.
• peer: 'TypeInputPeer', обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ReorderStarGiftCollections(order=order, peer=peer)

Описание Telegram

payments.ResolveStarGiftOffer

Аргументы

• decline: Optional[bool], необязательный; значение None.
• offer_msg_id: int, обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ResolveStarGiftOffer(offer_msg_id=offer_msg_id)

Описание Telegram

payments.SaveStarGift

Аргументы

• stargift: 'TypeInputSavedStarGift', обязательный.
• unsave: Optional[bool], необязательный; значение None.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.SaveStarGift(stargift=stargift)

Описание Telegram

payments.SendPaymentForm

Аргументы

• credentials: 'TypeInputPaymentCredentials', обязательный.
• form_id: int, обязательный.
• invoice: 'TypeInputInvoice', обязательный.
• requested_info_id: Optional[str], необязательный; значение None.
• shipping_option_id: Optional[str], необязательный; значение None.
• tip_amount: Optional[int], необязательный; значение None.

Результат

payments.PaymentResult, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.SendPaymentForm(credentials=credentials, form_id=form_id, invoice=invoice)

Описание Telegram

payments.SendStarGiftOffer

Аргументы

• allow_paid_stars: Optional[int], необязательный; значение None.
• duration: int, обязательный.
• peer: 'TypeInputPeer', обязательный.
• price: 'TypeStarsAmount', обязательный.
• random_id: int, необязательный; значение None.
• slug: str, обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.SendStarGiftOffer(duration=duration, peer=peer, price=price, slug=slug)

Описание Telegram

payments.SendStarsForm

Аргументы

• form_id: int, обязательный.
• invoice: 'TypeInputInvoice', обязательный.

Результат

payments.PaymentResult, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.SendStarsForm(form_id=form_id, invoice=invoice)

Описание Telegram

payments.TL

Аргументы

Нет.

Результат

Недоступный служебный тип, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.TL()

Описание Telegram

payments.ToggleChatStarGiftNotifications

Аргументы

• enabled: Optional[bool], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ToggleChatStarGiftNotifications(peer=peer)

Описание Telegram

payments.ToggleStarGiftsPinnedToTop

Аргументы

• peer: 'TypeInputPeer', обязательный.
• stargift: List[ForwardRef('TypeInputSavedStarGift')], обязательный.

Результат

Bool, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ToggleStarGiftsPinnedToTop(peer=peer, stargift=stargift)

Описание Telegram

payments.TransferStarGift

Аргументы

• stargift: 'TypeInputSavedStarGift', обязательный.
• to_id: 'TypeInputPeer', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.TransferStarGift(stargift=stargift, to_id=to_id)

Описание Telegram

payments.UpdateStarGiftCollection

Аргументы

• add_stargift: Optional[List[ForwardRef('TypeInputSavedStarGift')]], необязательный; значение None.
• collection_id: int, обязательный.
• delete_stargift: Optional[List[ForwardRef('TypeInputSavedStarGift')]], необязательный; значение None.
• order: Optional[List[ForwardRef('TypeInputSavedStarGift')]], необязательный; значение None.
• peer: 'TypeInputPeer', обязательный.
• title: Optional[str], необязательный; значение None.

Результат

StarGiftCollection, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.UpdateStarGiftCollection(collection_id=collection_id, peer=peer)

Описание Telegram

payments.UpdateStarGiftPrice

Аргументы

• resell_amount: 'TypeStarsAmount', обязательный.
• stargift: 'TypeInputSavedStarGift', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.UpdateStarGiftPrice(resell_amount=resell_amount, stargift=stargift)

Описание Telegram

payments.UpgradeStarGift

Аргументы

• keep_original_details: Optional[bool], необязательный; значение None.
• stargift: 'TypeInputSavedStarGift', обязательный.

Результат

Updates, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.UpgradeStarGift(stargift=stargift)

Описание Telegram

payments.ValidateRequestedInfo

Аргументы

• info: 'TypePaymentRequestedInfo', обязательный.
• invoice: 'TypeInputInvoice', обязательный.
• save: Optional[bool], необязательный; значение None.

Результат

payments.ValidatedRequestedInfo, сериализованный в JSON через TL.output(). Оболочки bytes/date описаны в каталоге.

Права

telegram.full; метод разрешён общим шлюзом при отсутствии непроверяемых ограничений.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.client.api.payments.ValidateRequestedInfo(info=info, invoice=invoice)

Описание Telegram