Stickers — Voucher Claim

The LiSA Player dispatches a message when the voucher code of an active voucher sticker is redeemed by the user.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard Sticker message properties, a Voucher Claim message includes the following additional properties:

Name	Type	Description
messageType	Literal Required.	lsc:sticker:voucher:claim
stickerDetails	VoucherStickerDetails Required.	The stickerDetails property represents the corresponding details object containing relevant information. The structure of this object varies depending on the stickerType. In case of the Voucher Sticker Claim message, the sticker details will always include voucher specific details only. Refer to StickerDetails for detailed information.
stickerType	Literal Required.	The stickerType property represents the type of sticker being used. In case of the Voucher Sticker Claim message, the value is always voucher.

---

Type Definition

interface VoucherStickerClaimMessage extends Omit<
  StickerMessage,
  'messageType' | 'stickerDetails' | 'stickerType'
> {
  messageType: 'lsc:sticker:voucher:claim';
  stickerDetails: VoucherStickerDetails;
  stickerType: 'voucher';
}

---

Examples

{
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:sticker:voucher:claim",
  "progress": {
    "bufferedTimeInMs": 648036,
    "currentTimeInMs": 628008,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 28784,
    "skipTimeInMs": 600000,
    "isLive": true,
    "visitorDwellTimeInMs": 29135,
    "isPlaying": true
  },
  "sender": "LiSA",
  "stickerActionTarget": "NEW-YEARS-DROP",
  "stickerActivationTimerDurationInSec": 300,
  "stickerActivationTimerIsActive": false,
  "stickerActivationTimerIsCompleted": true,
  "stickerActivationTimerStartedAt": "2025-01-01T19:15:00Z",
  "stickerDetails": {
    "ctaBehavior": "addToCart",
    "voucherCode": "NEWYEARS15"  
  },
  "stickerExpiryTimerDurationInSec": 900,
  "stickerExpiryTimerIsActive": true,
  "stickerExpiryTimerStartedAt": "2025-01-01T19:20:00Z",
  "stickerId": "9ffbad77-c6e8-495e-99bb-193b0d3b109f",
  "stickerIsExpired": false,
  "stickerIsUnlocked": true,
  "stickerType": "voucher"
}