telegramium.bots.client

Value parameters

name: Sticker set name
sticker: A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.
userId: User identifier of sticker set owner

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

cacheTime: The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
callbackQueryId: Unique identifier for the query to be answered
showAlert: If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
text: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
url: URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

button: A JSON-serialized object describing a button to be shown above inline query results
cacheTime: The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
inlineQueryId: Unique identifier for the answered query
isPersonal: Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
nextOffset: Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.
results: A JSON-serialized array of results for the inline query

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

errorMessage: Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.
ok: Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
preCheckoutQueryId: Unique identifier for the query to be answered

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

errorMessage: Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.
ok: Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
shippingOptions: Required if ok is True. A JSON-serialized array of available shipping options.
shippingQueryId: Unique identifier for the query to be answered

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

result: A JSON-serialized object describing the message to be sent
webAppQueryId: Unique identifier for the query to be answered

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
revokeMessages: Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.
untilDate: Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
userId: Unique identifier of the target user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
senderChatId: Unique identifier of the target sender chat

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

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
messageThreadId: Unique identifier for the target message thread of the forum topic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: CloseReq.type

Value parameters

caption: New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept
captionEntities: A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
fromChatId: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
messageId: Message identifier in the chat specified in from_chat_id
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the new caption. See formatting options for more details.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
replyParameters: Description of the message to reply to

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the messages silently. Users will receive a notification with no sound.
fromChatId: Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
messageIds: A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent messages from forwarding and saving
removeCaption: Pass True to copy the messages without their captions

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
createsJoinRequest: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified
expireDate: Point in time (Unix timestamp) when the link will expire
memberLimit: The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
name: Invite link name; 0-32 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
iconColor: Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)
iconCustomEmojiId: Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
name: Topic name, 1-128 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class CreateInvoiceLinkReq(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])

Value parameters

currency: Three-letter ISO 4217 currency code, see more on currencies
description: Product description, 1-255 characters
isFlexible: Pass True if the final price depends on the shipping method
maxTipAmount: 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: Pass True if you require the user's email address to complete the order
needName: Pass True if you require the user's full name to complete the order
needPhoneNumber: Pass True if you require the user's phone number to complete the order
needShippingAddress: 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: Photo height
photoSize: Photo size in bytes
photoUrl: URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
photoWidth: Photo width
prices: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
providerData: JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
providerToken: Payment provider token, obtained via BotFather
sendEmailToProvider: Pass True if the user's email address should be sent to the provider
sendPhoneNumberToProvider: Pass True if the user's phone number should be sent to the provider
suggestedTipAmounts: A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
title: Product name, 1-32 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "by<bot_username>". <bot_username> is case insensitive. 1-64 characters.
needsRepainting: Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
stickerType: Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
stickers: A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
title: Sticker set title, 1-64 characters
userId: User identifier of created sticker set owner

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
messageThreadId: Unique identifier for the target message thread of the forum topic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId: Identifier of the message to delete

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageIds: A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

languageCode: A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands
scope: A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

sticker: File identifier of the sticker

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

name: Sticker set name

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

dropPendingUpdates: Pass True to drop all pending updates

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
createsJoinRequest: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified
expireDate: Point in time (Unix timestamp) when the link will expire
inviteLink: The invite link to edit
memberLimit: The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
name: Invite link name; 0-32 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
iconCustomEmojiId: New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept
messageThreadId: Unique identifier for the target message thread of the forum topic
name: New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
name: New topic name, 1-128 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

caption: New caption of the message, 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
messageId: Required if inline_message_id is not specified. Identifier of the message to edit
parseMode: Mode for parsing entities in the message caption. See formatting options for more details.
replyMarkup: A JSON-serialized object for an inline keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
heading: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
horizontalAccuracy: The radius of uncertainty for the location, measured in meters; 0-1500
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
latitude: Latitude of new location
longitude: Longitude of new location
messageId: Required if inline_message_id is not specified. Identifier of the message to edit
proximityAlertRadius: The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
replyMarkup: A JSON-serialized object for a new inline keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
media: A JSON-serialized object for a new media content of the message
messageId: Required if inline_message_id is not specified. Identifier of the message to edit
replyMarkup: A JSON-serialized object for a new inline keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
messageId: Required if inline_message_id is not specified. Identifier of the message to edit
replyMarkup: A JSON-serialized object for an inline keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
entities: A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
linkPreviewOptions: Link preview generation options for the message
messageId: Required if inline_message_id is not specified. Identifier of the message to edit
parseMode: Mode for parsing entities in the message text. See formatting options for more details.
replyMarkup: A JSON-serialized object for an inline keyboard.
text: New text of the message, 1-4096 characters after entities parsing

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
fromChatId: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
messageId: Message identifier in the chat specified in from_chat_id
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the forwarded message from forwarding and saving

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the messages silently. Users will receive a notification with no sound.
fromChatId: Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
messageIds: A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the forwarded messages from forwarding and saving

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target private chat. If not specified, default bot's menu button will be returned

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

customEmojiIds: A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

fileId: File identifier to get information about

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

class Object

trait Matchable

class Any
Show all
Self type: GetForumTopicIconStickersReq.type

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
messageId: Required if inline_message_id is not specified. Identifier of the sent message
userId: Target user id

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

class Object

trait Matchable

class Any
Show all
Self type: GetMeReq.type

Value parameters

languageCode: A two-letter ISO 639-1 language code or an empty string
scope: A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

forChannels: Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

languageCode: A two-letter ISO 639-1 language code or an empty string

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

languageCode: A two-letter ISO 639-1 language code or an empty string

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

languageCode: A two-letter ISO 639-1 language code or an empty string

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

name: Name of the sticker set

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

allowedUpdates: A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.
limit: Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
timeout: Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

limit: Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.
offset: Sequential number of the first photo to be returned. By default, all photos are returned.
userId: Unique identifier of the target user

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

class Object

trait Matchable

class Any
Show all
Self type: GetWebhookInfoReq.type

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

class Object

trait Matchable

class Any
Show all

Value parameters

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

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

class Object

trait Matchable

class Any
Show all
Self type: LogOutReq.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class MethodReq[Res]

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Method[Res]

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: MethodReq.type

Attributes

Supertypes: class Object

trait Matchable

class Any

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.
messageId: Identifier of a message to pin

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

Value parameters

canChangeInfo: Pass True if the administrator can change chat title, photo and other settings
canDeleteMessages: Pass True if the administrator can delete messages of other users
canDeleteStories: Pass True if the administrator can delete stories posted by other users
canEditMessages: Pass True if the administrator can edit messages of other users and can pin messages; for channels only
canEditStories: Pass True if the administrator can edit stories posted by other users
canInviteUsers: Pass True if the administrator can invite new users to the chat
canManageChat: Pass 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: Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
canManageVideoChats: Pass True if the administrator can manage video chats
canPinMessages: Pass True if the administrator can pin messages; for supergroups only
canPostMessages: Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only
canPostStories: Pass True if the administrator can post stories to the chat
canPromoteMembers: Pass 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 him)
canRestrictMembers: Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
isAnonymous: Pass True if the administrator's presence in the chat is hidden
userId: Unique identifier of the target user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
messageThreadId: Unique identifier for the target message thread of the forum topic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

class Object

trait Matchable

class Any
Show all

Value parameters

name: Sticker set name
oldSticker: File identifier of the replaced sticker
sticker: A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.
userId: User identifier of the sticker set owner

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
permissions: A JSON-serialized object for new user permissions
untilDate: Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever
useIndependentChatPermissions: Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
userId: Unique identifier of the target user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier of the target chat or username of the target channel (in the format @channelusername)
inviteLink: The invite link to revoke

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class SendAnimationReq(chatId: ChatId, animation: IFile, businessConnectionId: Option[String], messageThreadId: Option[Int], duration: Option[Int], width: Option[Int], height: Option[Int], thumbnail: Option[IFile], caption: Option[String], parseMode: Option[ParseMode], captionEntities: List[MessageEntity], hasSpoiler: Option[Boolean], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[KeyboardMarkup])

Value parameters

animation: Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data.
businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
caption: Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
duration: Duration of sent animation in seconds
hasSpoiler: Pass True if the animation needs to be covered with a spoiler animation
height: Animation height
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the animation caption. See formatting options for more details.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
thumbnail: 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: Animation width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class SendAudioReq(chatId: ChatId, audio: IFile, businessConnectionId: Option[String], messageThreadId: Option[Int], caption: Option[String], parseMode: Option[ParseMode], captionEntities: List[MessageEntity], duration: Option[Int], performer: Option[String], title: Option[String], thumbnail: Option[IFile], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[KeyboardMarkup])

Value parameters

audio: Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data.
businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
caption: Audio caption, 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
duration: Duration of the audio in seconds
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the audio caption. See formatting options for more details.
performer: Performer
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
thumbnail: 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: Track name

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

action: Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
businessConnectionId: Unique identifier of the business connection on behalf of which the action will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageThreadId: Unique identifier for the target message thread; for supergroups only

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
firstName: Contact's first name
lastName: Contact's last name
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
phoneNumber: Contact's phone number
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
emoji: Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent message from forwarding
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
caption: Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableContentTypeDetection: Disables automatic server-side content type detection for files uploaded using multipart/form-data
disableNotification: Sends the message silently. Users will receive a notification with no sound.
document: File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the document caption. See formatting options for more details.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
thumbnail: 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

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat
disableNotification: Sends the message silently. Users will receive a notification with no sound.
gameShortName: Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account.
replyParameters: Description of the message to reply to

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class SendInvoiceReq(chatId: ChatId, title: String, description: String, payload: String, providerToken: String, currency: String, messageThreadId: Option[Int], prices: List[LabeledPrice], maxTipAmount: Option[Int], suggestedTipAmounts: List[Int], startParameter: Option[String], 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], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[InlineKeyboardMarkup])

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
currency: Three-letter ISO 4217 currency code, see more on currencies
description: Product description, 1-255 characters
disableNotification: Sends the message silently. Users will receive a notification with no sound.
isFlexible: Pass True if the final price depends on the shipping method
maxTipAmount: 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
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
needEmail: Pass True if you require the user's email address to complete the order
needName: Pass True if you require the user's full name to complete the order
needPhoneNumber: Pass True if you require the user's phone number to complete the order
needShippingAddress: 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: Photo height
photoSize: Photo size in bytes
photoUrl: URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
photoWidth: Photo width
prices: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
protectContent: Protects the contents of the sent message from forwarding and saving
providerData: JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
providerToken: Payment provider token, obtained via @BotFather
replyMarkup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
replyParameters: Description of the message to reply to
sendEmailToProvider: Pass True if the user's email address should be sent to provider
sendPhoneNumberToProvider: Pass True if the user's phone number should be sent to provider
startParameter: Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter
suggestedTipAmounts: A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
title: Product name, 1-32 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
heading: For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
horizontalAccuracy: The radius of uncertainty for the location, measured in meters; 0-1500
latitude: Latitude of the location
livePeriod: Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.
longitude: Longitude of the location
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent message from forwarding and saving
proximityAlertRadius: 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: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends messages silently. Users will receive a notification with no sound.
media: A JSON-serialized array describing messages to be sent, must include 2-10 items
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent messages from forwarding and saving
replyParameters: Description of the message to reply to

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
entities: A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
linkPreviewOptions: Link preview generation options for the message
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the message text. See formatting options for more details.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
text: Text of the message to be sent, 1-4096 characters after entities parsing

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
caption: Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
hasSpoiler: Pass True if the photo needs to be covered with a spoiler animation
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the photo caption. See formatting options for more details.
photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class SendPollReq(chatId: ChatId, question: String, businessConnectionId: Option[String], messageThreadId: Option[Int], options: List[String], isAnonymous: Option[Boolean], `type`: Option[String], allowsMultipleAnswers: Option[Boolean], correctOptionId: Option[Int], explanation: Option[String], explanationParseMode: Option[ParseMode], explanationEntities: List[MessageEntity], openPeriod: Option[Int], closeDate: Option[Int], isClosed: Option[Boolean], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[KeyboardMarkup])

Value parameters

allowsMultipleAnswers: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
closeDate: Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.
correctOptionId: 0-based identifier of the correct answer option, required for polls in quiz mode
disableNotification: Sends the message silently. Users will receive a notification with no sound.
explanation: 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 with at most 2 line feeds after entities parsing
explanationEntities: A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode
explanationParseMode: Mode for parsing entities in the explanation. See formatting options for more details.
isAnonymous: True, if the poll needs to be anonymous, defaults to True
isClosed: Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
openPeriod: Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
options: A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
protectContent: Protects the contents of the sent message from forwarding and saving
question: Poll question, 1-300 characters
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
type: Poll type, “quiz” or “regular”, defaults to “regular”

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
emoji: Emoji associated with the sticker; only for just uploaded stickers
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.
replyParameters: Description of the message to reply to
sticker: Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. Video and animated stickers can't be sent via an HTTP URL.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class SendVenueReq(chatId: ChatId, latitude: Float, longitude: Float, title: String, address: String, businessConnectionId: Option[String], messageThreadId: Option[Int], foursquareId: Option[String], foursquareType: Option[String], googlePlaceId: Option[String], googlePlaceType: Option[String], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[KeyboardMarkup])

Value parameters

address: Address of the venue
businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
foursquareId: Foursquare identifier of the venue
foursquareType: Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
googlePlaceId: Google Places identifier of the venue
googlePlaceType: Google Places type of the venue. (See supported types.)
latitude: Latitude of the venue
longitude: Longitude of the venue
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
title: Name of the venue

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
duration: Duration of sent video in seconds
length: Video width and height, i.e. diameter of the video message
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
thumbnail: 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>.
videoNote: Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. Sending video notes by a URL is currently unsupported

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

final case class SendVideoReq(chatId: ChatId, video: IFile, businessConnectionId: Option[String], messageThreadId: Option[Int], duration: Option[Int], width: Option[Int], height: Option[Int], thumbnail: Option[IFile], caption: Option[String], parseMode: Option[ParseMode], captionEntities: List[MessageEntity], hasSpoiler: Option[Boolean], supportsStreaming: Option[Boolean], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[KeyboardMarkup])

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
caption: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
duration: Duration of sent video in seconds
hasSpoiler: Pass True if the video needs to be covered with a spoiler animation
height: Video height
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the video caption. See formatting options for more details.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
supportsStreaming: Pass True if the uploaded video is suitable for streaming
thumbnail: 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>.
video: Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data.
width: Video width

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

businessConnectionId: Unique identifier of the business connection on behalf of which the message will be sent
caption: Voice message caption, 0-1024 characters after entities parsing
captionEntities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
disableNotification: Sends the message silently. Users will receive a notification with no sound.
duration: Duration of the voice message in seconds
messageThreadId: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
parseMode: Mode for parsing entities in the voice message caption. See formatting options for more details.
protectContent: Protects the contents of the sent message from forwarding and saving
replyMarkup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account
replyParameters: Description of the message to reply to
voice: Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
customTitle: New custom title for the administrator; 0-16 characters, emoji are not allowed
userId: Unique identifier of the target user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
description: New chat description, 0-255 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target private chat. If not specified, default bot's menu button will be changed
menuButton: A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
permissions: A JSON-serialized object for new default chat permissions
useIndependentChatPermissions: Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
photo: New chat photo, uploaded using multipart/form-data

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
stickerSetName: Name of the sticker set to be set as the group sticker set

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
title: New chat title, 1-128 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

customEmojiId: Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.
name: Sticker set name

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat
disableEditMessage: Pass True if the game message should not be automatically edited to include the current scoreboard
force: Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
messageId: Required if inline_message_id is not specified. Identifier of the sent message
score: New score, must be non-negative
userId: User identifier

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
isBig: Pass True to set the reaction with a big animation
messageId: Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.
reaction: A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

commands: A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
languageCode: A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands
scope: A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

forChannels: Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
rights: A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

description: New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
languageCode: A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

languageCode: A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.
name: New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

languageCode: A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.
shortDescription: New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

errors: A JSON-serialized array describing the errors
userId: User identifier

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

emojiList: A JSON-serialized list of 1-20 emoji associated with the sticker
sticker: File identifier of the sticker

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

keywords: A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters
sticker: File identifier of the sticker

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

maskPosition: A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.
sticker: File identifier of the sticker

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

position: New sticker position in the set, zero-based
sticker: File identifier of the sticker

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

format: Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video
name: Sticker set name
thumbnail: A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. 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, or upload a new one using multipart/form-data. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
userId: User identifier of the sticker set owner

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

name: Sticker set name
title: Sticker set title, 1-64 characters

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

allowedUpdates: A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
certificate: Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
dropPendingUpdates: Pass True to drop all pending updates
ipAddress: The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
maxConnections: The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
secretToken: A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.
url: HTTPS URL to send updates to. Use an empty string to remove webhook integration

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
inlineMessageId: Required if chat_id and message_id are not specified. Identifier of the inline message
messageId: Required if inline_message_id is not specified. Identifier of the message with live location to stop
replyMarkup: A JSON-serialized object for a new inline keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId: Identifier of the original message with the poll
replyMarkup: A JSON-serialized object for a new message inline keyboard.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
onlyIfBanned: Do nothing if the user is not banned
userId: Unique identifier of the target user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
senderChatId: Unique identifier of the target sender chat

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

class Object

trait Matchable

class Any
Show all

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
messageThreadId: Unique identifier for the target message thread of the forum topic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

class Object

trait Matchable

class Any
Show all

Value parameters

chatId: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
messageId: Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value parameters

sticker: A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements.
stickerFormat: Format of the sticker, must be one of “static”, “animated”, “video”
userId: User identifier of sticker file owner

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

telegramium.bots.client

Members list

Type members

Classlikes

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

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

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

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes