Тип данных OwnedGiftRegular

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

Описание

Описывает обычный подарок, принадлежащий пользователю или чату.

Поле Тип Описание
type String Тип подарка, всегда "regular"
gift Gift Информация об обычном подарке
owned_gift_id String Необязательное. Уникальный идентификатор подарка для бота; только для подарков, полученных от имени бизнес-аккаунтов
sender_user User Необязательное. Отправитель подарка, если это известный пользователь
send_date Integer Дата отправки подарка в формате Unix time
text String Необязательное. Текст сообщения, добавленного к подарку
entities Array of MessageEntity Необязательное. Специальные сущности, встречающиеся в тексте
is_private True Необязательное. True, если отправитель и текст подарка показываются только получателю; в противном случае их смогут увидеть все
is_saved True Необязательное. True, если подарок отображается на странице профиля аккаунта; только для подарков, полученных от имени бизнес-аккаунтов
can_be_upgraded True Необязательное. True, если подарок можно улучшить до уникального подарка; только для подарков, полученных от имени бизнес-аккаунтов
was_refunded True Необязательное. True, если подарок был возвращён и больше недоступен
convert_star_count Integer Необязательное. Количество Telegram Stars, которые получатель может получить вместо подарка; отсутствует, если подарок нельзя конвертировать в Telegram Stars
prepaid_upgrade_star_count Integer Необязательное. Количество Telegram Stars, оплаченных отправителем за возможность улучшить подарок

Примеры

json

{
  "type": "regular",
  "gift": {
    "id": "gift_123456789",
    "title": "Premium Coffee",
    "description": "A delicious cup of premium coffee",
    "photo": [
      {
        "file_id": "AgACAgUAAxkBAAIB",
        "file_unique_id": "AQADBAADT6o5Uw",
        "width": 640,
        "height": 640,
        "file_size": 12345
      }
    ],
    "star_count": 100
  },
  "owned_gift_id": "owned_gift_987654321",
  "sender_user": {
    "id": 123456789,
    "is_bot": false,
    "first_name": "John",
    "last_name": "Doe",
    "username": "johndoe"
  },
  "send_date": 1698765432,
  "text": "Enjoy your coffee! ☕",
  "entities": [
    {
      "type": "bold",
      "offset": 0,
      "length": 4
    }
  ],
  "is_private": true,
  "is_saved": false,
  "can_be_upgraded": true,
  "was_refunded": false,
  "convert_star_count": 80,
  "prepaid_upgrade_star_count": 20
}

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

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

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

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