MessageEntity

Official docs ↗

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

Fields

typeStringRequired

Values:mentionhashtagcashtagbot_commandurlemailphone_numberbolditalicunderlinestrikethroughspoilerblockquoteexpandable_blockquotecodepretext_linktext_mentioncustom_emojidate_time

Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag or #hashtag@chatusername), "cashtag" ($USD or $USD@chatusername), "bot\command" (/start@jobsbot), "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)

offsetIntegerRequired

Offset in UTF-16 code units to the start of the entity

lengthIntegerRequired

Length of the entity in UTF-16 code units

urlStringOptional

Optional. For "text\_link" only, URL that will be opened after user taps on the text

userUserOptional

Optional. For "text\_mention" only, the mentioned user

languageStringOptional

Optional. For "pre" only, the programming language of the entity text

custom_emoji_idStringOptional

Optional. For "custom\_emoji" only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker

unix_timeIntegerOptional

Optional. For "date\_time" only, the Unix time associated with the entity

date_time_formatStringOptional

Optional. For "date\_time" only, the string that defines the formatting of the date and time. See date-time entity formatting for more details.

GramIO Usage

See Also