Тип данных GiftInfo

Объект описывает служебное сообщение о регулярном подарке в Telegram, включая его свойства, возможность улучшения и конвертации в звёзды.

Описание

Описывает служебное сообщение о регулярном подарке, который был отправлен или получен.

Поле Тип Описание
gift Gift Информация о подарке
owned_gift_id String Необязательное. Уникальный идентификатор полученного подарка для бота; присутствует только для подарков, полученных от имени бизнес-аккаунтов
convert_star_count Integer Необязательное. Количество Telegram Stars, которые получатель может получить путём конвертации подарка; отсутствует, если конвертация в Telegram Stars невозможна
prepaid_upgrade_star_count Integer Необязательное. Количество Telegram Stars, предоплаченных отправителем для возможности улучшения подарка
can_be_upgraded True Необязательное. True, если подарок можно улучшить до уникального подарка
text String Необязательное. Текст сообщения, добавленного к подарку
entities Массив MessageEntity Необязательное. Специальные сущности, встречающиеся в тексте
is_private True Необязательное. True, если отправитель и текст подарка показываются только получателю подарка; в противном случае их смогут увидеть все

Примеры

json

{
  "gift": {
    "id": "gift_123456789",
    "title": "Premium Subscription",
    "description": "1 month of Telegram Premium",
    "photo": {
      "small_file_id": "AQADBAUAA1kfQwAE",
      "small_file_unique_id": "AQADBAUAA1kfQwAB",
      "big_file_id": "AQADBAUAA1kfQwAC",
      "big_file_unique_id": "AQADBAUAA1kfQwAD"
    }
  },
  "owned_gift_id": "owned_gift_987654321",
  "convert_star_count": 500,
  "prepaid_upgrade_star_count": 100,
  "can_be_upgraded": true,
  "text": "Happy Birthday! 🎁",
  "entities": [
    {
      "type": "bold",
      "offset": 0,
      "length": 14
    }
  ],
  "is_private": false
}

История изменений

  • API 9.0. Добавлен объект GiftInfo
  • API 9.3. Обновлен объект GiftInfo: Добавлено поле is_upgrade_separate. Добавлено поле unique_gift_number.

Дополнительно

  • Gift - Объект представляет виртуальный подарок в виде стикера, который можно отправить через бота, используя Telegram Stars.
  • MessageEntity - Объект MessageEntity представляет специальную форматированную сущность в тексте сообщения, такую как упоминания, хэштеги, ссылки или стилизованный текст.
Комментарии