Message

This object represents a message.

Properties

• $message_id: Unique message identifier inside this chat
• $from: User Optional. Sender, empty for messages sent to channels
• $sender_chat: Chat Optional. Sender of the message, sent on behalf of a chat. The channel itself for channel messages. The supergroup itself for messages from anonymous group administrators. The linked channel for messages automatically forwarded to the discussion group
• $date: Date the message was sent in Unix time
• $chat: Chat Conversation the message belongs to
• $forward_from: User Optional. For forwarded messages, sender of the original message
• $forward_from_chat: Chat Optional. For messages forwarded from channels or from anonymous administrators, information about the original sender chat
• $forward_from_message_id: Optional. For messages forwarded from channels, identifier of the original message in the channel
• $forward_signature: Optional. For messages forwarded from channels, signature of the post author if present
• $forward_sender_name: Optional. Sender’s name for messages forwarded from users who disallow adding a link to their account in forwarded messages
• $forward_date: Optional. For forwarded messages, date the original message was sent in Unix time
• $reply_to_message: Message Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
• $via_bot: User Optional. Bot through which the message was sent
• $edit_date: Optional. Date the message was last edited in Unix time
• $media_group_id: Optional. The unique identifier of a media message group this message belongs to
• $author_signature: Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator
• $text: Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters
• $entities: Array of MessageEntity Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
• $animation: Animation Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set
• $audio: Audio Optional. Message is an audio file, information about the file
• $document: Document Optional. Message is a general file, information about the file
• $photo: Array of PhotoSize Optional. Message is a photo, available sizes of the photo
• $sticker: Sticker Optional. Message is a sticker, information about the sticker
• $video: Video Optional. Message is a video, information about the video
• $video_note: VideoNote Optional. Message is a video note, information about the video message
• $voice: Voice Optional. Message is a voice message, information about the file
• $caption: Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters
• $caption_entities: Array of MessageEntity Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
• $contact: Contact Optional. Message is a shared contact, information about the contact
• $dice: Dice Optional. Message is a dice with random value from 1 to 6
• $game: Game Optional. Message is a game, information about the game. More about games »
• $poll: Poll Optional. Message is a native poll, information about the poll
• $venue: Venue Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set
• $location: Location Optional. Message is a shared location, information about the location
• $new_chat_members: Array of User Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
• $left_chat_member: User Optional. A member was removed from the group, information about them (this member may be the bot itself)
• $new_chat_title: Optional. A chat title was changed to this value
• $new_chat_photo: Array of PhotoSize Optional. A chat photo was change to this value
• $delete_chat_photo: True Optional. Service message: the chat photo was deleted
• $group_chat_created: True Optional. Service message: the group has been created
• $supergroup_chat_created: True Optional. Service message: the supergroup has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.
• $channel_chat_created: True Optional. Service message: the channel has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.
• $migrate_to_chat_id: Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
• $migrate_from_chat_id: Optional. The supergroup has been migrated from a group with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
• $pinned_message: Message Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
• $invoice: Invoice Optional. Message is an invoice for a payment, information about the invoice. More about payments »
• $successful_payment: SuccessfulPayment Optional. Message is a service message about a successful payment, information about the payment. More about payments »
• $connected_website: Optional. The domain name of the website on which the user has logged in. More about Telegram Login »
• $passport_data: PassportData Optional. Telegram Passport data
• $proximity_alert_triggered: ProximityAlertTriggered Optional. Service message. A user in the chat triggered another user’s proximity alert while sharing Live Location.
• $reply_markup: InlineKeyboardMarkup Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.

Methods

forward()

Alias of forwardMessage A description of the method

$message->forward($chat_id);

reply()

Alias of sendMessage A description of the method

$message->reply($text);

delete()

Alias of deleteMessage A description of the method

$message->delete(...$args);

editText()

Alias of editMessageText A description of the method

$message->editText($text);

editLiveLocation()

Alias of editMessageLiveLocation A description of the method

$message->editLiveLocation(...$args);

stopLiveLocation()

Alias of stopMessageLiveLocation A description of the method

$message->stopLiveLocation($reply_markup);

pin()

Alias of pinChatMessage A description of the method

$message->pin($disable_notification);

editCaption()

Alias of editMessageCaption A description of the method

$message->editCaption($caption);

editMedia()

Alias of editMessageMedia A description of the method

$message->editMedia($media);

editReplyMarkup()

Alias of editMessageReplyMarkup A description of the method

$message->editReplyMarkup($reply_markup);

stopPoll()

Alias of stopPoll A description of the method

$message->stopPoll($reply_markup);

setGameScore()

Alias of setGameScore A description of the method

$message->setGameScore($inline_message_id);

copy()

Alias of copyMessage A description of the method

$message->copy($chat_id);