優惠券領取成功回呼

更新時間：2025-07-25 11:25:18

作用

使用本功能，觀眾在直播間領取優惠券後，伺服器端會對客戶所設定的介面位址，以POST方式提交到給使用者自訂的回呼介面進行通知。

超時重試

1、回呼伺服器在發送訊息通知後，5秒內沒有收到您的伺服器的回應，即認為通知失敗。後續失敗會以5秒間隔繼續重試2次。 2、介面回傳 JSON 物件，如果回呼沒有回傳 200，會重試 2 次，超過 2 次則丟棄日誌。

回呼訊息格式

事件回呼訊息以 HTTP/HTTPS POST 請求發送給您的伺服器，其中：

字元編碼格式：UTF-8。
請求：body 格式為 JSON。
應答要求：回應頭需指定 Content-Type: application/json；
正確應答：http status code: 200 為正確業務接收處理，其他狀態一律視為失敗重試處理。

回呼參數說明

參數名	類型	說明
couponInfo	Object: UserCoupon	優惠券資訊
receiveInfos	Array: ReceiveInfo	頻道名稱

UserCoupon 結構

參數名	類型	說明
couponId	string	優惠券 ID
name	string	優惠券名稱
type	string	優惠券類型: MAX_OUT-滿減券、DISCOUNT-折扣券
receiveStartTime	long	領券開始時間，13位毫秒數時間戳
receiveEndTime	long	領券結束時間，13位毫秒數時間戳
useTimeType	string	用券時間類型，RANGE-時間範圍，DAY-天數
dayOfUse	int	領取後多少天內可用
availableAmount	string	發放數量，大於等於 0
useStartTime	long	用券開始時間，13位毫秒數時間戳
useEndTime	long	用券結束時間，13位毫秒數時間戳
rule	Object: UserCouponRule	優惠券規則

UserCouponRule 結構

參數名	類型	說明
condition	string	優惠券使用條件 (UNCONDITIONAL-無門檻、FULL_REDUCE-滿減)
unconditional	Object: Unconditional	無門檻
fullReduce	Object: FullReduceBO	滿減
limitPerPerson	int	每人限領數量: -1-不限制

Unconditional 結構

參數名	類型	說明
enable	boolean	是否可用
value	double	數值
unit	string	單位: MONEY-元、DISCOUNT-折

FullReduce 結構

參數名	類型	說明
enable	boolean	是否可用
full	double	滿多少
reduce	double	減多少
unit	string	單位: MONEY-元、DISCOUNT-折

ReceiveInfo 結構

參數名	類型	說明
viewerId	string	觀眾 ID
externalViewerId	string	外部授權，外部使用者 ID
receiveTime	long	領取時間，13位毫秒數時間戳
refId	string	引用物件 ID (頻道 ID、頁面 ID 等)
receiveSource	string	領取來源:CHANNEL-頻道，AGGREGATE_PAGE-聚合頁，INFO_FLOW-資訊流

回應體：

{
    "couponInfo": {
        "availableAmount": 10,
        "couponId": "dd95z8jtjgwqxkakxxqjk4vlarb5zupi",
        "dayOfUse": 1,
        "name": "优惠券1号",
        "receiveEndTime": 1740585600000,
        "receiveStartTime": 1740538277000,
        "rule": {
            "condition": "UNCONDITIONAL",
            "fullReduce": {
                "enable": false,
                "full": 0.0,
                "reduce": 0.0,
                "unit": "DISCOUNT"
            },
            "limitPerPerson": -1,
            "unconditional": {
                "enable": true,
                "unit": "DISCOUNT",
                "value": 1.0
            }
        },
        "type": "DISCOUNT",
        "useTimeType": "DAY"
    },
    "receiveInfos": [
        {
            "receiveSource": "CHANNEL",
            "receiveTime": 1740540297284,
            "refId": "5461212",
            "viewerId": "d_4z74veo374b5u8c1aubpb8yl3x875xcx",
            "externalViewerId": "externalViewerId1234"
        },
        {
            "receiveSource": "CHANNEL",
            "receiveTime": 1740540296798,
            "refId": "5461212",
            "viewerId": "d_16qa575b49p89pvj0k6267t1t69q2v43"
        },
        {
            "receiveSource": "CHANNEL",
            "receiveTime": 1740540296118,
            "refId": "5461212",
            "viewerId": "d_eh4v9k26ay60qu1umnxb89cv9f64s46k"
        }
    ]
}

如何設定

透過後台設定：

登入帳戶 - 進入【雲直播】 - 點選【開發設定】- 點選【回呼設定】- 優惠券領取成功回呼

注意：提交的介面位址必須要以 http:// 或者 https:// 開頭