Stickers
Last updated
Last updated
The LiSA Player sends messages in response to various user interactions with stickers.
The player distinguishes different types of stickers interactions.
— The sticker activation timer has started
— The sticker was clicked by a user
— The sticker has expired
— The sticker becomes visible in a user's viewport
— The sticker was published by a creator or moderator
— The sticker's activation timer is complete
— The sticker was unpublished by a creator or moderator
— Poll details have been updated
— The voucher code of a voucher sticker has been claimed by a user
This message is sent by the LiSA Player to the host app / environment.
Along with all standard , a Sticker Interaction message includes the following additional properties:
mediaItemId
Required.
The mediaItemId
property uniquely identifies the Media Item from which this message originates.
mediaItemType
Required.
messageType
Required.
The messageType
property specifies the distinct type of message.
progress
Required.
stickerActionTarget
Optional.
stickerActivationTimerDurationInSec
Required.
The stickerActivationTimerDurationInSec
property defines the length of the activation timer in seconds. If no activation timer is set for the sticker, the value is 0
.
stickerActivationTimerIsActive
Required.
The stickerActivationTimerIsActive
property indicates, whether the sticker's activation timer is currently running.
stickerActivationTimerIsCompleted
Required.
The stickerActivationTimerIsCompleted
property indicates, whether the sticker's activation timer is complete.
stickerActivationTimerStartedAt
Optional.
The stickerActivationTimerStartedAt
property represents the timestamp when the activation timer of the sticker was started — represented in ISO 8601 format.
stickerDetails
Optional.
stickerExpiryTimerDurationInSec
Required.
The stickerExpiryTimerDurationInSec
property defines the length of the expiry timer in seconds. If no expiry timer is set for the sticker, the value is 0
.
stickerExpiryTimerIsActive
Required.
The stickerExpiryTimerIsActive
property indicates, whether the sticker's expiry timer is currently running.
stickerExpiryTimerStartedAt
Optional.
The stickerExpiryTimerStartedAt
property represents the timestamp when the expiry timer of the sticker was started — represented in ISO 8601 format.
stickerId
Required.
The stickerId
property represents the unique sticker identifier.
stickerIsExpired
Required.
The stickerIsExpired
property indicates, whether the sticker has expired.
stickerIsUnlocked
Required.
The stickerIsUnlocked
property indicates, whether the sticker is unlocked. Either when the activation timer is not set or has completed AND the sticker has not expired.
stickerType
Required.
The stickerType
property represents the type of sticker being used.
Allowed Values:
alert
– Displays an informational or warning alert.
poll
– Represents a poll for collecting user votes.
product
– Showcases a product-related sticker.
voucher
– Represents a discount or promotional voucher sticker.
StickerActionTarget
The Sticker Action supports three different use cases:
Identifier (String) — Represents an action or event that the host app / environment can interpret and execute.
Structured Data (String) — For more complex action definitions the action target contains an object structure.
StickerDetails
The StickersDetails
type defines the corresponding details for each sticker based on its type.
The Alert sticker does not contain any specific details, so the stickerDetails
value is always an empty object.
The mediaItemType
property specifies the type of Media Item from which this message originates.
Refer to for detailed information.
The progress
property is an object that holds additional metadata related to the media playback progress of the current media item.
Please refer to for detailed information.
The stickerActionTarget
property represents the (localized) action to be executed when a user interacts with a UI element. It can be an identifier, a structured JSON payload, or a URL that opens in a new tab.
Refer to for detailed information.
The stickerDetails
property represents the corresponding details object containing relevant information. The structure of this object varies depending on the stickerType
.
Refer to for detailed information.