package api
- Alphabetic
- Public
- Protected
Type Members
- case class Audio(fileId: String, duration: Int, performer: Option[String] = None, title: Option[String] = None, mimeType: Option[String] = None, fileSize: Option[Int] = None) extends Product with Serializable
Audio
Audio
This object represents an audio file (voice note).
- fileId
Unique identifier for this file
- duration
Duration of the audio in seconds as defined by sender
- performer
Optional. Performer of the audio as defined by sender or by audio tags
- title
Optional. Title of the audio as defined by sender or by audio tags
- mimeType
Optional. MIME type of the file as defined by sender
- fileSize
Optional. File size
- case class Contact(phoneNumber: String, firstName: String, lastName: Option[String] = None, userId: Option[Int] = None) extends Product with Serializable
Contact
Contact
This object represents a phone contact.
- phoneNumber
Contact's phone number
- firstName
Contact's first name
- lastName
Optional. Contact's last name
- userId
Optional. Contact's user identifier in Telegram
- case class Document(fileId: String, thumb: Option[PhotoSize] = None, fileName: Option[String] = None, mimeType: Option[String] = None, fileSize: Option[Int] = None) extends Product with Serializable
Document
Document
This object represents a general file (as opposed to photos and audio files).
- fileId
Unique file identifier
- thumb
Optional. Document thumbnail as defined by sender
- fileName
Optional. Original filename as defined by sender
- mimeType
Optional. MIME type of the file as defined by sender
- fileSize
Optional. File size
- case class ForceReply(forceReply: Boolean, selective: Option[Boolean] = None) extends ReplyMarkup with Product with Serializable
ForceReply
ForceReply
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.
- forceReply
True Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'
- 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 (has replyToMessage_id), sender of the original message. Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll: Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish. Guide the user through a step-by-step process. ‘Please send me your question’, ‘Cool, now let’s add the first answer option‘, ’Great. Keep adding answer options, then send /done when you‘re ready’. The last option is definitely more attractive. And if you use ForceReply in your bot‘s questions, it will receive the user’s answers even if it only receives replies, commands and mentions — without any extra work for the user.
- case class GroupChat(id: Int, title: String) extends Product with Serializable
GroupChat
GroupChat
This object represents a group chat.
- id
Unique identifier for this group chat
- title
Group name
- trait InputFile extends AnyRef
Created by mukel on 8/16/15.
- case class Location(longitude: Double, latitude: Double) extends Product with Serializable
Location
Location
This object represents a point on the map.
- longitude
Longitude as defined by sender
- latitude
Latitude as defined by sender
- class Message extends AnyRef
Message
Message
This object represents a message.
- case class PhotoSize(fileId: String, width: Int, height: Int, fileSize: Option[Int] = None) extends Product with Serializable
PhotoSize
PhotoSize
This object represents one size of a photo or a file / sticker thumbnail.
- fileId
Unique identifier for this file
- width
Photo width
- height
Photo height
- fileSize
Optional. File size
- case class ReplyKeyboardHide(hideKeyboard: Boolean, selective: Option[Boolean] = None) extends ReplyMarkup with Product with Serializable
ReplyKeyboardHide
ReplyKeyboardHide
Upon receiving a message with this object, Telegram clients will hide 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).
- hideKeyboard
True Requests clients to hide the custom keyboard
- selective
Optional. Use this parameter if you want to hide 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 (has replyToMessage_id), sender of the original message. Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
- case class ReplyKeyboardMarkup(keyboard: Array[Array[String]], resizeKeyboard: Option[Boolean] = None, oneTimeKeyboard: Option[Boolean] = None, selective: Option[Boolean] = None) extends ReplyMarkup with Product with Serializable
ReplyKeyboardMarkup
ReplyKeyboardMarkup
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
- keyboard
Array of button rows, each represented by an Array of Strings
- 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.
- oneTimeKeyboard
Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false.
- 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 (has replyToMessage_id), 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.
- trait ReplyMarkup extends AnyRef
ReplyMarkup
ReplyMarkup
Base for custom (keyboard) markups.
- case class Sticker(fileId: String, width: Int, height: Int, thumb: Option[PhotoSize] = None, fileSize: Option[Int] = None) extends Product with Serializable
Sticker
Sticker
This object represents a sticker.
- fileId
Unique identifier for this file
- width
Sticker width
- height
Sticker height
- thumb
Optional. Sticker thumbnail in .webp or .jpg format
- fileSize
Optional. File size
- class TelegramBotApi extends AnyRef
TelegramBotApi
TelegramBotApi
Official Telegram Bot API wrapper.
- case class Update(updateId: Int, message: Option[Message] = None) extends Product with Serializable
Update
Update
This object represents an incoming update.
- updateId
The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID 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.
- message
Optional. New incoming message of any kind — text, photo, sticker, etc.
- case class User(id: Int, firstName: String, lastName: Option[String] = None, username: Option[String] = None) extends Product with Serializable
User
User
This object represents a Telegram user or bot.
- id
Unique identifier for this user or bot
- firstName
User‘s or bot’s first namenc
- lastName
Optional. User‘s or bot’s last name
- username
Optional. User‘s or bot’s username
- case class UserOrGroupChat(id: Int) extends Product with Serializable
Created by mukel on 8/6/15.
- case class UserProfilePhotos(totalCount: Int, photos: Array[Array[PhotoSize]]) extends Product with Serializable
UserProfilePhotos
UserProfilePhotos
This object represent a user's profile pictures.
- totalCount
Total number of profile pictures the target user has
- photos
Requested profile pictures (in up to 4 sizes each)
- case class Video(fileId: String, width: Int, height: Int, duration: Int, thumb: Option[PhotoSize] = None, mimeType: Option[String] = None, fileSize: Option[Int] = None) extends Product with Serializable
Video
Video
This object represents a video file.
- fileId
Unique identifier for this file
- width
Video width as defined by sender
- height
Video height as defined by sender
- duration
Duration of the video in seconds as defined by sender
- thumb
Optional. Video thumbnail
- mimeType
Optional. Mime type of a file as defined by sender
- fileSize
Optional. File size
- case class Voice(fileId: String, duration: Int, mimeType: Option[String], fileSize: Option[Int]) extends Product with Serializable
Voice
Voice
This object represents a voice note.
- fileId
Unique identifier for this file
- duration
Duration of the audio in seconds as defined by sender
- mimeType
Optional. MIME type of the file as defined by sender
- fileSize
Optional. File size
Value Members
- object ChatAction extends Enumeration
ChatAction
ChatAction
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_audio or upload_audio for audio files, upload_document for general files, find_location for location data.
- object InputFile
- object InputFilePimps
- object TelegramBotApi