Stickers

The LiSA Player sends messages in response to various user interactions with stickers.

The player distinguishes different types of stickers interactions.

• Activate — The sticker activation timer has started

• Click — The sticker was clicked by a user

• Expire — The sticker has expired

• Impression — The sticker becomes visible in a user's viewport

• Publish — The sticker was published by a creator or moderator

• Unlock — The sticker's activation timer is complete

• Unpublish — The sticker was unpublished by a creator or moderator

• Update — Poll details have been updated

• Voucher Claim — 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.

Properties

Along with all standard Message properties, a Sticker Interaction message includes the following additional properties:

Name	Type	Description
mediaItemId	string Required.	The mediaItemId property uniquely identifies the Media Item from which this message originates.
mediaItemType	MediaItemType Required.	The mediaItemType property specifies the type of Media Item from which this message originates. Refer to MediaItemType for detailed information.
messageType	Literal Required.	The messageType property specifies the distinct type of message.
progress	MediaProgress Required.	The progress property is an object that holds additional metadata related to the media playback progress of the current media item. Please refer to MediaProgress for detailed information.
stickerActionTarget	StickerActionTarget Optional.	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 StickerActionTarget for detailed information.
stickerActivationTimerDurationInSec	number 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	boolean Required.	The stickerActivationTimerIsActive property indicates, whether the sticker's activation timer is currently running.
stickerActivationTimerIsCompleted	boolean Required.	The stickerActivationTimerIsCompleted property indicates, whether the sticker's activation timer is complete.
stickerActivationTimerStartedAt	string Optional.	The stickerActivationTimerStartedAt property represents the timestamp when the activation timer of the sticker was started — represented in ISO 8601 format.
stickerDetails	StickerDetails Optional.	The stickerDetails property represents the corresponding details object containing relevant information. The structure of this object varies depending on the stickerType. Refer to StickerDetails for detailed information.
stickerExpiryTimerDurationInSec	number 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	boolean Required.	The stickerExpiryTimerIsActive property indicates, whether the sticker's expiry timer is currently running.
stickerExpiryTimerStartedAt	string Optional.	The stickerExpiryTimerStartedAt property represents the timestamp when the expiry timer of the sticker was started — represented in ISO 8601 format.
stickerId	string Required.	The stickerId property represents the unique sticker identifier.
stickerIsExpired	boolean Required.	The stickerIsExpired property indicates, whether the sticker has expired.
stickerIsUnlocked	boolean 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	Enum 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.

---

Type Definition

interface StickerMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType:
    | 'lsc:sticker:activate'
    | 'lsc:sticker:click'
    | 'lsc:sticker:expire'
    | 'lsc:sticker:impression'
    | 'lsc:sticker:publish'
    | 'lsc:sticker:unlock'
    | 'lsc:sticker:unpublish'
    | 'lsc:sticker:update'
    | 'lsc:sticker:voucher:claim';
  progress: MediaProgress;
  stickerActionTarget?: StickerActionTarget;
  stickerActivationTimerDurationInSec: number;
  stickerActivationTimerIsActive: boolean;
  stickerActivationTimerIsCompleted: boolean;
  stickerActivationTimerStartedAt?: string;
  stickerDetails: StickerDetails;
  stickerExpiryTimerDurationInSec: number;
  stickerExpiryTimerIsActive: boolean;
  stickerExpiryTimerStartedAt?: string;
  stickerId: string;
  stickerIsExpired: boolean;
  stickerIsUnlocked: boolean;
  stickerType: 'alert' | 'poll' | 'product' | 'voucher';
  sender: 'LiSA';
}

StickerActionTarget

type StickerActionTarget = Record<string, unknown> | string;

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.

Alert

The Alert sticker does not contain any specific details, so the stickerDetails value is always an empty object.

Poll

Product

Voucher

---