phpbotgram

ChatJoinRequest extends TelegramObject
in package

FinalYes

Represents a join request sent to a chat.

Source: https://core.telegram.org/bots/api#chatjoinrequest

Table of Contents

Constants

WireNames  : array<string|int, mixed> = ['fromUser' => 'from']

Properties

$bio  : string|null
$bot  : Bot|null
$chat  : Chat
$date  : DateTime
$fromUser  : User
$inviteLink  : ChatInviteLink|null
$queryId  : string|null
$userChatId  : int

Methods

__construct()  : mixed
answer()  : SendMessage
answerAnimation()  : SendAnimation
answerAnimationPm()  : SendAnimation
answerAudio()  : SendAudio
answerAudioPm()  : SendAudio
answerContact()  : SendContact
answerContactPm()  : SendContact
answerDice()  : SendDice
answerDicePm()  : SendDice
answerDocument()  : SendDocument
answerDocumentPm()  : SendDocument
answerGame()  : SendGame
answerGamePm()  : SendGame
answerInvoice()  : SendInvoice
answerInvoicePm()  : SendInvoice
answerLocation()  : SendLocation
answerLocationPm()  : SendLocation
answerMediaGroup()  : SendMediaGroup
answerMediaGroupPm()  : SendMediaGroup
answerPhoto()  : SendPhoto
answerPhotoPm()  : SendPhoto
answerPm()  : SendMessage
answerPoll()  : SendPoll
answerPollPm()  : SendPoll
answerQuery()  : AnswerChatJoinRequestQuery
answerSticker()  : SendSticker
answerStickerPm()  : SendSticker
answerVenue()  : SendVenue
answerVenuePm()  : SendVenue
answerVideo()  : SendVideo
answerVideoNote()  : SendVideoNote
answerVideoNotePm()  : SendVideoNote
answerVideoPm()  : SendVideo
answerVoice()  : SendVoice
answerVoicePm()  : SendVoice
approve()  : ApproveChatJoinRequest
as_()  : static
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
decline()  : DeclineChatJoinRequest
sendWebapp()  : SendChatJoinRequestWebApp
withBot()  : static
Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.

Constants

WireNames

public array<string|int, mixed> WireNames = ['fromUser' => 'from']

Properties

Methods

__construct()

public __construct(Chat $chat, User $fromUser, int $userChatId, DateTime $date[, string|null $bio = null ][, ChatInviteLink|null $inviteLink = null ][, string|null $queryId = null ][, Bot|null $bot = null ]) : mixed
Parameters
$chat : Chat
$fromUser : User
$userChatId : int
$date : DateTime
$bio : string|null = null
$inviteLink : ChatInviteLink|null = null
$queryId : string|null = null
$bot : Bot|null = null

answer()

public answer(string $text[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $entities = null ][, BotDefault|LinkPreviewOptions $linkPreviewOptions = new BotDefault('link_preview') ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendMessage
Parameters
$text : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$entities : null|array<int, MessageEntity> = null
$linkPreviewOptions : BotDefault|LinkPreviewOptions = new BotDefault('link_preview')
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendMessage

answerAnimation()

public answerAnimation(InputFile|string $animation[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, int|null $duration = null ][, int|null $width = null ][, int|null $height = null ][, InputFile|null $thumbnail = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|BotDefault $showCaptionAboveMedia = new BotDefault('show_caption_above_media') ][, bool|null $hasSpoiler = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendAnimation
Parameters
$animation : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$duration : int|null = null
$width : int|null = null
$height : int|null = null
$thumbnail : InputFile|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$showCaptionAboveMedia : bool|BotDefault = new BotDefault('show_caption_above_media')
$hasSpoiler : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendAnimation

answerAnimationPm()

public answerAnimationPm(InputFile|string $animation[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, int|null $duration = null ][, int|null $width = null ][, int|null $height = null ][, InputFile|null $thumbnail = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|BotDefault $showCaptionAboveMedia = new BotDefault('show_caption_above_media') ][, bool|null $hasSpoiler = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendAnimation
Parameters
$animation : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$duration : int|null = null
$width : int|null = null
$height : int|null = null
$thumbnail : InputFile|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$showCaptionAboveMedia : bool|BotDefault = new BotDefault('show_caption_above_media')
$hasSpoiler : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendAnimation

answerAudio()

public answerAudio(InputFile|string $audio[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, int|null $duration = null ][, string|null $performer = null ][, string|null $title = null ][, InputFile|null $thumbnail = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendAudio
Parameters
$audio : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$duration : int|null = null
$performer : string|null = null
$title : string|null = null
$thumbnail : InputFile|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendAudio

answerAudioPm()

public answerAudioPm(InputFile|string $audio[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, int|null $duration = null ][, string|null $performer = null ][, string|null $title = null ][, InputFile|null $thumbnail = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendAudio
Parameters
$audio : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$duration : int|null = null
$performer : string|null = null
$title : string|null = null
$thumbnail : InputFile|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendAudio

answerContact()

public answerContact(string $phoneNumber, string $firstName[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $lastName = null ][, string|null $vcard = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendContact
Parameters
$phoneNumber : string
$firstName : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$lastName : string|null = null
$vcard : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendContact

answerContactPm()

public answerContactPm(string $phoneNumber, string $firstName[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $lastName = null ][, string|null $vcard = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendContact
Parameters
$phoneNumber : string
$firstName : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$lastName : string|null = null
$vcard : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendContact

answerDice()

public answerDice([string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $emoji = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendDice
Parameters
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$emoji : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendDice

answerDicePm()

public answerDicePm([string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $emoji = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendDice
Parameters
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$emoji : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendDice

answerDocument()

public answerDocument(InputFile|string $document[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, InputFile|null $thumbnail = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|null $disableContentTypeDetection = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendDocument
Parameters
$document : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$thumbnail : InputFile|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$disableContentTypeDetection : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendDocument

answerDocumentPm()

public answerDocumentPm(InputFile|string $document[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, InputFile|null $thumbnail = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|null $disableContentTypeDetection = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendDocument
Parameters
$document : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$thumbnail : InputFile|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$disableContentTypeDetection : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendDocument

answerGame()

public answerGame(string $gameShortName[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ][, InlineKeyboardMarkup|null $replyMarkup = null ]) : SendGame
Parameters
$gameShortName : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : InlineKeyboardMarkup|null = null
Return values
SendGame

answerGamePm()

public answerGamePm(string $gameShortName[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ][, InlineKeyboardMarkup|null $replyMarkup = null ]) : SendGame
Parameters
$gameShortName : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : InlineKeyboardMarkup|null = null
Return values
SendGame

answerInvoice()

public answerInvoice(string $title, string $description, string $payload, string $currency, array<int, LabeledPrice> $prices[, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $providerToken = null ][, int|null $maxTipAmount = null ][, null|array<int, int> $suggestedTipAmounts = null ][, string|null $startParameter = null ][, string|null $providerData = null ][, string|null $photoUrl = null ][, int|null $photoSize = null ][, int|null $photoWidth = null ][, int|null $photoHeight = null ][, bool|null $needName = null ][, bool|null $needPhoneNumber = null ][, bool|null $needEmail = null ][, bool|null $needShippingAddress = null ][, bool|null $sendPhoneNumberToProvider = null ][, bool|null $sendEmailToProvider = null ][, bool|null $isFlexible = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, InlineKeyboardMarkup|null $replyMarkup = null ]) : SendInvoice
Parameters
$title : string
$description : string
$payload : string
$currency : string
$prices : array<int, LabeledPrice>
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$providerToken : string|null = null
$maxTipAmount : int|null = null
$suggestedTipAmounts : null|array<int, int> = null
$startParameter : string|null = null
$providerData : string|null = null
$photoUrl : string|null = null
$photoSize : int|null = null
$photoWidth : int|null = null
$photoHeight : int|null = null
$needName : bool|null = null
$needPhoneNumber : bool|null = null
$needEmail : bool|null = null
$needShippingAddress : bool|null = null
$sendPhoneNumberToProvider : bool|null = null
$sendEmailToProvider : bool|null = null
$isFlexible : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : InlineKeyboardMarkup|null = null
Return values
SendInvoice

answerInvoicePm()

public answerInvoicePm(string $title, string $description, string $payload, string $currency, array<int, LabeledPrice> $prices[, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $providerToken = null ][, int|null $maxTipAmount = null ][, null|array<int, int> $suggestedTipAmounts = null ][, string|null $startParameter = null ][, string|null $providerData = null ][, string|null $photoUrl = null ][, int|null $photoSize = null ][, int|null $photoWidth = null ][, int|null $photoHeight = null ][, bool|null $needName = null ][, bool|null $needPhoneNumber = null ][, bool|null $needEmail = null ][, bool|null $needShippingAddress = null ][, bool|null $sendPhoneNumberToProvider = null ][, bool|null $sendEmailToProvider = null ][, bool|null $isFlexible = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, InlineKeyboardMarkup|null $replyMarkup = null ]) : SendInvoice
Parameters
$title : string
$description : string
$payload : string
$currency : string
$prices : array<int, LabeledPrice>
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$providerToken : string|null = null
$maxTipAmount : int|null = null
$suggestedTipAmounts : null|array<int, int> = null
$startParameter : string|null = null
$providerData : string|null = null
$photoUrl : string|null = null
$photoSize : int|null = null
$photoWidth : int|null = null
$photoHeight : int|null = null
$needName : bool|null = null
$needPhoneNumber : bool|null = null
$needEmail : bool|null = null
$needShippingAddress : bool|null = null
$sendPhoneNumberToProvider : bool|null = null
$sendEmailToProvider : bool|null = null
$isFlexible : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : InlineKeyboardMarkup|null = null
Return values
SendInvoice

answerLocation()

public answerLocation(float $latitude, float $longitude[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, float|null $horizontalAccuracy = null ][, int|null $livePeriod = null ][, int|null $heading = null ][, int|null $proximityAlertRadius = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendLocation
Parameters
$latitude : float
$longitude : float
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$horizontalAccuracy : float|null = null
$livePeriod : int|null = null
$heading : int|null = null
$proximityAlertRadius : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendLocation

answerLocationPm()

public answerLocationPm(float $latitude, float $longitude[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, float|null $horizontalAccuracy = null ][, int|null $livePeriod = null ][, int|null $heading = null ][, int|null $proximityAlertRadius = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendLocation
Parameters
$latitude : float
$longitude : float
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$horizontalAccuracy : float|null = null
$livePeriod : int|null = null
$heading : int|null = null
$proximityAlertRadius : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendLocation

answerMediaGroup()

public answerMediaGroup(array<int, InputMediaAudio|InputMediaDocument|InputMediaLivePhoto|InputMediaPhoto|InputMediaVideo> $media[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ]) : SendMediaGroup
Parameters
$media : array<int, InputMediaAudio|InputMediaDocument|InputMediaLivePhoto|InputMediaPhoto|InputMediaVideo>
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
Return values
SendMediaGroup

answerMediaGroupPm()

public answerMediaGroupPm(array<int, InputMediaAudio|InputMediaDocument|InputMediaLivePhoto|InputMediaPhoto|InputMediaVideo> $media[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ]) : SendMediaGroup
Parameters
$media : array<int, InputMediaAudio|InputMediaDocument|InputMediaLivePhoto|InputMediaPhoto|InputMediaVideo>
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
Return values
SendMediaGroup

answerPhoto()

public answerPhoto(InputFile|string $photo[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|BotDefault $showCaptionAboveMedia = new BotDefault('show_caption_above_media') ][, bool|null $hasSpoiler = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendPhoto
Parameters
$photo : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$showCaptionAboveMedia : bool|BotDefault = new BotDefault('show_caption_above_media')
$hasSpoiler : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendPhoto

answerPhotoPm()

public answerPhotoPm(InputFile|string $photo[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|BotDefault $showCaptionAboveMedia = new BotDefault('show_caption_above_media') ][, bool|null $hasSpoiler = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendPhoto
Parameters
$photo : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$showCaptionAboveMedia : bool|BotDefault = new BotDefault('show_caption_above_media')
$hasSpoiler : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendPhoto

answerPm()

public answerPm(string $text[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $entities = null ][, BotDefault|LinkPreviewOptions $linkPreviewOptions = new BotDefault('link_preview') ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendMessage
Parameters
$text : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$entities : null|array<int, MessageEntity> = null
$linkPreviewOptions : BotDefault|LinkPreviewOptions = new BotDefault('link_preview')
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendMessage

answerPoll()

public answerPoll(string $question, array<int, InputPollOption|string> $options[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, BotDefault|string $questionParseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $questionEntities = null ][, bool|null $isAnonymous = null ][, string|null $type = null ][, bool|null $allowsMultipleAnswers = null ][, bool|null $allowsRevoting = null ][, bool|null $shuffleOptions = null ][, bool|null $allowAddingOptions = null ][, bool|null $hideResultsUntilCloses = null ][, bool|null $membersOnly = null ][, null|array<int, string> $countryCodes = null ][, null|array<int, int> $correctOptionIds = null ][, string|null $explanation = null ][, BotDefault|string $explanationParseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $explanationEntities = null ][, InputPollMediaInterface|null $explanationMedia = null ][, int|null $openPeriod = null ][, DateInterval|DateTime|int|null $closeDate = null ][, bool|null $isClosed = null ][, string|null $description = null ][, BotDefault|string $descriptionParseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $descriptionEntities = null ][, InputPollMediaInterface|null $media = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendPoll
Parameters
$question : string
$options : array<int, InputPollOption|string>
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$questionParseMode : BotDefault|string = new BotDefault('parse_mode')
$questionEntities : null|array<int, MessageEntity> = null
$isAnonymous : bool|null = null
$type : string|null = null
$allowsMultipleAnswers : bool|null = null
$allowsRevoting : bool|null = null
$shuffleOptions : bool|null = null
$allowAddingOptions : bool|null = null
$hideResultsUntilCloses : bool|null = null
$membersOnly : bool|null = null
$countryCodes : null|array<int, string> = null
$correctOptionIds : null|array<int, int> = null
$explanation : string|null = null
$explanationParseMode : BotDefault|string = new BotDefault('parse_mode')
$explanationEntities : null|array<int, MessageEntity> = null
$explanationMedia : InputPollMediaInterface|null = null
$openPeriod : int|null = null
$closeDate : DateInterval|DateTime|int|null = null
$isClosed : bool|null = null
$description : string|null = null
$descriptionParseMode : BotDefault|string = new BotDefault('parse_mode')
$descriptionEntities : null|array<int, MessageEntity> = null
$media : InputPollMediaInterface|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendPoll

answerPollPm()

public answerPollPm(string $question, array<int, InputPollOption|string> $options[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, BotDefault|string $questionParseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $questionEntities = null ][, bool|null $isAnonymous = null ][, string|null $type = null ][, bool|null $allowsMultipleAnswers = null ][, bool|null $allowsRevoting = null ][, bool|null $shuffleOptions = null ][, bool|null $allowAddingOptions = null ][, bool|null $hideResultsUntilCloses = null ][, bool|null $membersOnly = null ][, null|array<int, string> $countryCodes = null ][, null|array<int, int> $correctOptionIds = null ][, string|null $explanation = null ][, BotDefault|string $explanationParseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $explanationEntities = null ][, InputPollMediaInterface|null $explanationMedia = null ][, int|null $openPeriod = null ][, DateInterval|DateTime|int|null $closeDate = null ][, bool|null $isClosed = null ][, string|null $description = null ][, BotDefault|string $descriptionParseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $descriptionEntities = null ][, InputPollMediaInterface|null $media = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendPoll
Parameters
$question : string
$options : array<int, InputPollOption|string>
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$questionParseMode : BotDefault|string = new BotDefault('parse_mode')
$questionEntities : null|array<int, MessageEntity> = null
$isAnonymous : bool|null = null
$type : string|null = null
$allowsMultipleAnswers : bool|null = null
$allowsRevoting : bool|null = null
$shuffleOptions : bool|null = null
$allowAddingOptions : bool|null = null
$hideResultsUntilCloses : bool|null = null
$membersOnly : bool|null = null
$countryCodes : null|array<int, string> = null
$correctOptionIds : null|array<int, int> = null
$explanation : string|null = null
$explanationParseMode : BotDefault|string = new BotDefault('parse_mode')
$explanationEntities : null|array<int, MessageEntity> = null
$explanationMedia : InputPollMediaInterface|null = null
$openPeriod : int|null = null
$closeDate : DateInterval|DateTime|int|null = null
$isClosed : bool|null = null
$description : string|null = null
$descriptionParseMode : BotDefault|string = new BotDefault('parse_mode')
$descriptionEntities : null|array<int, MessageEntity> = null
$media : InputPollMediaInterface|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendPoll

answerSticker()

public answerSticker(InputFile|string $sticker[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $emoji = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendSticker
Parameters
$sticker : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$emoji : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendSticker

answerStickerPm()

public answerStickerPm(InputFile|string $sticker[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $emoji = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendSticker
Parameters
$sticker : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$emoji : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendSticker

answerVenue()

public answerVenue(float $latitude, float $longitude, string $title, string $address[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $foursquareId = null ][, string|null $foursquareType = null ][, string|null $googlePlaceId = null ][, string|null $googlePlaceType = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVenue
Parameters
$latitude : float
$longitude : float
$title : string
$address : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$foursquareId : string|null = null
$foursquareType : string|null = null
$googlePlaceId : string|null = null
$googlePlaceType : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVenue

answerVenuePm()

public answerVenuePm(float $latitude, float $longitude, string $title, string $address[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $foursquareId = null ][, string|null $foursquareType = null ][, string|null $googlePlaceId = null ][, string|null $googlePlaceType = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVenue
Parameters
$latitude : float
$longitude : float
$title : string
$address : string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$foursquareId : string|null = null
$foursquareType : string|null = null
$googlePlaceId : string|null = null
$googlePlaceType : string|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVenue

answerVideo()

public answerVideo(InputFile|string $video[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, int|null $duration = null ][, int|null $width = null ][, int|null $height = null ][, InputFile|null $thumbnail = null ][, InputFile|string|null $cover = null ][, DateInterval|DateTime|int|null $startTimestamp = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|BotDefault $showCaptionAboveMedia = new BotDefault('show_caption_above_media') ][, bool|null $hasSpoiler = null ][, bool|null $supportsStreaming = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVideo
Parameters
$video : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$duration : int|null = null
$width : int|null = null
$height : int|null = null
$thumbnail : InputFile|null = null
$cover : InputFile|string|null = null
$startTimestamp : DateInterval|DateTime|int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$showCaptionAboveMedia : bool|BotDefault = new BotDefault('show_caption_above_media')
$hasSpoiler : bool|null = null
$supportsStreaming : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVideo

answerVideoNote()

public answerVideoNote(InputFile|string $videoNote[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, int|null $duration = null ][, int|null $length = null ][, InputFile|null $thumbnail = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVideoNote
Parameters
$videoNote : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$duration : int|null = null
$length : int|null = null
$thumbnail : InputFile|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVideoNote

answerVideoNotePm()

public answerVideoNotePm(InputFile|string $videoNote[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, int|null $duration = null ][, int|null $length = null ][, InputFile|null $thumbnail = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVideoNote
Parameters
$videoNote : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$duration : int|null = null
$length : int|null = null
$thumbnail : InputFile|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVideoNote

answerVideoPm()

public answerVideoPm(InputFile|string $video[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, int|null $duration = null ][, int|null $width = null ][, int|null $height = null ][, InputFile|null $thumbnail = null ][, InputFile|string|null $cover = null ][, DateInterval|DateTime|int|null $startTimestamp = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|BotDefault $showCaptionAboveMedia = new BotDefault('show_caption_above_media') ][, bool|null $hasSpoiler = null ][, bool|null $supportsStreaming = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVideo
Parameters
$video : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$duration : int|null = null
$width : int|null = null
$height : int|null = null
$thumbnail : InputFile|null = null
$cover : InputFile|string|null = null
$startTimestamp : DateInterval|DateTime|int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$showCaptionAboveMedia : bool|BotDefault = new BotDefault('show_caption_above_media')
$hasSpoiler : bool|null = null
$supportsStreaming : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVideo

answerVoice()

public answerVoice(InputFile|string $voice[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, int|null $duration = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVoice
Parameters
$voice : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$duration : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVoice

answerVoicePm()

public answerVoicePm(InputFile|string $voice[, string|null $businessConnectionId = null ][, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $caption = null ][, BotDefault|string $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, int|null $duration = null ][, bool|null $disableNotification = null ][, bool|BotDefault $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null $replyMarkup = null ]) : SendVoice
Parameters
$voice : InputFile|string
$businessConnectionId : string|null = null
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$caption : string|null = null
$parseMode : BotDefault|string = new BotDefault('parse_mode')
$captionEntities : null|array<int, MessageEntity> = null
$duration : int|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : ForceReply|InlineKeyboardMarkup|ReplyKeyboardMarkup|ReplyKeyboardRemove|null = null
Return values
SendVoice

as_()

Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).

public as_(Bot|null $bot) : static

IMPORTANT: behaves DIFFERENTLY from upstream — upstream mutates self.bot in place and returns self. The PHP port can't mutate readonly, so this returns a clone. Callers must reassign: $msg = $msg->as($bot).

Parameters
$bot : Bot|null
Return values
static

withBot()

Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.

public withBot(Bot|null $bot) : static

list<list<KeyboardButton>>) are walked element-wise. Plain values (scalars, DateTime, enums, InputFile etc.) pass through untouched.

Mirrors upstream pydantic model_validate(context={"bot": bot}) (aiogram ContextController.as_/model_dump_json+model_validate).

Scope note: PHP 8.5 treats public readonly as effectively public protected(set) readonly for clone-with — only code running with a scope in the property's declaring class hierarchy (declaring class plus its ancestors and descendants) can use clone($obj, ['x' => ...]) against it. Because this method lives on BotContextController and every TelegramObject/TelegramMethod subclass extends it, the walker's clone($this, [...]) call legally rewrites subclass-declared readonly slots like Message::$chat. External callers cannot use the same syntax — they must funnel through this method.

Parameters
$bot : Bot|null
Return values
static
On this page

Search results