The translation was generated automatically and may contain mistakes

The Clickable Sticker in History

An object describing a clickable sticker. A field is available in the history object clickable_stickers . The sticker object is pasted by the developer on the client independently, only coordinates are transmitted to the server.

Object Fields clickable_stickers

original_width

integer The width of the original photo or video.

original_height

integer The height of the original photo or video.

clickable_stickers

array An array of clickable sticker objects.

Object hashtag

hashtag

string , mandatory Hashtag text.

style

string Hashtag style. By default: blue_gradient . Possible values: transparent , blue_gradient .

Object mention

mention

string , mandatory Text in Mention Format: For People Profiles "[name](id123)" for groups/communications/events - "[name](club123)" .

style

string Style of mention. By default: red_gradient . Possible values: transparent , red_gradient .

Object music

Object audio

More details in section Audio recording .

audio_start_time

integer Time to start recording.

style

string Style of recording. Possible values:

  • album - a large image of the album and the name of the audio recording.
  • horizontal - a small image of the album and the name of the audio recording.
  • header_meta — without images, just the name of the audio recording at the top of the story.

Object place

place_id

integer , mandatory Location ID.

title

string , mandatory Name of place.

category_id

integer Place category ID.

style

string Style. By default: blue . Possible values: transparent , blue , green , white .

Object link

link

string , mandatory Link to content.

tooltip_text_key

string A key per line that will be displayed on the client when you click on the tooltip Options for tooltips now:

  • tooltip_open_post' ,
  • tooltip_open_photo' ,
  • 'tooltip_open_page' ,
  • 'tooltip_open_default' (Unless you tell me).

Object time

style

integer Style of time stamp: black , white , green , text , date By default: date .

timestamp_ms

long Unix timestamps in milliseconds.

date

string Date (alternative timestamp_ms ) in the format yyyy:MM:ddHH:mm:ss (This format is chosen to unify the date of exif fields .

title

string The top title of the sticker, used only for style date

Object question

question

string , mandatory Text of the question.

button ( question_button )

string , mandatory Text of the button.

style

string Poster style ("light"/"impressive"). light The button will have color.. color , the background will be white. Impressive - the button will be white, the background will have a color color . On the default client: light .

color

string Primary color. Hex string in RGB (e.g. "3f8ae0") On the default client: "3f8ae0"

Object text

text

string , mandatory The text may contain references / hashtags in the formats indicated with the corresponding objects.

style

string The style of the text (the names are taken from the statue): classic , cursive , marker , italics , typewriter , poster , retro .

background_style

string Background/line-up style, values: none , alpha , solid , sticker , neon The applicability of the background style depends on the original text style By default: none .

alignment

string Alignment: center , left , right .

selection_color

string Color in format: #ff0000> If background_style given none , the value will determine the color of the text. Otherwise, it will mean the color applied to the style

Supported background styles relative to text style

'classic

none , solid , alpha , sticker .

'cursive

none , solid .

'marker

none , neon .

'italics

none , solid .

'typewriter

none , solid .

'poster

none , solid .

'retro

none , solid .

Object emoji

emoji

string , mandatory Symbol of Emoji .

Object sticker

sticker_id

integer , mandatory Sticker ID.

pack_id

integer , mandatory The ID of the sticker set.

Object market_item

title

string , mandatory Text for the heading of the goods.

product_id

integer Product ID for VK products.

owner_id

integer Owner ID for VK products.

link

string Link to the product AliExpress.

Object app

app_id integer , mandatory The application ID is mandatory because the transfer can occur by reference, not directly through VK Mini Apps.

app_context string If the app is opened from the history, then in the startup parameters in vk_ref will be the value (set on the backend): story{owner_id}_{story_id}_{access_key}_{sticker_id}_{context} . Maximum of 500 characters.

Object poll

poll_id integer , mandatory Survey ID.

poll_owner_id integer Owner's ID.

is_board boolean From the discussion whether the survey.

Common fields for all types of stickers

type string , mandatory Type of sticker. Possible values:

  • mention - Mention;
  • hashtag - hashtag.

clickable_area array , mandatory An array of points with the coordinates of the clickable region. Each element is an object with two x, y (int) coordinates.. It is desirable to transmit a rectangular area of four points.

style string The visual style of the sticker. Possible values:

  • transparent transparently;
  • underline - underlined (for Android only).

Optional fields, depending on the type of sticker

type=mention

mention string Contains a string in the format of a VKontakte mention, for example: [id1|name] or [club1|name] .

type=hashtag

hashtag string Contains a string in the format of a hashtag. It should start with the # symbol..

JSON
{ "original_height": 2001, "original_width": 1125, "clickable_stickers": [ { "type": "mention", "clickable_area": [ { "x": 425, "y": 853 }, { "x": 825, "y": 1210 }, { "x": 699, "y": 1351 }, { "x": 299, "y": 993 } ], "mention": "[club22822305|@team]", "style": "red_gradient" }, { "type": "hashtag", "clickable_area": [ { "x": 269, "y": 525 }, { "x": 663, "y": 377 }, { "x": 711, "y": 505 }, { "x": 317, "y": 653 } ], "hashtag": "#hello", "style": "blue_gradient" } ] }