TelegramTrait
trait TelegramTrait
Constants
| BOT_API_URL |
|
Methods
No description
Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
Use this method to send text messages. On success, the sent Message is returned.
Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
Use this method to send photos. On success, the sent Message is returned.
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
Use this method to send point on the map. On success, the sent Message is returned.
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to send information about a venue. On success, the sent Message is returned.
Use this method to send phone contacts. On success, the sent Message is returned.
Use this method to send a native poll. On success, the sent Message is returned.
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot
Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
Use this method to get the number of members in a chat. Returns Int on success.
Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
Use this method to get a sticker set. On success, a StickerSet object is returned.
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
Use this method to delete a sticker from a set created by the bot. Returns True on success.
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
Use this method to send answers to an inline query. On success, True is returned.
Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
Use this method to send invoices. On success, the sent Message is returned.
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this method to send a game. On success, the sent Message is returned.
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
Details
at line 47
abstract
sendRequest(string $name, array $data = [])
No description
at line 56
array
getUpdates(int|null $offset = null, int|null $limit = null, int|null $timeout = null, array|null $allowed_updates = null)
Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
at line 67
bool
setWebhook(string $url, InputFileInterface|null $certificate = null, string|null $ip_address = null, int|null $max_connections = null, array|null $allowed_updates = null, bool|null $drop_pending_updates = null, string|null $secret_token = null)
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.
at line 82
bool
deleteWebhook(bool|null $drop_pending_updates = null)
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
at line 90
WebhookInfo
getWebhookInfo()
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
at line 98
User
getMe()
A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
at line 106
bool
logOut()
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
at line 114
bool
close()
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
at line 126
Message
sendMessage(int|string $chat_id, string $text, int|null $message_thread_id = null, string|null $parse_mode = null, array|null $entities = null, bool|null $disable_web_page_preview = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send text messages. On success, the sent Message is returned.
at line 148
Message
forwardMessage(int|string $chat_id, int|string $from_chat_id, int $message_id, int|null $message_thread_id = null, bool|null $disable_notification = null, bool|null $protect_content = null)
Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
at line 167
MessageId
copyMessage(int|string $chat_id, int|string $from_chat_id, int $message_id, int|null $message_thread_id = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
at line 192
Message
sendPhoto(int|string $chat_id, InputFileInterface|string $photo, int|null $message_thread_id = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, bool|null $has_spoiler = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send photos. On success, the sent Message is returned.
at line 219
Message
sendAudio(int|string $chat_id, InputFileInterface|string $audio, int|null $message_thread_id = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, int|null $duration = null, string|null $performer = null, string|null $title = null, InputFileInterface|string|null $thumb = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.
at line 248
Message
sendDocument(int|string $chat_id, InputFileInterface|string $document, int|null $message_thread_id = null, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, bool|null $disable_content_type_detection = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
at line 275
Message
sendVideo(int|string $chat_id, InputFileInterface|string $video, int|null $message_thread_id = null, int|null $duration = null, int|null $width = null, int|null $height = null, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, bool|null $has_spoiler = null, bool|null $supports_streaming = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
at line 306
Message
sendAnimation(int|string $chat_id, InputFileInterface|string $animation, int|null $message_thread_id = null, int|null $duration = null, int|null $width = null, int|null $height = null, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, bool|null $has_spoiler = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
at line 335
Message
sendVoice(int|string $chat_id, InputFileInterface|string $voice, int|null $message_thread_id = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, int|null $duration = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
at line 360
Message
sendVideoNote(int|string $chat_id, InputFileInterface|string $video_note, int|null $message_thread_id = null, int|null $duration = null, int|null $length = null, InputFileInterface|string|null $thumb = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
at line 384
array
sendMediaGroup(int|string $chat_id, array $media, int|null $message_thread_id = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null)
Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
at line 402
Message
sendLocation(int|string $chat_id, float $latitude, float $longitude, int|null $message_thread_id = null, float|null $horizontal_accuracy = null, int|null $live_period = null, int|null $heading = null, int|null $proximity_alert_radius = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send point on the map. On success, the sent Message is returned.
at line 427
Message|bool
editMessageLiveLocation(float $latitude, float $longitude, int|string|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null, float|null $horizontal_accuracy = null, int|null $heading = null, int|null $proximity_alert_radius = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
at line 448
Message|bool
stopMessageLiveLocation(int|string|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
at line 463
Message
sendVenue(int|string $chat_id, float $latitude, float $longitude, string $title, string $address, int|null $message_thread_id = null, string|null $foursquare_id = null, string|null $foursquare_type = null, string|null $google_place_id = null, string|null $google_place_type = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send information about a venue. On success, the sent Message is returned.
at line 489
Message
sendContact(int|string $chat_id, string $phone_number, string $first_name, int|null $message_thread_id = null, string|null $last_name = null, string|null $vcard = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send phone contacts. On success, the sent Message is returned.
at line 513
Message
sendPoll(int|string $chat_id, string $question, array $options, int|null $message_thread_id = null, bool|null $is_anonymous = null, string|null $type = null, bool|null $allows_multiple_answers = null, int|null $correct_option_id = null, string|null $explanation = null, string|null $explanation_parse_mode = null, array|null $explanation_entities = null, int|null $open_period = null, int|null $close_date = null, bool|null $is_closed = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send a native poll. On success, the sent Message is returned.
at line 543
Message
sendDice(int|string $chat_id, int|null $message_thread_id = null, string|null $emoji = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
at line 562
bool
sendChatAction(int|string $chat_id, string $action, int|null $message_thread_id = null)
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
at line 570
UserProfilePhotos
getUserProfilePhotos(int $user_id, int|null $offset = null, int|null $limit = null)
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
at line 579
File
getFile(string $file_id)
Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot
Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
at line 589
bool
banChatMember(int|string $chat_id, int $user_id, int|null $until_date = null, bool|null $revoke_messages = null)
Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
at line 599
bool
unbanChatMember(int|string $chat_id, int $user_id, bool|null $only_if_banned = null)
Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
at line 609
bool
restrictChatMember(int|string $chat_id, int $user_id, ChatPermissions $permissions, int|null $until_date = null)
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
at line 619
bool
promoteChatMember(int|string $chat_id, int $user_id, bool|null $is_anonymous = null, bool|null $can_manage_chat = null, bool|null $can_post_messages = null, bool|null $can_edit_messages = null, bool|null $can_delete_messages = null, bool|null $can_manage_video_chats = null, bool|null $can_restrict_members = null, bool|null $can_promote_members = null, bool|null $can_change_info = null, bool|null $can_invite_users = null, bool|null $can_pin_messages = null, bool|null $can_manage_topics = null)
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
at line 643
bool
setChatAdministratorCustomTitle(int|string $chat_id, int $user_id, string $custom_title)
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
at line 653
bool
banChatSenderChat(int|string $chat_id, int $sender_chat_id)
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
at line 663
bool
unbanChatSenderChat(int|string $chat_id, int $sender_chat_id)
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
at line 673
bool
setChatPermissions(int|string $chat_id, ChatPermissions $permissions)
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
at line 683
string
exportChatInviteLink(int|string $chat_id)
Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
at line 693
ChatInviteLink
createChatInviteLink(int|string $chat_id, string|null $name = null, int|null $expire_date = null, int|null $member_limit = null, bool|null $creates_join_request = null)
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
at line 708
ChatInviteLink
editChatInviteLink(int|string $chat_id, string $invite_link, string|null $name = null, int|null $expire_date = null, int|null $member_limit = null, bool|null $creates_join_request = null)
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
at line 724
ChatInviteLink
revokeChatInviteLink(int|string $chat_id, string $invite_link)
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
at line 734
bool
approveChatJoinRequest(int|string $chat_id, int $user_id)
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
at line 744
bool
declineChatJoinRequest(int|string $chat_id, int $user_id)
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
at line 754
bool
setChatPhoto(int|string $chat_id, InputFileInterface $photo)
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
at line 764
bool
deleteChatPhoto(int|string $chat_id)
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
at line 774
bool
setChatTitle(int|string $chat_id, string $title)
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
at line 784
bool
setChatDescription(int|string $chat_id, string|null $description = null)
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
at line 794
bool
pinChatMessage(int|string $chat_id, int $message_id, bool|null $disable_notification = null)
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
at line 804
bool
unpinChatMessage(int|string $chat_id, int|null $message_id = null)
Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
at line 814
bool
unpinAllChatMessages(int|string $chat_id)
Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
at line 824
bool
leaveChat(int|string $chat_id)
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
at line 834
Chat
getChat(int|string $chat_id)
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
at line 846
array
getChatAdministrators(int|string $chat_id)
Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
at line 856
int
getChatMemberCount(int|string $chat_id)
Use this method to get the number of members in a chat. Returns Int on success.
at line 866
ChatMemberInterface
getChatMember(int|string $chat_id, int $user_id)
Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.
at line 876
bool
setChatStickerSet(int|string $chat_id, string $sticker_set_name)
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
at line 886
bool
deleteChatStickerSet(int|string $chat_id)
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
at line 896
array
getForumTopicIconStickers()
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
at line 906
ForumTopic
createForumTopic(int|string $chat_id, string $name, int|null $icon_color = null, string|null $icon_custom_emoji_id = null)
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
at line 916
bool
editForumTopic(int|string $chat_id, int $message_thread_id, string|null $name = null, string|null $icon_custom_emoji_id = null)
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
at line 926
bool
closeForumTopic(int|string $chat_id, int $message_thread_id)
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
at line 936
bool
reopenForumTopic(int|string $chat_id, int $message_thread_id)
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
at line 946
bool
deleteForumTopic(int|string $chat_id, int $message_thread_id)
Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
at line 956
bool
unpinAllForumTopicMessages(int|string $chat_id, int $message_thread_id)
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
at line 966
bool
editGeneralForumTopic(int|string $chat_id, string $name)
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
at line 976
bool
closeGeneralForumTopic(int|string $chat_id)
Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
at line 986
bool
reopenGeneralForumTopic(int|string $chat_id)
Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
at line 996
bool
hideGeneralForumTopic(int|string $chat_id)
Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
at line 1006
bool
unhideGeneralForumTopic(int|string $chat_id)
Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
at line 1014
bool
answerCallbackQuery(string $callback_query_id, string|null $text = null, bool|null $show_alert = null, string|null $url = null, int|null $cache_time = null)
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
at line 1029
bool
setMyCommands(array $commands, BotCommandScopeInterface|null $scope = null, string|null $language_code = null)
Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
at line 1037
bool
deleteMyCommands(BotCommandScopeInterface|null $scope = null, string|null $language_code = null)
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
at line 1047
array
getMyCommands(BotCommandScopeInterface|null $scope = null, string|null $language_code = null)
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
at line 1055
bool
setChatMenuButton(int|null $chat_id = null, MenuButtonInterface|null $menu_button = null)
Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
at line 1063
MenuButtonInterface
getChatMenuButton(int|null $chat_id = null)
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
at line 1071
bool
setMyDefaultAdministratorRights(ChatAdministratorRights|null $rights = null, bool|null $for_channels = null)
Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
at line 1079
ChatAdministratorRights
getMyDefaultAdministratorRights(bool|null $for_channels = null)
Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
at line 1092
Message|bool
editMessageText(string $text, int|string|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null, string|null $parse_mode = null, array|null $entities = null, bool|null $disable_web_page_preview = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
at line 1113
Message|bool
editMessageCaption(int|string|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null, string|null $caption = null, string|null $parse_mode = null, array|null $caption_entities = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
at line 1132
Message|bool
editMessageMedia(InputMediaInterface $media, int|string|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
at line 1149
Message|bool
editMessageReplyMarkup(int|string|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
at line 1163
Poll
stopPoll(int|string $chat_id, int $message_id, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
at line 1182
bool
deleteMessage(int|string $chat_id, int $message_id)
Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- Service messages about a supergroup, channel, or forum topic creation can't be deleted.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.
at line 1194
Message
sendSticker(int|string $chat_id, InputFileInterface|string $sticker, int|null $message_thread_id = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|ForceReply|null $reply_markup = null)
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
at line 1210
StickerSet
getStickerSet(string $name)
Use this method to get a sticker set. On success, a StickerSet object is returned.
at line 1222
array
getCustomEmojiStickers(array $custom_emoji_ids)
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
at line 1230
File
uploadStickerFile(int $user_id, InputFileInterface $png_sticker)
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
at line 1240
bool
createNewStickerSet(int $user_id, string $name, string $title, string $emojis, InputFileInterface|string|null $png_sticker = null, InputFileInterface|null $tgs_sticker = null, InputFileInterface|null $webm_sticker = null, string|null $sticker_type = null, MaskPosition|null $mask_position = null)
Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.
at line 1259
bool
addStickerToSet(int $user_id, string $name, string $emojis, InputFileInterface|string|null $png_sticker = null, InputFileInterface|null $tgs_sticker = null, InputFileInterface|null $webm_sticker = null, MaskPosition|null $mask_position = null)
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
at line 1274
bool
setStickerPositionInSet(string $sticker, int $position)
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
at line 1282
bool
deleteStickerFromSet(string $sticker)
Use this method to delete a sticker from a set created by the bot. Returns True on success.
at line 1292
bool
setStickerSetThumb(string $name, int $user_id, InputFileInterface|string|null $thumb = null)
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
at line 1303
bool
answerInlineQuery(string $inline_query_id, array $results, int|null $cache_time = null, bool|null $is_personal = null, string|null $next_offset = null, string|null $switch_pm_text = null, string|null $switch_pm_parameter = null)
Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
at line 1318
SentWebAppMessage
answerWebAppQuery(string $web_app_query_id, InlineQueryResultInterface $result)
Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
at line 1330
Message
sendInvoice(int|string $chat_id, string $title, string $description, string $payload, string $provider_token, string $currency, array $prices, int|null $message_thread_id = null, int|null $max_tip_amount = null, array|null $suggested_tip_amounts = null, string|null $start_parameter = null, string|null $provider_data = null, string|null $photo_url = null, int|null $photo_size = null, int|null $photo_width = null, int|null $photo_height = null, bool|null $need_name = null, bool|null $need_phone_number = null, bool|null $need_email = null, bool|null $need_shipping_address = null, bool|null $send_phone_number_to_provider = null, bool|null $send_email_to_provider = null, bool|null $is_flexible = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to send invoices. On success, the sent Message is returned.
at line 1369
string
createInvoiceLink(string $title, string $description, string $payload, string $provider_token, string $currency, array $prices, int|null $max_tip_amount = null, array|null $suggested_tip_amounts = null, string|null $provider_data = null, string|null $photo_url = null, int|null $photo_size = null, int|null $photo_width = null, int|null $photo_height = null, bool|null $need_name = null, bool|null $need_phone_number = null, bool|null $need_email = null, bool|null $need_shipping_address = null, bool|null $send_phone_number_to_provider = null, bool|null $send_email_to_provider = null, bool|null $is_flexible = null)
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
at line 1399
bool
answerShippingQuery(string $shipping_query_id, bool $ok, array|null $shipping_options = null, string|null $error_message = null)
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
at line 1407
bool
answerPreCheckoutQuery(string $pre_checkout_query_id, bool $ok, string|null $error_message = null)
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
at line 1418
bool
setPassportDataErrors(int $user_id, array $errors)
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
at line 1426
Message
sendGame(int $chat_id, string $game_short_name, int|null $message_thread_id = null, bool|null $disable_notification = null, bool|null $protect_content = null, int|null $reply_to_message_id = null, bool|null $allow_sending_without_reply = null, InlineKeyboardMarkup|null $reply_markup = null)
Use this method to send a game. On success, the sent Message is returned.
at line 1444
Message|bool
setGameScore(int $user_id, int $score, bool|null $force = null, bool|null $disable_edit_message = null, int|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null)
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
at line 1461
array
getGameHighScores(int $user_id, int|null $chat_id = null, int|null $message_id = null, string|null $inline_message_id = null)
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.