telegramium.bots

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

Value parameters

duration: Duration of the video in seconds as defined by sender
fileId: Identifier for this file, which can be used to download or reuse the file
fileName: Optional. Original animation filename as defined by sender
fileSize: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
height: Video height as defined by sender
mimeType: Optional. MIME type of the file as defined by sender
thumbnail: Optional. Animation thumbnail as defined by sender
width: Video width as defined by sender

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents an audio file to be treated as music by the Telegram clients.

Value parameters

duration: Duration of the audio in seconds as defined by sender
fileId: Identifier for this file, which can be used to download or reuse the file
fileName: Optional. Original filename as defined by sender
fileSize: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
mimeType: Optional. MIME type of the file as defined by sender
performer: Optional. Performer of the audio as defined by sender or by audio tags
thumbnail: Optional. Thumbnail of the album cover to which the music file belongs
title: Optional. Title of the audio as defined by sender or by audio tags

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

day: Day of the user's birth; 1-31
month: Month of the user's birth; 1-12
year: Optional. Year of the user's birth

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

blockquote

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

bold

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents a bot command.

Value parameters

command: Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.
description: Description of the command; 1-256 characters.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

bot_command

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object BotCommandScopeAllChatAdministrators

object BotCommandScopeAllGroupChats

object BotCommandScopeAllPrivateChats

class BotCommandScopeChat

class BotCommandScopeChatAdministrators

class BotCommandScopeChatMember

object BotCommandScopeDefault
Show all

Represents the scope of bot commands, covering all group and supergroup chat administrators.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all
Self type: BotCommandScopeAllChatAdministrators.type

Represents the scope of bot commands, covering all group and supergroup chats.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all
Self type: BotCommandScopeAllGroupChats.type

Represents the scope of bot commands, covering all private chats.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all
Self type: BotCommandScopeAllPrivateChats.type

Represents the scope of bot commands, covering a specific chat.

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
userId: Unique identifier of the target user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait BotCommandScope

class Object

trait Matchable

class Any
Show all
Self type: BotCommandScopeDefault.type

This object represents the bot's description.

Value parameters

description: The bot's description

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents the bot's name.

Value parameters

name: The bot's name

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents the bot's short description.

Value parameters

shortDescription: The bot's short description

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes the connection of the bot with a business account.

Value parameters

canReply: True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours
date: Date the connection was established in Unix time
id: Unique identifier of the business connection
isEnabled: True, if the connection is active
user: Business account user that created the business connection
userChatId: Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

message: Optional. Message text of the business intro
sticker: Optional. Sticker of the business intro
title: Optional. Title text of the business intro

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

address: Address of the business
location: Optional. Location of the business

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object is received when messages are deleted from a connected business account.

Value parameters

businessConnectionId: Unique identifier of the business connection
chat: Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.
messageIds: A JSON-serialized list of identifiers of deleted messages in the chat of the business account

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

openingHours: List of time intervals describing business opening hours
timeZoneName: Unique name of the time zone for which the opening hours are defined

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

closingMinute: The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 24 60
openingMinute: The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 24 60

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A placeholder, currently holds no information. Use BotFather to set up your game.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: CallbackGame.type

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

Value parameters

chatInstance: Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
data: Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.
from: Sender
gameShortName: Optional. Short name of a Game to be returned, serves as the unique identifier for the game
id: Unique identifier for this query
inlineMessageId: Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
message: Optional. Message sent by the bot with the callback button that originated the query

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

cashtag

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

final case class Chat(id: Long, `type`: String, title: Option[String], username: Option[String], firstName: Option[String], lastName: Option[String], isForum: Option[Boolean], photo: Option[ChatPhoto], activeUsernames: List[String], birthdate: Option[Birthdate], businessIntro: Option[BusinessIntro], businessLocation: Option[BusinessLocation], businessOpeningHours: Option[BusinessOpeningHours], personalChat: Option[Chat], availableReactions: List[ReactionType], accentColorId: Option[Int], backgroundCustomEmojiId: Option[String], profileAccentColorId: Option[Int], profileBackgroundCustomEmojiId: Option[String], emojiStatusCustomEmojiId: Option[String], emojiStatusExpirationDate: Option[Int], bio: Option[String], hasPrivateForwards: Option[Boolean], hasRestrictedVoiceAndVideoMessages: Option[Boolean], joinToSendMessages: Option[Boolean], joinByRequest: Option[Boolean], description: Option[String], inviteLink: Option[String], pinnedMessage: Option[Message], permissions: Option[ChatPermissions], slowModeDelay: Option[Int], unrestrictBoostCount: Option[Int], messageAutoDeleteTime: Option[Int], hasAggressiveAntiSpamEnabled: Option[Boolean], hasHiddenMembers: Option[Boolean], hasProtectedContent: Option[Boolean], hasVisibleHistory: Option[Boolean], stickerSetName: Option[String], canSetStickerSet: Option[Boolean], customEmojiStickerSetName: Option[String], linkedChatId: Option[Long], location: Option[ChatLocation])

This object represents a chat.

Value parameters

accentColorId: Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.
activeUsernames: Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.
availableReactions: Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat.
backgroundCustomEmojiId: Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.
bio: Optional. Bio of the other party in a private chat. Returned only in getChat.
birthdate: Optional. For private chats, the date of birth of the user. Returned only in getChat.
businessIntro: Optional. For private chats with business accounts, the intro of the business. Returned only in getChat.
businessLocation: Optional. For private chats with business accounts, the location of the business. Returned only in getChat.
businessOpeningHours: Optional. For private chats with business accounts, the opening hours of the business. Returned only in getChat.
canSetStickerSet: Optional. True, if the bot can change the group sticker set. Returned only in getChat.
customEmojiStickerSetName: Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat.
description: Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.
emojiStatusCustomEmojiId: Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat.
emojiStatusExpirationDate: Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in getChat.
firstName: Optional. First name of the other party in a private chat
hasAggressiveAntiSpamEnabled: Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.
hasHiddenMembers: Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.
hasPrivateForwards: Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.
hasProtectedContent: Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.
hasRestrictedVoiceAndVideoMessages: Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.
hasVisibleHistory: Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.
id: Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
inviteLink: Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.
isForum: Optional. True, if the supergroup chat is a forum (has topics enabled)
joinByRequest: Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.
joinToSendMessages: Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.
lastName: Optional. Last name of the other party in a private chat
linkedChatId: Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.
location: Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.
messageAutoDeleteTime: Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.
permissions: Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.
personalChat: Optional. For private chats, the personal channel of the user. Returned only in getChat.
photo: Optional. Chat photo. Returned only in getChat.
pinnedMessage: Optional. The most recent pinned message (by sending date). Returned only in getChat.
profileAccentColorId: Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.
profileBackgroundCustomEmojiId: Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.
slowModeDelay: Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat.
stickerSetName: Optional. For supergroups, name of group sticker set. Returned only in getChat.
title: Optional. Title, for supergroups, channels and group chats
type: Type of chat, can be either “private”, “group”, “supergroup” or “channel”
unrestrictBoostCount: Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.
username: Optional. Username, for private chats, supergroups and channels if available

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class ChatAdministratorRights(isAnonymous: Boolean, canManageChat: Boolean, canDeleteMessages: Boolean, canManageVideoChats: Boolean, canRestrictMembers: Boolean, canPromoteMembers: Boolean, canChangeInfo: Boolean, canInviteUsers: Boolean, canPostStories: Boolean, canEditStories: Boolean, canDeleteStories: Boolean, canPostMessages: Option[Boolean], canEditMessages: Option[Boolean], canPinMessages: Option[Boolean], canManageTopics: Option[Boolean])

Represents the rights of an administrator in a chat.

Value parameters

canChangeInfo: True, if the user is allowed to change the chat title, photo and other settings
canDeleteMessages: True, if the administrator can delete messages of other users
canDeleteStories: True, if the administrator can delete stories posted by other users
canEditMessages: Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
canEditStories: True, if the administrator can edit stories posted by other users
canInviteUsers: True, if the user is allowed to invite new users to the chat
canManageChat: True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.
canManageTopics: Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
canManageVideoChats: True, if the administrator can manage video chats
canPinMessages: Optional. True, if the user is allowed to pin messages; for groups and supergroups only
canPostMessages: Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only
canPostStories: True, if the administrator can post stories to the chat
canPromoteMembers: True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
canRestrictMembers: True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
isAnonymous: True, if the user's presence in the chat is hidden

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about a chat boost.

Value parameters

addDate: Point in time (Unix timestamp) when the chat was boosted
boostId: Unique identifier of the boost
expirationDate: Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
source: Source of the added boost

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a user boosting a chat.

Value parameters

boostCount: Number of boosts added by the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a boost removed from a chat.

Value parameters

boostId: Unique identifier of the boost
chat: Chat which was boosted
removeDate: Point in time (Unix timestamp) when the boost was removed
source: Source of the removed boost

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ChatBoostSourceGiftCode

class ChatBoostSourceGiveaway

class ChatBoostSourcePremium

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

Value parameters

user: User for which the gift code was created

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatBoostSource

class Object

trait Matchable

class Any
Show all

The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

Value parameters

giveawayMessageId: Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.
isUnclaimed: Optional. True, if the giveaway was completed, but there was no user to win the prize
user: Optional. User that won the prize in the giveaway if any

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatBoostSource

class Object

trait Matchable

class Any
Show all

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

Value parameters

user: User that boosted the chat

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatBoostSource

class Object

trait Matchable

class Any
Show all

This object represents a boost added to a chat or changed.

Value parameters

boost: Information about the chat boost
chat: Chat which was boosted

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ChatIntId

class ChatStrId

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatId

class Object

trait Matchable

class Any
Show all

Represents an invite link for a chat.

Value parameters

createsJoinRequest: True, if users joining the chat via the link need to be approved by chat administrators
creator: Creator of the link
expireDate: Optional. Point in time (Unix timestamp) when the link will expire or has been expired
inviteLink: The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
isPrimary: True, if the link is primary
isRevoked: True, if the link is revoked
memberLimit: Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
name: Optional. Invite link name
pendingJoinRequestCount: Optional. Number of pending join requests created using this link

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a join request sent to a chat.

Value parameters

bio: Optional. Bio of the user.
chat: Chat to which the request was sent
date: Date the request was sent in Unix time
from: User that sent the join request
inviteLink: Optional. Chat invite link that was used by the user to send the join request
userChatId: Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a location to which a chat is connected.

Value parameters

address: Location address; 1-64 characters, as defined by the chat owner
location: The location to which the supergroup is connected. Can't be a live location.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ChatMemberAdministrator

class ChatMemberBanned

class ChatMemberLeft

class ChatMemberMember

class ChatMemberOwner

class ChatMemberRestricted
Show all

final case class ChatMemberAdministrator(user: User, canBeEdited: Boolean, isAnonymous: Boolean, canManageChat: Boolean, canDeleteMessages: Boolean, canManageVideoChats: Boolean, canRestrictMembers: Boolean, canPromoteMembers: Boolean, canChangeInfo: Boolean, canInviteUsers: Boolean, canPostStories: Boolean, canEditStories: Boolean, canDeleteStories: Boolean, canPostMessages: Option[Boolean], canEditMessages: Option[Boolean], canPinMessages: Option[Boolean], canManageTopics: Option[Boolean], customTitle: Option[String]) extends ChatMember

Represents a chat member that has some additional privileges.

Value parameters

canBeEdited: True, if the bot is allowed to edit administrator privileges of that user
canChangeInfo: True, if the user is allowed to change the chat title, photo and other settings
canDeleteMessages: True, if the administrator can delete messages of other users
canDeleteStories: True, if the administrator can delete stories posted by other users
canEditMessages: Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
canEditStories: True, if the administrator can edit stories posted by other users
canInviteUsers: True, if the user is allowed to invite new users to the chat
canManageChat: True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.
canManageTopics: Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
canManageVideoChats: True, if the administrator can manage video chats
canPinMessages: Optional. True, if the user is allowed to pin messages; for groups and supergroups only
canPostMessages: Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only
canPostStories: True, if the administrator can post stories to the chat
canPromoteMembers: True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
canRestrictMembers: True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
customTitle: Optional. Custom title for this user
isAnonymous: True, if the user's presence in the chat is hidden
user: Information about the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatMember

class Object

trait Matchable

class Any
Show all

Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.

Value parameters

untilDate: Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever
user: Information about the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatMember

class Object

trait Matchable

class Any
Show all

Represents a chat member that isn't currently a member of the chat, but may join it themselves.

Value parameters

user: Information about the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatMember

class Object

trait Matchable

class Any
Show all

Represents a chat member that has no additional privileges or restrictions.

Value parameters

user: Information about the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatMember

class Object

trait Matchable

class Any
Show all

Represents a chat member that owns the chat and has all administrator privileges.

Value parameters

customTitle: Optional. Custom title for this user
isAnonymous: True, if the user's presence in the chat is hidden
user: Information about the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatMember

class Object

trait Matchable

class Any
Show all

final case class ChatMemberRestricted(user: User, isMember: Boolean, canSendMessages: Boolean, canSendAudios: Boolean, canSendDocuments: Boolean, canSendPhotos: Boolean, canSendVideos: Boolean, canSendVideoNotes: Boolean, canSendVoiceNotes: Boolean, canSendPolls: Boolean, canSendOtherMessages: Boolean, canAddWebPagePreviews: Boolean, canChangeInfo: Boolean, canInviteUsers: Boolean, canPinMessages: Boolean, canManageTopics: Boolean, untilDate: Int) extends ChatMember

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

Value parameters

canAddWebPagePreviews: True, if the user is allowed to add web page previews to their messages
canChangeInfo: True, if the user is allowed to change the chat title, photo and other settings
canInviteUsers: True, if the user is allowed to invite new users to the chat
canManageTopics: True, if the user is allowed to create forum topics
canPinMessages: True, if the user is allowed to pin messages
canSendAudios: True, if the user is allowed to send audios
canSendDocuments: True, if the user is allowed to send documents
canSendMessages: True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
canSendOtherMessages: True, if the user is allowed to send animations, games, stickers and use inline bots
canSendPhotos: True, if the user is allowed to send photos
canSendPolls: True, if the user is allowed to send polls
canSendVideoNotes: True, if the user is allowed to send video notes
canSendVideos: True, if the user is allowed to send videos
canSendVoiceNotes: True, if the user is allowed to send voice notes
isMember: True, if the user is a member of the chat at the moment of the request
untilDate: Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever
user: Information about the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatMember

class Object

trait Matchable

class Any
Show all

This object represents changes in the status of a chat member.

Value parameters

chat: Chat the user belongs to
date: Date the change was done in Unix time
from: Performer of the action, which resulted in the change
inviteLink: Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.
newChatMember: New information about the chat member
oldChatMember: Previous information about the chat member
viaChatFolderInviteLink: Optional. True, if the user joined the chat via a chat folder invite link

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class ChatPermissions(canSendMessages: Option[Boolean], canSendAudios: Option[Boolean], canSendDocuments: Option[Boolean], canSendPhotos: Option[Boolean], canSendVideos: Option[Boolean], canSendVideoNotes: Option[Boolean], canSendVoiceNotes: Option[Boolean], canSendPolls: Option[Boolean], canSendOtherMessages: Option[Boolean], canAddWebPagePreviews: Option[Boolean], canChangeInfo: Option[Boolean], canInviteUsers: Option[Boolean], canPinMessages: Option[Boolean], canManageTopics: Option[Boolean])

Describes actions that a non-administrator user is allowed to take in a chat.

Value parameters

canAddWebPagePreviews: Optional. True, if the user is allowed to add web page previews to their messages
canChangeInfo: Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups
canInviteUsers: Optional. True, if the user is allowed to invite new users to the chat
canManageTopics: Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages
canPinMessages: Optional. True, if the user is allowed to pin messages. Ignored in public supergroups
canSendAudios: Optional. True, if the user is allowed to send audios
canSendDocuments: Optional. True, if the user is allowed to send documents
canSendMessages: Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
canSendOtherMessages: Optional. True, if the user is allowed to send animations, games, stickers and use inline bots
canSendPhotos: Optional. True, if the user is allowed to send photos
canSendPolls: Optional. True, if the user is allowed to send polls
canSendVideoNotes: Optional. True, if the user is allowed to send video notes
canSendVideos: Optional. True, if the user is allowed to send videos
canSendVoiceNotes: Optional. True, if the user is allowed to send voice notes

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a chat photo.

Value parameters

bigFileId: File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
bigFileUniqueId: Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
smallFileId: File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
smallFileUniqueId: Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.

Value parameters

chatId: Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.
photo: Optional. Available sizes of the chat photo, if the photo was requested by the bot
requestId: Identifier of the request
title: Optional. Title of the chat, if the title was requested by the bot.
username: Optional. Username of the chat, if the username was requested by the bot and available.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ChatId

class Object

trait Matchable

class Any
Show all

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

Value parameters

from: The user that chose the result
inlineMessageId: Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.
location: Optional. Sender location, only for bots that require user location
query: The query that was used to obtain the result
resultId: The unique identifier for the result that was chosen

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: CirceImplicits.type

code

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents a phone contact.

Value parameters

firstName: Contact's first name
lastName: Optional. Contact's last name
phoneNumber: Contact's phone number
userId: Optional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
vcard: Optional. Additional data about the contact in the form of a vCard

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

custom_emoji

Value parameters

customEmojiId: unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker
length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents an animated emoji that displays a random value.

Value parameters

emoji: Emoji on which the dice throw animation is based
value: Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a general file (as opposed to photos, voice messages and audio files).

Value parameters

fileId: Identifier for this file, which can be used to download or reuse the file
fileName: Optional. Original filename as defined by sender
fileSize: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
mimeType: Optional. MIME type of the file as defined by sender
thumbnail: Optional. Document thumbnail as defined by sender

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

email

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object EmojiBasketball

object EmojiBowling

object EmojiDarts

object EmojiDice

object EmojiFootball

object EmojiSlotMachine
Show all

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait Emoji

class Object

trait Matchable

class Any
Show all
Self type: EmojiBasketball.type

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait Emoji

class Object

trait Matchable

class Any
Show all
Self type: EmojiBowling.type

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait Emoji

class Object

trait Matchable

class Any
Show all
Self type: EmojiDarts.type

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait Emoji

class Object

trait Matchable

class Any
Show all
Self type: EmojiDice.type

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait Emoji

class Object

trait Matchable

class Any
Show all
Self type: EmojiFootball.type

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait Emoji

class Object

trait Matchable

class Any
Show all
Self type: EmojiSlotMachine.type

Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

Value parameters

data: Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication
hash: Base64-encoded data hash for data authentication
secret: Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes documents or other Telegram Passport elements shared with the bot by the user.

Value parameters

data: Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.
email: Optional. User's verified email address; available only for “email” type
files: Optional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
frontSide: Optional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
hash: Base64-encoded element hash for using in PassportElementErrorUnspecified
phoneNumber: Optional. User's verified phone number; available only for “phone_number” type
reverseSide: Optional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
selfie: Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
translation: Optional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
type: Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class ExternalReplyInfo(origin: MessageOrigin, chat: Option[Chat], messageId: Option[Int], linkPreviewOptions: Option[LinkPreviewOptions], animation: Option[Animation], audio: Option[Audio], document: Option[Document], photo: List[PhotoSize], sticker: Option[Sticker], story: Option[Story], video: Option[Video], videoNote: Option[VideoNote], voice: Option[Voice], hasMediaSpoiler: Option[Boolean], contact: Option[Contact], dice: Option[Dice], game: Option[Game], giveaway: Option[Giveaway], giveawayWinners: Option[GiveawayWinners], invoice: Option[Invoice], location: Option[Location], poll: Option[Poll], venue: Option[Venue])

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

Value parameters

animation: Optional. Message is an animation, information about the animation
audio: Optional. Message is an audio file, information about the file
chat: Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.
contact: Optional. Message is a shared contact, information about the contact
dice: Optional. Message is a dice with random value
document: Optional. Message is a general file, information about the file
game: Optional. Message is a game, information about the game.
giveaway: Optional. Message is a scheduled giveaway, information about the giveaway
giveawayWinners: Optional. A giveaway with public winners was completed
hasMediaSpoiler: Optional. True, if the message media is covered by a spoiler animation
invoice: Optional. Message is an invoice for a payment, information about the invoice.
linkPreviewOptions: Optional. Options used for link preview generation for the original message, if it is a text message
location: Optional. Message is a shared location, information about the location
messageId: Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.
origin: Origin of the message replied to by the given message
photo: Optional. Message is a photo, available sizes of the photo
poll: Optional. Message is a native poll, information about the poll
sticker: Optional. Message is a sticker, information about the sticker
story: Optional. Message is a forwarded story
venue: Optional. Message is a venue, information about the venue
video: Optional. Message is a video, information about the video
videoNote: Optional. Message is a video note, information about the video message
voice: Optional. Message is a voice message, information about the file

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot /<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.

Value parameters

fileId: Identifier for this file, which can be used to download or reuse the file
filePath: Optional. File path. Use https://api.telegram.org/file/bot /<file_path> to get the file.
fileSize: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

Value parameters

forceReply: Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
inputFieldPlaceholder: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters
selective: Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait KeyboardMarkup

class Object

trait Matchable

class Any
Show all

This object represents a forum topic.

Value parameters

iconColor: Color of the topic icon in RGB format
iconCustomEmojiId: Optional. Unique identifier of the custom emoji shown as the topic icon
messageThreadId: Unique identifier of the forum topic
name: Name of the topic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: ForumTopicClosed.type

This object represents a service message about a new forum topic created in the chat.

Value parameters

iconColor: Color of the topic icon in RGB format
iconCustomEmojiId: Optional. Unique identifier of the custom emoji shown as the topic icon
name: Name of the topic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about an edited forum topic.

Value parameters

iconCustomEmojiId: Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed
name: Optional. New name of the topic, if it was edited

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: ForumTopicReopened.type

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

Value parameters

animation: Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
description: Description of the game
photo: Photo that will be displayed in the game message in chats.
text: Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
textEntities: Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
title: Title of the game

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents one row of the high scores table for a game.

Value parameters

position: Position in high score table for the game
score: Score
user: User

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: GeneralForumTopicHidden.type

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: GeneralForumTopicUnhidden.type

This object represents a message about a scheduled giveaway.

Value parameters

chats: The list of chats which the user must join to participate in the giveaway
countryCodes: Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.
hasPublicWinners: Optional. True, if the list of giveaway winners will be visible to everyone
onlyNewMembers: Optional. True, if only users who join the chats after the giveaway started should be eligible to win
premiumSubscriptionMonthCount: Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for
prizeDescription: Optional. Description of additional giveaway prize
winnerCount: The number of users which are supposed to be selected as winners of the giveaway
winnersSelectionDate: Point in time (Unix timestamp) when winners of the giveaway will be selected

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about the completion of a giveaway without public winners.

Value parameters

giveawayMessage: Optional. Message with the giveaway that was completed, if it wasn't deleted
unclaimedPrizeCount: Optional. Number of undistributed prizes
winnerCount: Number of winners in the giveaway

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: GiveawayCreated.type

This object represents a message about the completion of a giveaway with public winners.

Value parameters

additionalChatCount: Optional. The number of other chats the user had to join in order to be eligible for the giveaway
chat: The chat that created the giveaway
giveawayMessageId: Identifier of the message with the giveaway in the chat
onlyNewMembers: Optional. True, if only users who had joined the chats after the giveaway started were eligible to win
premiumSubscriptionMonthCount: Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for
prizeDescription: Optional. Description of additional giveaway prize
unclaimedPrizeCount: Optional. Number of undistributed prizes
wasRefunded: Optional. True, if the giveaway was canceled because the payment for it was refunded
winnerCount: Total number of winners in the giveaway
winners: List of up to 100 winners of the giveaway
winnersSelectionDate: Point in time (Unix timestamp) when winners of the giveaway were selected

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

hashtag

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait ParseMode

class Object

trait Matchable

class Any
Show all
Self type: Html.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class InputLinkFile

class InputPartFile

This object describes a message that was deleted or is otherwise inaccessible to the bot.

Value parameters

chat: Chat the message belonged to
date: Always 0. The field can be used to differentiate regular and inaccessible messages.
messageId: Unique message identifier inside the chat

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MaybeInaccessibleMessage

class Object

trait Matchable

class Any
Show all

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

Value parameters

callbackData: Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes
callbackGame: Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row.
loginUrl: Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
pay: Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
switchInlineQuery: Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.
switchInlineQueryChosenChat: Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field
switchInlineQueryCurrentChat: Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.
text: Label text on the button
url: Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.
webApp: Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents an inline keyboard that appears right next to the message it belongs to.

Value parameters

inlineKeyboard: Array of button rows, each represented by an Array of InlineKeyboardButton objects

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait KeyboardMarkup

class Object

trait Matchable

class Any
Show all

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

Value parameters

chatType: Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat
from: Sender
id: Unique identifier for this query
location: Optional. Sender location, only for bots that request user location
offset: Offset of the results to be returned, can be controlled by the bot
query: Text of the query (up to 256 characters)

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class InlineQueryResultArticle

class InlineQueryResultAudio

class InlineQueryResultCachedAudio

class InlineQueryResultCachedDocument

class InlineQueryResultCachedGif

class InlineQueryResultCachedMpeg4Gif

class InlineQueryResultCachedPhoto

class InlineQueryResultCachedSticker

class InlineQueryResultCachedVideo

class InlineQueryResultCachedVoice

class InlineQueryResultContact

class InlineQueryResultDocument

class InlineQueryResultGame

class InlineQueryResultGif

class InlineQueryResultLocation

class InlineQueryResultMpeg4Gif

class InlineQueryResultPhoto

class InlineQueryResultVenue

class InlineQueryResultVideo

class InlineQueryResultVoice
Show all

Represents a link to an article or web page.

Value parameters

description: Optional. Short description of the result
hideUrl: Optional. Pass True if you don't want the URL to be shown in the message
id: Unique identifier for this result, 1-64 Bytes
inputMessageContent: Content of the message to be sent
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailHeight: Optional. Thumbnail height
thumbnailUrl: Optional. Url of the thumbnail for the result
thumbnailWidth: Optional. Thumbnail width
title: Title of the result
url: Optional. URL of the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

Value parameters

audioDuration: Optional. Audio duration in seconds
audioUrl: A valid URL for the audio file
caption: Optional. Caption, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the audio
parseMode: Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
performer: Optional. Performer
replyMarkup: Optional. Inline keyboard attached to the message
title: Title

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

Value parameters

audioFileId: A valid file identifier for the audio file
caption: Optional. Caption, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the audio
parseMode: Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

Value parameters

caption: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
description: Optional. Short description of the result
documentFileId: A valid file identifier for the file
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the file
parseMode: Optional. Mode for parsing entities in the document caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
title: Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

Value parameters

caption: Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
gifFileId: A valid file identifier for the GIF file
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the GIF animation
parseMode: Optional. Mode for parsing entities in the caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
title: Optional. Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

Value parameters

caption: Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the video animation
mpeg4FileId: A valid file identifier for the MPEG4 file
parseMode: Optional. Mode for parsing entities in the caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
title: Optional. Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

Value parameters

caption: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
description: Optional. Short description of the result
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the photo
parseMode: Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
photoFileId: A valid file identifier of the photo
replyMarkup: Optional. Inline keyboard attached to the message
title: Optional. Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

Value parameters

id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the sticker
replyMarkup: Optional. Inline keyboard attached to the message
stickerFileId: A valid file identifier of the sticker

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

Value parameters

caption: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
description: Optional. Short description of the result
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the video
parseMode: Optional. Mode for parsing entities in the video caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
title: Title for the result
videoFileId: A valid file identifier for the video file

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

Value parameters

caption: Optional. Caption, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the voice message
parseMode: Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
title: Voice message title
voiceFileId: A valid file identifier for the voice message

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

Value parameters

firstName: Contact's first name
id: Unique identifier for this result, 1-64 Bytes
inputMessageContent: Optional. Content of the message to be sent instead of the contact
lastName: Optional. Contact's last name
phoneNumber: Contact's phone number
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailHeight: Optional. Thumbnail height
thumbnailUrl: Optional. Url of the thumbnail for the result
thumbnailWidth: Optional. Thumbnail width
vcard: Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

Value parameters

caption: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
description: Optional. Short description of the result
documentUrl: A valid URL for the file
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the file
mimeType: MIME type of the content of the file, either “application/pdf” or “application/zip”
parseMode: Optional. Mode for parsing entities in the document caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailHeight: Optional. Thumbnail height
thumbnailUrl: Optional. URL of the thumbnail (JPEG only) for the file
thumbnailWidth: Optional. Thumbnail width
title: Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a Game.

Value parameters

gameShortName: Short name of the game
id: Unique identifier for this result, 1-64 bytes
replyMarkup: Optional. Inline keyboard attached to the message

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

Value parameters

caption: Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
gifDuration: Optional. Duration of the GIF in seconds
gifHeight: Optional. Height of the GIF
gifUrl: A valid URL for the GIF file. File size must not exceed 1MB
gifWidth: Optional. Width of the GIF
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the GIF animation
parseMode: Optional. Mode for parsing entities in the caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailMimeType: Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
thumbnailUrl: URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
title: Optional. Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

Value parameters

heading: Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
horizontalAccuracy: Optional. The radius of uncertainty for the location, measured in meters; 0-1500
id: Unique identifier for this result, 1-64 Bytes
inputMessageContent: Optional. Content of the message to be sent instead of the location
latitude: Location latitude in degrees
livePeriod: Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.
longitude: Location longitude in degrees
proximityAlertRadius: Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailHeight: Optional. Thumbnail height
thumbnailUrl: Optional. Url of the thumbnail for the result
thumbnailWidth: Optional. Thumbnail width
title: Location title

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

Value parameters

caption: Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the video animation
mpeg4Duration: Optional. Video duration in seconds
mpeg4Height: Optional. Video height
mpeg4Url: A valid URL for the MPEG4 file. File size must not exceed 1MB
mpeg4Width: Optional. Video width
parseMode: Optional. Mode for parsing entities in the caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailMimeType: Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
thumbnailUrl: URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
title: Optional. Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

Value parameters

caption: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
description: Optional. Short description of the result
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the photo
parseMode: Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
photoHeight: Optional. Height of the photo
photoUrl: A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB
photoWidth: Optional. Width of the photo
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailUrl: URL of the thumbnail for the photo
title: Optional. Title for the result

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

final case class InlineQueryResultVenue(id: String, latitude: Float, longitude: Float, title: String, address: String, foursquareId: Option[String], foursquareType: Option[String], googlePlaceId: Option[String], googlePlaceType: Option[String], replyMarkup: Option[InlineKeyboardMarkup], inputMessageContent: Option[InputMessageContent], thumbnailUrl: Option[String], thumbnailWidth: Option[Int], thumbnailHeight: Option[Int]) extends InlineQueryResult

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

Value parameters

address: Address of the venue
foursquareId: Optional. Foursquare identifier of the venue if known
foursquareType: Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
googlePlaceId: Optional. Google Places identifier of the venue
googlePlaceType: Optional. Google Places type of the venue. (See supported types.)
id: Unique identifier for this result, 1-64 Bytes
inputMessageContent: Optional. Content of the message to be sent instead of the venue
latitude: Latitude of the venue location in degrees
longitude: Longitude of the venue location in degrees
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailHeight: Optional. Thumbnail height
thumbnailUrl: Optional. Url of the thumbnail for the result
thumbnailWidth: Optional. Thumbnail width
title: Title of the venue

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

Value parameters

caption: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
description: Optional. Short description of the result
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
mimeType: MIME type of the content of the video URL, “text/html” or “video/mp4”
parseMode: Optional. Mode for parsing entities in the video caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
thumbnailUrl: URL of the thumbnail (JPEG only) for the video
title: Title for the result
videoDuration: Optional. Video duration in seconds
videoHeight: Optional. Video height
videoUrl: A valid URL for the embedded video player or video file
videoWidth: Optional. Video width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

Value parameters

caption: Optional. Caption, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
id: Unique identifier for this result, 1-64 bytes
inputMessageContent: Optional. Content of the message to be sent instead of the voice recording
parseMode: Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
replyMarkup: Optional. Inline keyboard attached to the message
title: Recording title
voiceDuration: Optional. Recording duration in seconds
voiceUrl: A valid URL for the voice recording

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InlineQueryResult

class Object

trait Matchable

class Any
Show all

This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

Value parameters

startParameter: Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.
text: Label text on the button
webApp: Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents the content of a contact message to be sent as the result of an inline query.

Value parameters

firstName: Contact's first name
lastName: Optional. Contact's last name
phoneNumber: Contact's phone number
vcard: Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMessageContent

class Object

trait Matchable

class Any
Show all

This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: InputFile.type

final case class InputInvoiceMessageContent(title: String, description: String, payload: String, providerToken: String, currency: String, prices: List[LabeledPrice], maxTipAmount: Option[Int], suggestedTipAmounts: List[Int], providerData: Option[String], photoUrl: Option[String], photoSize: Option[Long], photoWidth: Option[Int], photoHeight: Option[Int], needName: Option[Boolean], needPhoneNumber: Option[Boolean], needEmail: Option[Boolean], needShippingAddress: Option[Boolean], sendPhoneNumberToProvider: Option[Boolean], sendEmailToProvider: Option[Boolean], isFlexible: Option[Boolean]) extends InputMessageContent

Represents the content of an invoice message to be sent as the result of an inline query.

Value parameters

currency: Three-letter ISO 4217 currency code, see more on currencies
description: Product description, 1-255 characters
isFlexible: Optional. Pass True if the final price depends on the shipping method
maxTipAmount: 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, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0
needEmail: Optional. Pass True if you require the user's email address to complete the order
needName: Optional. Pass True if you require the user's full name to complete the order
needPhoneNumber: Optional. Pass True if you require the user's phone number to complete the order
needShippingAddress: Optional. Pass True if you require the user's shipping address to complete the order
payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
photoHeight: Optional. Photo height
photoSize: Optional. Photo size in bytes
photoUrl: Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
photoWidth: Optional. Photo width
prices: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
providerData: Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
providerToken: Payment provider token, obtained via @BotFather
sendEmailToProvider: Optional. Pass True if the user's email address should be sent to provider
sendPhoneNumberToProvider: Optional. Pass True if the user's phone number should be sent to provider
suggestedTipAmounts: Optional. A JSON-serialized array of suggested amounts of tip 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.
title: Product name, 1-32 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMessageContent

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait IFile

class Object

trait Matchable

class Any
Show all

Represents the content of a location message to be sent as the result of an inline query.

Value parameters

heading: Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
horizontalAccuracy: Optional. The radius of uncertainty for the location, measured in meters; 0-1500
latitude: Latitude of the location in degrees
livePeriod: Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.
longitude: Longitude of the location in degrees
proximityAlertRadius: Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMessageContent

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class InputMediaAnimation

class InputMediaAudio

class InputMediaDocument

class InputMediaPhoto

class InputMediaVideo

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

Value parameters

caption: Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
duration: Optional. Animation duration in seconds
hasSpoiler: Optional. Pass True if the animation needs to be covered with a spoiler animation
height: Optional. Animation height
media: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
parseMode: Optional. Mode for parsing entities in the animation caption. See formatting options for more details.
thumbnail: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
width: Optional. Animation width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMedia

class Object

trait Matchable

class Any
Show all

Represents an audio file to be treated as music to be sent.

Value parameters

caption: Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
duration: Optional. Duration of the audio in seconds
media: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
parseMode: Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
performer: Optional. Performer of the audio
thumbnail: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
title: Optional. Title of the audio

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMedia

class Object

trait Matchable

class Any
Show all

Represents a general file to be sent.

Value parameters

caption: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
disableContentTypeDetection: Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
media: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
parseMode: Optional. Mode for parsing entities in the document caption. See formatting options for more details.
thumbnail: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMedia

class Object

trait Matchable

class Any
Show all

Represents a photo to be sent.

Value parameters

caption: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
hasSpoiler: Optional. Pass True if the photo needs to be covered with a spoiler animation
media: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
parseMode: Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMedia

class Object

trait Matchable

class Any
Show all

Represents a video to be sent.

Value parameters

caption: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
captionEntities: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
duration: Optional. Video duration in seconds
hasSpoiler: Optional. Pass True if the video needs to be covered with a spoiler animation
height: Optional. Video height
media: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
parseMode: Optional. Mode for parsing entities in the video caption. See formatting options for more details.
supportsStreaming: Optional. Pass True if the uploaded video is suitable for streaming
thumbnail: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
width: Optional. Video width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMedia

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class InputContactMessageContent

class InputInvoiceMessageContent

class InputLocationMessageContent

class InputTextMessageContent

class InputVenueMessageContent

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait IFile

class Object

trait Matchable

class Any
Show all

This object describes a sticker to be added to a sticker set.

Value parameters

emojiList: List of 1-20 emoji associated with the sticker
format: Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video
keywords: Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.
maskPosition: Optional. Position where the mask should be placed on faces. For “mask” stickers only.
sticker: The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents the content of a text message to be sent as the result of an inline query.

Value parameters

entities: Optional. List of special entities that appear in message text, which can be specified instead of parse_mode
linkPreviewOptions: Optional. Link preview generation options for the message
messageText: Text of the message to be sent, 1-4096 characters
parseMode: Optional. Mode for parsing entities in the message text. See formatting options for more details.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMessageContent

class Object

trait Matchable

class Any
Show all

Represents the content of a venue message to be sent as the result of an inline query.

Value parameters

address: Address of the venue
foursquareId: Optional. Foursquare identifier of the venue, if known
foursquareType: Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
googlePlaceId: Optional. Google Places identifier of the venue
googlePlaceType: Optional. Google Places type of the venue. (See supported types.)
latitude: Latitude of the venue in degrees
longitude: Longitude of the venue in degrees
title: Name of the venue

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait InputMessageContent

class Object

trait Matchable

class Any
Show all

This object contains basic information about an invoice.

Value parameters

currency: Three-letter ISO 4217 currency code
description: Product description
startParameter: Unique bot deep-linking parameter that can be used to generate this invoice
title: Product name
totalAmount: Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

italic

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.

Value parameters

requestChat: Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.
requestContact: Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
requestLocation: Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
requestPoll: Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.
requestUsers: Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.
text: Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed
webApp: Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

Value parameters

type: Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate

Value parameters

botAdministratorRights: Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.
botIsMember: Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
chatHasUsername: Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.
chatIsChannel: Pass True to request a channel chat, pass False to request a group or a supergroup chat.
chatIsCreated: Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
chatIsForum: Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.
requestId: Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message
requestPhoto: Optional. Pass True to request the chat's photo
requestTitle: Optional. Pass True to request the chat's title
requestUsername: Optional. Pass True to request the chat's username
userAdministratorRights: Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed.

Value parameters

maxQuantity: Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
requestId: Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message
requestName: Optional. Pass True to request the users' first and last name
requestPhoto: Optional. Pass True to request the users' photo
requestUsername: Optional. Pass True to request the users' username
userIsBot: Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.
userIsPremium: Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ForceReply

class InlineKeyboardMarkup

class ReplyKeyboardMarkup

class ReplyKeyboardRemove

This object represents a portion of the price for goods or services.

Value parameters

amount: Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
label: Portion label

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes the options used for link preview generation.

Value parameters

isDisabled: Optional. True, if the link preview is disabled
preferLargeMedia: Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
preferSmallMedia: Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
showAboveText: Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text
url: Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a point on the map.

Value parameters

heading: Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.
horizontalAccuracy: Optional. The radius of uncertainty for the location, measured in meters; 0-1500
latitude: Latitude as defined by sender
livePeriod: Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.
longitude: Longitude as defined by sender
proximityAlertRadius: Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:

Value parameters

botUsername: Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
forwardText: Optional. New text of the button in forwarded messages.
requestWriteAccess: Optional. Pass True to request the permission for your bot to send messages to the user.
url: An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data. NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait ParseMode

class Object

trait Matchable

class Any
Show all
Self type: Markdown.type

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait ParseMode

class Object

trait Matchable

class Any
Show all
Self type: Markdown2.type

This object describes the position on faces where a mask should be placed by default.

Value parameters

point: The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
scale: Mask scaling coefficient. For example, 2.0 means double size.
xShift: Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
yShift: Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class InaccessibleMessage

class Message

mention

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object MenuButtonCommands

object MenuButtonDefault

class MenuButtonWebApp

Represents a menu button, which opens the bot's list of commands.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait MenuButton

class Object

trait Matchable

class Any
Show all
Self type: MenuButtonCommands.type

Describes that no specific value for the menu button was set.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

trait MenuButton

class Object

trait Matchable

class Any
Show all
Self type: MenuButtonDefault.type

Represents a menu button, which launches a Web App.

Value parameters

text: Text on the button
webApp: Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MenuButton

class Object

trait Matchable

class Any
Show all

final case class Message(messageId: Int, date: Int, chat: Chat, messageThreadId: Option[Int], from: Option[User], senderChat: Option[Chat], senderBoostCount: Option[Int], senderBusinessBot: Option[User], businessConnectionId: Option[String], forwardOrigin: Option[MessageOrigin], isTopicMessage: Option[Boolean], isAutomaticForward: Option[Boolean], replyToMessage: Option[Message], externalReply: Option[ExternalReplyInfo], quote: Option[TextQuote], replyToStory: Option[Story], viaBot: Option[User], editDate: Option[Int], hasProtectedContent: Option[Boolean], isFromOffline: Option[Boolean], mediaGroupId: Option[String], authorSignature: Option[String], text: Option[String], entities: List[MessageEntity], linkPreviewOptions: Option[LinkPreviewOptions], animation: Option[Animation], audio: Option[Audio], document: Option[Document], photo: List[PhotoSize], sticker: Option[Sticker], story: Option[Story], video: Option[Video], videoNote: Option[VideoNote], voice: Option[Voice], caption: Option[String], captionEntities: List[MessageEntity], hasMediaSpoiler: Option[Boolean], contact: Option[Contact], dice: Option[Dice], game: Option[Game], poll: Option[Poll], venue: Option[Venue], location: Option[Location], newChatMembers: List[User], leftChatMember: Option[User], newChatTitle: Option[String], newChatPhoto: List[PhotoSize], deleteChatPhoto: Option[Boolean], groupChatCreated: Option[Boolean], supergroupChatCreated: Option[Boolean], channelChatCreated: Option[Boolean], messageAutoDeleteTimerChanged: Option[MessageAutoDeleteTimerChanged], migrateToChatId: Option[Long], migrateFromChatId: Option[Long], pinnedMessage: Option[MaybeInaccessibleMessage], invoice: Option[Invoice], successfulPayment: Option[SuccessfulPayment], usersShared: Option[UsersShared], chatShared: Option[ChatShared], connectedWebsite: Option[String], writeAccessAllowed: Option[WriteAccessAllowed], passportData: Option[PassportData], proximityAlertTriggered: Option[ProximityAlertTriggered], boostAdded: Option[ChatBoostAdded], forumTopicCreated: Option[ForumTopicCreated], forumTopicEdited: Option[ForumTopicEdited], forumTopicClosed: Option[ForumTopicClosed.type], forumTopicReopened: Option[ForumTopicReopened.type], generalForumTopicHidden: Option[GeneralForumTopicHidden.type], generalForumTopicUnhidden: Option[GeneralForumTopicUnhidden.type], giveawayCreated: Option[GiveawayCreated.type], giveaway: Option[Giveaway], giveawayWinners: Option[GiveawayWinners], giveawayCompleted: Option[GiveawayCompleted], videoChatScheduled: Option[VideoChatScheduled], videoChatStarted: Option[VideoChatStarted.type], videoChatEnded: Option[VideoChatEnded], videoChatParticipantsInvited: Option[VideoChatParticipantsInvited], webAppData: Option[WebAppData], replyMarkup: Option[InlineKeyboardMarkup]) extends MaybeInaccessibleMessage

This object represents a message.

Value parameters

animation: Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set
audio: Optional. Message is an audio file, information about the file
authorSignature: Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator
boostAdded: Optional. Service message: user boosted the chat
businessConnectionId: Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.
caption: Optional. Caption for the animation, audio, document, photo, video or voice
captionEntities: Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
channelChatCreated: Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.
chat: Chat the message belongs to
chatShared: Optional. Service message: a chat was shared with the bot
connectedWebsite: Optional. The domain name of the website on which the user has logged in.
contact: Optional. Message is a shared contact, information about the contact
date: Date the message was sent in Unix time. It is always a positive number, representing a valid date.
deleteChatPhoto: Optional. Service message: the chat photo was deleted
dice: Optional. Message is a dice with random value
document: Optional. Message is a general file, information about the file
editDate: Optional. Date the message was last edited in Unix time
entities: Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
externalReply: Optional. Information about the message that is being replied to, which may come from another chat or forum topic
forumTopicClosed: Optional. Service message: forum topic closed
forumTopicCreated: Optional. Service message: forum topic created
forumTopicEdited: Optional. Service message: forum topic edited
forumTopicReopened: Optional. Service message: forum topic reopened
forwardOrigin: Optional. Information about the original message for forwarded messages
from: Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
game: Optional. Message is a game, information about the game.
generalForumTopicHidden: Optional. Service message: the 'General' forum topic hidden
generalForumTopicUnhidden: Optional. Service message: the 'General' forum topic unhidden
giveaway: Optional. The message is a scheduled giveaway message
giveawayCompleted: Optional. Service message: a giveaway without public winners was completed
giveawayCreated: Optional. Service message: a scheduled giveaway was created
giveawayWinners: Optional. A giveaway with public winners was completed
groupChatCreated: Optional. Service message: the group has been created
hasMediaSpoiler: Optional. True, if the message media is covered by a spoiler animation
hasProtectedContent: Optional. True, if the message can't be forwarded
invoice: Optional. Message is an invoice for a payment, information about the invoice.
isAutomaticForward: Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group
isFromOffline: Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message
isTopicMessage: Optional. True, if the message is sent to a forum topic
leftChatMember: Optional. A member was removed from the group, information about them (this member may be the bot itself)
linkPreviewOptions: Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed
location: Optional. Message is a shared location, information about the location
mediaGroupId: Optional. The unique identifier of a media message group this message belongs to
messageAutoDeleteTimerChanged: Optional. Service message: auto-delete timer settings changed in the chat
messageId: Unique message identifier inside this chat
messageThreadId: Optional. Unique identifier of a message thread to which the message belongs; for supergroups only
migrateFromChatId: Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
migrateToChatId: Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
newChatMembers: Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
newChatPhoto: Optional. A chat photo was change to this value
newChatTitle: Optional. A chat title was changed to this value
passportData: Optional. Telegram Passport data
photo: Optional. Message is a photo, available sizes of the photo
pinnedMessage: Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
poll: Optional. Message is a native poll, information about the poll
proximityAlertTriggered: Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
quote: Optional. For replies that quote part of the original message, the quoted part of the message
replyMarkup: Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.
replyToMessage: Optional. For replies in the same chat and message thread, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
replyToStory: Optional. For replies to a story, the original story
senderBoostCount: Optional. If the sender of the message boosted the chat, the number of boosts added by the user
senderBusinessBot: Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.
senderChat: Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
sticker: Optional. Message is a sticker, information about the sticker
story: Optional. Message is a forwarded story
successfulPayment: Optional. Message is a service message about a successful payment, information about the payment.
supergroupChatCreated: Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.
text: Optional. For text messages, the actual UTF-8 text of the message
usersShared: Optional. Service message: users were shared with the bot
venue: Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set
viaBot: Optional. Bot through which the message was sent
video: Optional. Message is a video, information about the video
videoChatEnded: Optional. Service message: video chat ended
videoChatParticipantsInvited: Optional. Service message: new participants invited to a video chat
videoChatScheduled: Optional. Service message: video chat scheduled
videoChatStarted: Optional. Service message: video chat started
videoNote: Optional. Message is a video note, information about the video message
voice: Optional. Message is a voice message, information about the file
webAppData: Optional. Service message: data sent by a Web App
writeAccessAllowed: Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MaybeInaccessibleMessage

class Object

trait Matchable

class Any
Show all

This object represents a service message about a change in auto-delete timer settings.

Value parameters

messageAutoDeleteTime: New auto-delete time for messages in the chat; in seconds

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class BlockquoteMessageEntity

class BoldMessageEntity

class BotCommandMessageEntity

class CashtagMessageEntity

class CodeMessageEntity

class CustomEmojiMessageEntity

class EmailMessageEntity

class HashtagMessageEntity

class ItalicMessageEntity

class MentionMessageEntity

class PhoneNumberMessageEntity

class PreMessageEntity

class SpoilerMessageEntity

class StrikethroughMessageEntity

class TextLinkMessageEntity

class TextMentionMessageEntity

class UnderlineMessageEntity

class UrlMessageEntity
Show all

This object represents a unique message identifier.

Value parameters

messageId: Unique message identifier

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class MessageOriginChannel

class MessageOriginChat

class MessageOriginHiddenUser

class MessageOriginUser

The message was originally sent to a channel chat.

Value parameters

authorSignature: Optional. Signature of the original post author
chat: Channel chat to which the message was originally sent
date: Date the message was sent originally in Unix time
messageId: Unique message identifier inside the chat

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageOrigin

class Object

trait Matchable

class Any
Show all

The message was originally sent on behalf of a chat to a group chat.

Value parameters

authorSignature: Optional. For messages originally sent by an anonymous chat administrator, original message author signature
date: Date the message was sent originally in Unix time
senderChat: Chat that sent the message originally

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageOrigin

class Object

trait Matchable

class Any
Show all

The message was originally sent by an unknown user.

Value parameters

date: Date the message was sent originally in Unix time
senderUserName: Name of the user that sent the message originally

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageOrigin

class Object

trait Matchable

class Any
Show all

The message was originally sent by a known user.

Value parameters

date: Date the message was sent originally in Unix time
senderUser: User that sent the message originally

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageOrigin

class Object

trait Matchable

class Any
Show all

This object represents reaction changes on a message with anonymous reactions.

Value parameters

chat: The chat containing the message
date: Date of the change in Unix time
messageId: Unique message identifier inside the chat
reactions: List of reactions that are present on the message

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a change of a reaction on a message performed by a user.

Value parameters

actorChat: Optional. The chat on behalf of which the reaction was changed, if the user is anonymous
chat: The chat containing the message the user reacted to
date: Date of the change in Unix time
messageId: Unique identifier of the message inside the chat
newReaction: New list of reaction types that have been set by the user
oldReaction: Previous list of reaction types that were set by the user
user: Optional. The user that changed the reaction, if the user isn't anonymous

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents information about an order.

Value parameters

email: Optional. User email
name: Optional. User name
phoneNumber: Optional. User's phone number
shippingAddress: Optional. User shipping address

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Html

object Markdown

object Markdown2

Describes Telegram Passport data shared with the bot by the user.

Value parameters

credentials: Encrypted credentials required to decrypt the data
data: Array with information about documents and other Telegram Passport elements that was shared with the bot

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class PassportElementErrorDataField

class PassportElementErrorFile

class PassportElementErrorFiles

class PassportElementErrorFrontSide

class PassportElementErrorReverseSide

class PassportElementErrorSelfie

class PassportElementErrorTranslationFile

class PassportElementErrorTranslationFiles

class PassportElementErrorUnspecified
Show all

Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

Value parameters

dataHash: Base64-encoded data hash
fieldName: Name of the data field which has the error
message: Error message
type: The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

Value parameters

fileHash: Base64-encoded file hash
message: Error message
type: The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

Value parameters

fileHashes: List of base64-encoded file hashes
message: Error message
type: The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

Value parameters

fileHash: Base64-encoded hash of the file with the front side of the document
message: Error message
type: The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

Value parameters

fileHash: Base64-encoded hash of the file with the reverse side of the document
message: Error message
type: The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

Value parameters

fileHash: Base64-encoded hash of the file with the selfie
message: Error message
type: The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

Value parameters

fileHash: Base64-encoded file hash
message: Error message
type: Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

Value parameters

fileHashes: List of base64-encoded file hashes
message: Error message
type: Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

Value parameters

elementHash: Base64-encoded element hash
message: Error message
type: Type of element of the user's Telegram Passport which has the issue

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PassportElementError

class Object

trait Matchable

class Any
Show all

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

Value parameters

fileDate: Unix time when the file was uploaded
fileId: Identifier for this file, which can be used to download or reuse the file
fileSize: File size in bytes
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

phone_number

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents one size of a photo or a file / sticker thumbnail.

Value parameters

fileId: Identifier for this file, which can be used to download or reuse the file
fileSize: Optional. File size in bytes
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
height: Photo height
width: Photo width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about a poll.

Value parameters

allowsMultipleAnswers: True, if the poll allows multiple answers
closeDate: Optional. Point in time (Unix timestamp) when the poll will be automatically closed
correctOptionId: Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.
explanation: Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters
explanationEntities: Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation
id: Unique poll identifier
isAnonymous: True, if the poll is anonymous
isClosed: True, if the poll is closed
openPeriod: Optional. Amount of time in seconds the poll will be active after creation
options: List of poll options
question: Poll question, 1-300 characters
totalVoterCount: Total number of users that voted in the poll
type: Poll type, currently can be “regular” or “quiz”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents an answer of a user in a non-anonymous poll.

Value parameters

optionIds: 0-based identifiers of chosen answer options. May be empty if the vote was retracted.
pollId: Unique poll identifier
user: Optional. The user that changed the answer to the poll, if the voter isn't anonymous
voterChat: Optional. The chat that changed the answer to the poll, if the voter is anonymous

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about one answer option in a poll.

Value parameters

text: Option text, 1-100 characters
voterCount: Number of users that voted for this option

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about an incoming pre-checkout query.

Value parameters

currency: Three-letter ISO 4217 currency code
from: User who sent the query
id: Unique query identifier
invoicePayload: Bot specified invoice payload
orderInfo: Optional. Order information provided by the user
shippingOptionId: Optional. Identifier of the shipping option chosen by the user
totalAmount: Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

pre

Value parameters

language: Optional, the programming language of the entity text
length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

Value parameters

distance: The distance between the users
traveler: User that triggered the alert
watcher: User that set the alert

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a reaction added to a message along with the number of times it was added.

Value parameters

totalCount: Number of times the reaction was added
type: Type of the reaction

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ReactionTypeCustomEmoji

class ReactionTypeEmoji

The reaction is based on a custom emoji.

Value parameters

customEmojiId: Custom emoji identifier

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ReactionType

class Object

trait Matchable

class Any
Show all

The reaction is based on an emoji.

Value parameters

emoji: Reaction emoji. Currently, it can be one of "👍", "👎", "❤", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳", "❤‍🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨‍💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷‍♂", "🤷", "🤷‍♀", "😡"

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ReactionType

class Object

trait Matchable

class Any
Show all

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Value parameters

inputFieldPlaceholder: Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
isPersistent: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
keyboard: Array of button rows, each represented by an Array of KeyboardButton objects
oneTimeKeyboard: Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
resizeKeyboard: Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
selective: Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait KeyboardMarkup

class Object

trait Matchable

class Any
Show all

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

Value parameters

removeKeyboard: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
selective: Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait KeyboardMarkup

class Object

trait Matchable

class Any
Show all

Describes reply parameters for the message that is being sent.

Value parameters

allowSendingWithoutReply: Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.
chatId: Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account.
messageId: Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified
quote: Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message.
quoteEntities: Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.
quoteParseMode: Optional. Mode for parsing entities in the quote. See formatting options for more details.
quotePosition: Optional. Position of the quote in the original message in UTF-16 code units

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes why a request was unsuccessful.

Value parameters

migrateToChatId: Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
retryAfter: Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes an inline message sent by a Web App on behalf of a user.

Value parameters

inlineMessageId: Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.

Value parameters

firstName: Optional. First name of the user, if the name was requested by the bot
lastName: Optional. Last name of the user, if the name was requested by the bot
photo: Optional. Available sizes of the chat photo, if the photo was requested by the bot
userId: Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.
username: Optional. Username of the user, if the username was requested by the bot

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a shipping address.

Value parameters

city: City
countryCode: Two-letter ISO 3166-1 alpha-2 country code
postCode: Address post code
state: State, if applicable
streetLine1: First line for the address
streetLine2: Second line for the address

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents one shipping option.

Value parameters

id: Shipping option identifier
prices: List of price portions
title: Option title

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about an incoming shipping query.

Value parameters

from: User who sent the query
id: Unique query identifier
invoicePayload: Bot specified invoice payload
shippingAddress: User specified shipping address

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

spoiler

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents a sticker.

Value parameters

customEmojiId: Optional. For custom emoji stickers, unique identifier of the custom emoji
emoji: Optional. Emoji associated with the sticker
fileId: Identifier for this file, which can be used to download or reuse the file
fileSize: Optional. File size in bytes
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
height: Sticker height
isAnimated: True, if the sticker is animated
isVideo: True, if the sticker is a video sticker
maskPosition: Optional. For mask stickers, the position where the mask should be placed
needsRepainting: Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places
premiumAnimation: Optional. For premium regular stickers, premium animation for the sticker
setName: Optional. Name of the sticker set to which the sticker belongs
thumbnail: Optional. Sticker thumbnail in the .WEBP or .JPG format
type: Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.
width: Sticker width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a sticker set.

Value parameters

name: Sticker set name
stickerType: Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
stickers: List of all set stickers
thumbnail: Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
title: Sticker set title

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a story.

Value parameters

chat: Chat that posted the story
id: Unique identifier for the story in the chat

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

strikethrough

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object contains basic information about a successful payment.

Value parameters

currency: Three-letter ISO 4217 currency code
invoicePayload: Bot specified invoice payload
orderInfo: Optional. Order information provided by the user
providerPaymentChargeId: Provider payment identifier
shippingOptionId: Optional. Identifier of the shipping option chosen by the user
telegramPaymentChargeId: Telegram payment identifier
totalAmount: Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

Value parameters

allowBotChats: Optional. True, if private chats with bots can be chosen
allowChannelChats: Optional. True, if channel chats can be chosen
allowGroupChats: Optional. True, if group and supergroup chats can be chosen
allowUserChats: Optional. True, if private chats with users can be chosen
query: Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

text_link

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity
url: URL that will be opened after user taps on the text

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

text_mention

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity
user: the mentioned user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object contains information about the quoted part of a message that is replied to by the given message.

Value parameters

entities: Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes.
isManual: Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.
position: Approximate quote position in the original message in UTF-16 code units as specified by the sender
text: Text of the quoted part of a message that is replied to by the given message

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

underline

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

final case class Update(updateId: Int, message: Option[Message], editedMessage: Option[Message], channelPost: Option[Message], editedChannelPost: Option[Message], businessConnection: Option[BusinessConnection], businessMessage: Option[Message], editedBusinessMessage: Option[Message], deletedBusinessMessages: Option[BusinessMessagesDeleted], messageReaction: Option[MessageReactionUpdated], messageReactionCount: Option[MessageReactionCountUpdated], inlineQuery: Option[InlineQuery], chosenInlineResult: Option[ChosenInlineResult], callbackQuery: Option[CallbackQuery], shippingQuery: Option[ShippingQuery], preCheckoutQuery: Option[PreCheckoutQuery], poll: Option[Poll], pollAnswer: Option[PollAnswer], myChatMember: Option[ChatMemberUpdated], chatMember: Option[ChatMemberUpdated], chatJoinRequest: Option[ChatJoinRequest], chatBoost: Option[ChatBoostUpdated], removedChatBoost: Option[ChatBoostRemoved])

This object represents an incoming update. At most one of the optional parameters can be present in any given update.

Value parameters

businessConnection: Optional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot
businessMessage: Optional. New non-service message from a connected business account
callbackQuery: Optional. New incoming callback query
channelPost: Optional. New incoming channel post of any kind - text, photo, sticker, etc.
chatBoost: Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
chatJoinRequest: Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.
chatMember: Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify "chat_member" in the list of allowed_updates to receive these updates.
chosenInlineResult: Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
deletedBusinessMessages: Optional. Messages were deleted from a connected business account
editedBusinessMessage: Optional. New version of a message from a connected business account
editedChannelPost: Optional. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.
editedMessage: Optional. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.
inlineQuery: Optional. New incoming inline query
message: Optional. New incoming message of any kind - text, photo, sticker, etc.
messageReaction: Optional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.
messageReactionCount: Optional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.
myChatMember: Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.
poll: Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot
pollAnswer: Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
preCheckoutQuery: Optional. New incoming pre-checkout query. Contains full information about checkout
removedChatBoost: Optional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
shippingQuery: Optional. New incoming shipping query. Only for invoices with flexible price
updateId: The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

url

Value parameters

length: Length of the entity in UTF-16 code units
offset: Offset in UTF-16 code units to the start of the entity

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageEntity

class Object

trait Matchable

class Any
Show all

This object represents a Telegram user or bot.

Value parameters

addedToAttachmentMenu: Optional. True, if this user added the bot to the attachment menu
canConnectToBusiness: Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe.
canJoinGroups: Optional. True, if the bot can be invited to groups. Returned only in getMe.
canReadAllGroupMessages: Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
firstName: User's or bot's first name
id: Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
isBot: True, if this user is a bot
isPremium: Optional. True, if this user is a Telegram Premium user
languageCode: Optional. IETF language tag of the user's language
lastName: Optional. User's or bot's last name
supportsInlineQueries: Optional. True, if the bot supports inline queries. Returned only in getMe.
username: Optional. User's or bot's username

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a list of boosts added to a chat by a user.

Value parameters

boosts: The list of boosts added to the chat by the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represent a user's profile pictures.

Value parameters

photos: Requested profile pictures (in up to 4 sizes each)
totalCount: Total number of profile pictures the target user has

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.

Value parameters

requestId: Identifier of the request
users: Information about users shared with the bot.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a venue.

Value parameters

address: Address of the venue
foursquareId: Optional. Foursquare identifier of the venue
foursquareType: Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
googlePlaceId: Optional. Google Places identifier of the venue
googlePlaceType: Optional. Google Places type of the venue. (See supported types.)
location: Venue location. Can't be a live location
title: Name of the venue

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a video file.

Value parameters

duration: Duration of the video in seconds as defined by sender
fileId: Identifier for this file, which can be used to download or reuse the file
fileName: Optional. Original filename as defined by sender
fileSize: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
height: Video height as defined by sender
mimeType: Optional. MIME type of the file as defined by sender
thumbnail: Optional. Video thumbnail
width: Video width as defined by sender

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a video chat ended in the chat.

Value parameters

duration: Video chat duration in seconds

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about new members invited to a video chat.

Value parameters

users: New members that were invited to the video chat

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a video chat scheduled in the chat.

Value parameters

startDate: Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a video chat started in the chat. Currently holds no information.

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: VideoChatStarted.type

This object represents a video message (available in Telegram apps as of v.4.0).

Value parameters

duration: Duration of the video in seconds as defined by sender
fileId: Identifier for this file, which can be used to download or reuse the file
fileSize: Optional. File size in bytes
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
length: Video width and height (diameter of the video message) as defined by sender
thumbnail: Optional. Video thumbnail

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a voice note.

Value parameters

duration: Duration of the audio in seconds as defined by sender
fileId: Identifier for this file, which can be used to download or reuse the file
fileSize: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
fileUniqueId: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
mimeType: Optional. MIME type of the file as defined by sender

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes data sent from a Web App to the bot.

Value parameters

buttonText: Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.
data: The data. Be aware that a bad client can send arbitrary data in this field.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes a Web App.

Value parameters

url: An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Describes the current status of a webhook.

Value parameters

allowedUpdates: Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member
hasCustomCertificate: True, if a custom certificate was provided for webhook certificate checks
ipAddress: Optional. Currently used webhook IP address
lastErrorDate: Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook
lastErrorMessage: Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook
lastSynchronizationErrorDate: Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters
maxConnections: Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
pendingUpdateCount: Number of updates awaiting delivery
url: Webhook URL, may be empty if webhook is not set up

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

Value parameters

fromAttachmentMenu: Optional. True, if the access was granted when the bot was added to the attachment or side menu
fromRequest: Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess
webAppName: Optional. Name of the Web App, if the access was granted when the Web App was launched from a link

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

telegramium.bots

Members list

Packages

Type members

Classlikes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes