Telegram Bot Api Base
Back to top  

Class SendInvoiceMethod.

see
package Default

 Methods

create() 

create(integer|string $chatId, \TgBotApi\BotApiBase\Method\string $title, \TgBotApi\BotApiBase\Method\string $description, \TgBotApi\BotApiBase\Method\string $payload, \TgBotApi\BotApiBase\Method\string $providerToken, \TgBotApi\BotApiBase\Method\string $startParameter, \TgBotApi\BotApiBase\Method\string $currency, array<mixed,\TgBotApi\BotApiBase\Type\LabeledPriceType> $prices, array $data = null) 
Static

Parameters

$chatId

integerstring

$title

$description

$payload

$providerToken

$startParameter

$currency

$prices

array<mixed,\TgBotApi\BotApiBase\Type\LabeledPriceType>

$data

Exceptions

\TgBotApi\BotApiBase\Exception\BadArgumentException

fill() 

fill(array $data, array $forbidden = array()) 
Inherited

Parameters

$data

array

$forbidden

array

Exceptions

\TgBotApi\BotApiBase\Exception\BadArgumentException

 Properties

 

Optional. Pass True, if the message should be sent even if the specified replied-to message is not found.

$allowSendingWithoutReply : boolean | null

Default

 

Three-letter ISO 4217 currency code, see more on currencies.

$currency : string

Default

 

Product description, 1-255 characters.

$description : string

Default

 

Optional. Sends the message silently. Users will receive a notification with no sound.

$disableNotification : boolean | null

Default

 

Optional. Pass True, if the final price depends on the shipping method.

$isFlexible : boolean | null

Default

 

Optional. Pass True, if you require the user's email address to complete the order.

$needEmail : boolean | null

Default

 

Optional. Pass True, if you require the user's full name to complete the order.

$needName : boolean | null

Default

 

Optional. Pass True, if you require the user's phone number to complete the order.

$needPhoneNumber : boolean | null

Default

 

Optional. Pass True, if you require the user's shipping address to complete the order.

$needShippingAddress : boolean | null

Default

 

Bot-defined invoice payload, 1-128 bytes.

$payload : string

Default

This will not be displayed to the user, use for your internal processes.

 

Optional. Photo height.

$photoHeight : integer | null

Default

 

Optional. Photo size.

$photoSize : integer | null

Default

 

Optional. URL of the product photo for the invoice.

$photoUrl : string | null

Default

Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

 

Optional. Photo width.

$photoWidth : integer | null

Default

 

Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

$prices : array<mixed,\TgBotApi\BotApiBase\Type\LabeledPriceType>

Default

 

Optional. JSON-encoded data about the invoice, which will be shared with the payment provider.

$providerData : string | null

Default

A detailed description of required fields should be provided by the payment provider.

 

Payments provider token, obtained via Botfather.

$providerToken : string

Default

 

Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown.

$replyMarkup : \TgBotApi\BotApiBase\Type\InlineKeyboardMarkupType | null

Default

If not empty, the first button must be a Pay button.

 

Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

$replyMarkup : \TgBotApi\BotApiBase\Type\InlineKeyboardMarkupType | \TgBotApi\BotApiBase\Type\ReplyKeyboardMarkupType | \TgBotApi\BotApiBase\Type\ReplyKeyboardRemoveType | \TgBotApi\BotApiBase\Type\ForceReplyType | null

Default

 

Optional. If the message is a reply, ID of the original message.

$replyToMessageId : integer | null

Default

 

Optional. Pass True, if user's email address should be sent to provider.

$sendEmailToProvider : boolean | null

Default

 

Optional. Pass True, if user's phone number should be sent to provider.

$sendPhoneNumberToProvider : boolean | null

Default

 

Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter.

$startParameter : string

Default

 

Product name, 1-32 characters.

$title : string

Default