查詢頻道優惠券列表

更新時間：2026-01-06 09:17:49

介面描述

1、查询频道优惠券列表
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/channel/coupon/list

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道ID
pageNumber	false	Integer	頁碼，預設為1
pageSize	false	Integer	每頁資料大小，預設10，最大1000
name	false	String	優惠券名稱（支援模糊搜尋）

範例

https://api.polyv.net/live/v4/channel/coupon/list?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318&channelId=4854808&pageNumber=1&pageSize=10

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	回應結果，由業務決定，成功回傳true，失敗回傳false
data	Object	分頁資料【詳見Data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛上鉤

Data參數描述

參數名	類型	說明
pageNumber	Integer	目前頁碼
pageSize	Integer	每頁資料量
totalPages	Long	頁面總數
totalItems	Long	總資料量
contents	Array	目前頁內容【詳見Contents欄位說明】
ext	Object	擴充欄位（可能為空）

Contents欄位說明

參數名	類型	說明
couponId	String	優惠券ID
name	String	優惠券名稱
status	String	狀態：NOT_START-未開始、GOING-進行中、FINISHED-已結束、INVALID-已失效
receiveStartTime	Long	領券開始時間，13位毫秒級時間戳
receiveEndTime	Long	領券結束時間，13位毫秒級時間戳
sort	Integer	排序號
rule	Rule	優惠券規則【詳見Rule欄位說明】
useTimeType	String	用券時間類型：RANGE-時間範圍，DAY-天數
dayOfUse	Integer	領取後多少天內可用（useTimeType=DAY 時回傳）
remainAmount	Integer	剩餘可領取數量

Rule欄位說明

參數名	類型	說明
condition	String	優惠券使用條件：UNCONDITIONAL-無門檻、FULL_REDUCE-滿減
unconditional	Unconditional	無門檻規則【詳見Unconditional欄位說明】
fullReduce	FullReduce	滿減規則【詳見FullReduce欄位說明】
limitPerPerson	Integer	每人限領數量，-1 表示不限制

Unconditional欄位說明

參數名	類型	說明
enable	Boolean	是否可用
unit	String	單位：MONEY-元、DISCOUNT-折
value	Double	數值

FullReduce欄位說明

參數名	類型	說明
enable	Boolean	是否可用
unit	String	單位：MONEY-元、DISCOUNT-折
full	Double	滿多少
reduce	Double	減多少

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "46c21cc2-d4da-4fe8-ae34-118c36ce99f6",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 2,
    "contents": [
      {
        "couponId": "6wa8ckpjzfr1ok37j7zvhwgc3jj0wabc",
        "name": "优惠券1",
        "status": "NOT_START",
        "receiveStartTime": 1767110400000,
        "receiveEndTime": 1769788800000,
        "sort": 1,
        "rule": {
          "condition": "UNCONDITIONAL",
          "unconditional": {
            "enable": true,
            "unit": "MONEY",
            "value": 2.0
          },
          "fullReduce": {
            "enable": false,
            "unit": "MONEY",
            "full": 0.0,
            "reduce": 0.0
          },
          "limitPerPerson": -1
        },
        "useTimeType": "DAY",
        "dayOfUse": 30,
        "remainAmount": 100
      },
      {
        "couponId": "6prxllnkjqcdrcamqey7htk8hnieqabc",
        "name": "优惠券2",
        "status": "GOING",
        "receiveStartTime": 1766654100000,
        "receiveEndTime": 1769788800000,
        "sort": 2,
        "rule": {
          "condition": "UNCONDITIONAL",
          "unconditional": {
            "enable": true,
            "unit": "MONEY",
            "value": 2.0
          },
          "fullReduce": {
            "enable": false,
            "unit": "MONEY",
            "full": 0.0,
            "reduce": 0.0
          },
          "limitPerPerson": -1
        },
        "useTimeType": "DAY",
        "dayOfUse": 30,
        "remainAmount": 100
      }
    ]
  },
  "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}