Lightweight PHP wrapper library for Telegram Bot API
Bot API version: v7.11 (October 31, 2024) - Snapshot Link
PHP version: 8.3 - Unknown compatibility with earlier (8+) or later versions.
- Minimal, Doesn't get in your way
- Fully documented, Employs identical names for methods and classes as those found in the official API
- Uses Guzzle as the HTTP client
- Provides type hints for IDE autocompletion
- TODO: Complete implementation of all methods and classes
- TODO: Concurrent (bulk) requests: Has been experimentally implemented for some methods
- TODO: Async requests
- TODO: Provide helper utilities (e.g. For formatting messages using HTML or Markdown) and builtin checks (e.g. Making sure the message text's length does not exceed 4096 chars)
Litegram is still in early development stages so expect bugs and non-backward compatible changes.
Use Github Issues for comments, bug reports and questions.
composer require amirrh6/litegram dev-main
require_once './vendor/autoload.php';
// --- --- --- --- --- --- ---
$token = '0123456789:...';
$some_chat_id = '-100...';
// Options for Guzzle (https://docs.guzzlephp.org/en/stable/request-options.html)
$global_guzzle_options = [
'timeout' => 10,
// 'proxy' => 'http://localhost:8118',
];
// --- --- --- --- --- --- ---
use Litegram\SendMessageParams;
use Litegram\InlineKeyboardMarkup;
use Litegram\InlineKeyboardButton;
use Litegram\TelegramMethods;
try {
// If the request doesn't fail, an object of type Litegram\Message will be returned
$res = TelegramMethods::sendMessage(
token: $token,
params: new SendMessageParams(
chat_id: $some_chat_id,
text: 'Test',
reply_markup: new InlineKeyboardMarkup([
[
new InlineKeyboardButton('Hi', callback_data: 'say_hi'),
new InlineKeyboardButton('Bye', callback_data: 'say_bye'),
],
[new InlineKeyboardButton('Close', callback_data: 'close')],
]),
),
// If you don't pass a guzzle_options array to each method or pass an empty one (default parameter), Litegram will check for existence of a global variable
// named 'global_guzzle_options' and use it instead, if it exists.
guzzle_options: [
'timeout' => 5,
// 'proxy' => 'http://localhost:8118',
]
);
var_dump('Result:', $res);
} catch (\Throwable $th) {
var_dump('Exception:', $th);
}
This file provides usage example for some primary methods.
Over a year ago, during my free time between university classes, I started working on another Telegram bot. I wanted to challenge myself by creating my own wrapper library for it. Although the bot project was eventually abandoned, I decided to revive the wrapper library, and here we are today.
* Make sure you view this section on Github rather than Packagist as it doesn't display checkmarks correctly.
(4/4 methods implemented, 2/2 classes implemented)
(50/150 classes implemented)
- User
-
_get_full_name()
helper method is provided by Litegram
- Chat
- ChatFullInfo
- Message
- MessageId
- InaccessibleMessage
- MaybeInaccessibleMessage : InaccessibleMessage | Message
- MessageEntity
- TextQuote
- ExternalReplyInfo
- ReplyParameters
- MessageOrigin
- PhotoSize
- Animation
- Audio
- Document
- Story
- Video
- VideoNote
- Voice
- PaidMediaInfo
- PaidMedia
- Contact
- Dice
- PollOption
- InputPollOption
- PollAnswer
- Poll
- Location
- Venue
- WebAppData
- ProximityAlertTriggered
- MessageAutoDeleteTimerChanged
- ChatBoostAdded
- BackgroundFill
- BackgroundFillSolid
- BackgroundFillGradient
- BackgroundFillFreeformGradient
- BackgroundType
- BackgroundTypeFill
- BackgroundTypeWallpaper
- BackgroundTypePattern
- BackgroundTypeChatTheme
- ChatBackground
- ForumTopicCreated
- ForumTopicClosed
- ForumTopicEdited
- ForumTopicReopened
- GeneralForumTopicHidden
- GeneralForumTopicUnhidden
- SharedUser
- UsersShared
- ChatShared
- WriteAccessAllowed
- VideoChatScheduled
- VideoChatStarted
- VideoChatEnded
- VideoChatParticipantsInvited
- GiveawayCreated
- Giveaway
- GiveawayWinners
- GiveawayCompleted
- LinkPreviewOptions
- UserProfilePhotos
- File
- WebAppInfo
- ReplyKeyboardMarkup
- KeyboardButton
- KeyboardButtonRequestUsers
- KeyboardButtonRequestChat
- KeyboardButtonPollType
- ReplyKeyboardRemove
- InlineKeyboardMarkup
- InlineKeyboardButton
- LoginUrl
- SwitchInlineQueryChosenChat
- CopyTextButton
- CallbackQuery
- ForceReply
- ChatPhoto
- ChatInviteLink
- ChatAdministratorRights
- ChatMemberUpdated
- ChatMember
- ChatJoinRequest
- ChatPermissions
- Birthdate
- BusinessIntro
- BusinessLocation
- BusinessOpeningHoursInterval
- BusinessOpeningHours
- ChatLocation
- ReactionType
- ReactionCount
- MessageReactionUpdated
- MessageReactionCountUpdated
- ForumTopic
- BotCommand
- BotCommandScope
- BotName
- BotDescription
- BotShortDescription
- MenuButton
- ChatBoostSource
- ChatBoost
- ChatBoostUpdated
- ChatBoostRemoved
- UserChatBoosts
- BusinessConnection
- BusinessMessagesDeleted
- ResponseParameters
- InputMedia
- InputFile
- InputPaidMedia
(8/85 methods implemented)
* Every method here has a signature similar to:
static function sendMessage(
string $token,
SendMessageParams $params,
$guzzle_options = []
): Message
See here for usage and examples.
- getMe
- logOut
- close
- sendMessage
- forwardMessage
- forwardMessages
- copyMessage *
- copyMessages
- sendPhoto
- sendAudio
- sendDocument
- sendVideo
- sendAnimation
- sendVoice
- sendVideoNote
- sendPaidMedia
- sendMediaGroup
- sendLocation
- sendVenue
- sendContact
- sendPoll
- sendDice
- sendChatAction
- setMessageReaction
- getUserProfilePhotos
- getFile
- banChatMember
- unbanChatMember
- restrictChatMember
- promoteChatMember
- setChatAdministratorCustomTitle
- banChatSenderChat
- unbanChatSenderChat
- setChatPermissions
- exportChatInviteLink
- createChatInviteLink
- editChatInviteLink
- createChatSubscriptionInviteLink
- editChatSubscriptionInviteLink
- revokeChatInviteLink
- approveChatJoinRequest
- declineChatJoinRequest
- setChatPhoto
- deleteChatPhoto
- setChatTitle
- setChatDescription
- pinChatMessage
- unpinChatMessage
- unpinAllChatMessages
- leaveChat
- getChat
- getChatAdministrators
- getChatMemberCount
- getChatMember
- setChatStickerSet
- deleteChatStickerSet
- getForumTopicIconStickers
- createForumTopic
- editForumTopic
- closeForumTopic
- reopenForumTopic
- deleteForumTopic
- unpinAllForumTopicMessages
- editGeneralForumTopic
- closeGeneralForumTopic
- reopenGeneralForumTopic
- hideGeneralForumTopic
- unhideGeneralForumTopic
- unpinAllGeneralForumTopicMessages
- answerCallbackQuery
- getUserChatBoosts
- getBusinessConnection
- setMyCommands
- deleteMyCommands
- getMyCommands
- setMyName
- getMyName
- setMyDescription
- getMyDescription
- setMyShortDescription
- getMyShortDescription
- setChatMenuButton
- getChatMenuButton
- setMyDefaultAdministratorRights
- getMyDefaultAdministratorRights
* Experimental bulk (concurrent) version of this method is available. These methods are named like this: copyMessage()
---> _bulkCopyMessage()
(1/9 methods implemented)
- editMessageText
- editMessageCaption
- editMessageMedia
- editMessageLiveLocation
- stopMessageLiveLocation
- editMessageReplyMarkup
- stopPoll
- deleteMessage
- deleteMessages
(0/16 methods implemented, 0/4 classes implemented)
- Sticker
- StickerSet
- MaskPosition
- InputSticker
- sendSticker
- getStickerSet
- getCustomEmojiStickers
- uploadStickerFile
- createNewStickerSet
- addStickerToSet
- setStickerPositionInSet
- deleteStickerFromSet
- replaceStickerInSet
- setStickerEmojiList
- setStickerKeywords
- setStickerMaskPosition
- setStickerSetTitle
- setStickerSetThumbnail
- setCustomEmojiStickerSetThumbnail
- deleteStickerSet
(0/2 methods implemented, 3/29 classes implemented + 2 union types)
- InlineQuery
- answerInlineQuery
- InlineQueryResultsButton
- InlineQueryResult
- InputMessageContent
- ChosenInlineResult
- answerWebAppQuery
- SentWebAppMessage
(0/6 methods implemented, 3/19 classes implemented + 2 union types)
- sendInvoice
- createInvoiceLink
- answerShippingQuery
- answerPreCheckoutQuery
- getStarTransactions
- refundStarPayment
- LabeledPrice
- Invoice
- ShippingAddress
- OrderInfo
- ShippingOption
- SuccessfulPayment
- RefundedPayment
- ShippingQuery
- PreCheckoutQuery
- PaidMediaPurchased
- RevenueWithdrawalState
- TransactionPartner
- StarTransaction
- StarTransactions
(0/1 methods implemented, 0/13 classes implemented + 1 union type)
- PassportData
- PassportFile
- EncryptedPassportElement
- EncryptedCredentials
- setPassportDataErrors
- PassportElementError
(0/3 methods implemented, 0/3 classes implemented)