MessageEntity
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
fields
| field | type | required | description |
|---|---|---|---|
type | "mention" | "hashtag" | "cashtag" | "bot_command" | "url" | "email" | "phone_number" | "bold" | "italic" | "underline" | "strikethrough" | "spoiler" | "blockquote" | "expandable_blockquote" | "code" | "pre" | "text_link" | "text_mention" | "custom_emoji" | "date_time" | required | Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers), or “date_time” (for formatted date and time). |
offset | number | required | Offset in UTF-16 code units to the start of the entity |
length | number | required | Length of the entity in UTF-16 code units |
url | string | optional | Optional. For “text_link” only, URL that will be opened after user taps on the text |
user | User | optional | Optional. For “text_mention” only, the mentioned user |
language | string | optional | Optional. For “pre” only, the programming language of the entity text |
custom_emoji_id | string | optional | Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker. |
unix_time | number | optional | Optional. For “date_time” only, the Unix time associated with the entity |
date_time_format | string | optional | Optional. For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details. |
import
import type { MessageEntity } from "@yaebal/types";used by
methods
- copyMessage
- editMessageCaption
- editMessageText
- editStory
- giftPremiumSubscription
- postStory
- sendAnimation
- sendAudio
- sendDocument
- sendGift
- sendLivePhoto
- sendMessage
- sendMessageDraft
- sendPaidMedia
- sendPhoto
- sendPoll
- sendVideo
- sendVoice
types
- Checklist
- ChecklistTask
- Game
- GiftInfo
- InlineQueryResultAudio
- InlineQueryResultCachedAudio
- InlineQueryResultCachedDocument
- InlineQueryResultCachedGif
- InlineQueryResultCachedMpeg4Gif
- InlineQueryResultCachedPhoto
- InlineQueryResultCachedVideo
- InlineQueryResultCachedVoice
- InlineQueryResultDocument
- InlineQueryResultGif
- InlineQueryResultMpeg4Gif
- InlineQueryResultPhoto
- InlineQueryResultVideo
- InlineQueryResultVoice
- InputChecklist
- InputChecklistTask
- InputMediaAnimation
- InputMediaAudio
- InputMediaDocument
- InputMediaLivePhoto
- InputMediaPhoto
- InputMediaVideo
- InputPollOption
- InputTextMessageContent
- Message
- OwnedGiftRegular
- Poll
- PollOption
- PollOptionAdded
- PollOptionDeleted
- ReplyParameters
- TextQuote
official Bot API docs: https://core.telegram.org/bots/api/#messageentity