Query Channel Coupon List

Updated: 2026-01-06 09:17:49

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data.` See details in Signature Generation Rules
channelId	true	String	Channel ID
pageNumber	false	Integer	Page number, defaults to 1
pageSize	false	Integer	Number of items per page, defaults to 10, maximum 1000
name	false	String	Coupon name (supports fuzzy search)

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result determined by business logic, returns success on success, error on failure
success	Boolean	Response result determined by business logic, returns true on success, false on failure
data	Object	Paginated data See details in Data Field Description
error	Object	Error information when status code is non-200 See details in Error Field Description
requestId	String	Request ID, a unique UUID generated for each request, only for debugging and troubleshooting, not for business logic

Data Parameter Description

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Number of items per page
totalPages	Long	Total number of pages
totalItems	Long	Total number of items
contents	Array	Content of the current page See details in Contents Field Description
ext	Object	Extension field (may be empty)

Contents Field Description

Parameter	Type	Description
couponId	String	Coupon ID
name	String	Coupon name
status	String	Status: NOT_START - Not started, GOING - In progress, FINISHED - Ended, INVALID - Invalid
receiveStartTime	Long	Coupon claim start time, 13-digit millisecond timestamp
receiveEndTime	Long	Coupon claim end time, 13-digit millisecond timestamp
sort	Integer	Sort order
rule	Rule	Coupon rule See details in Rule Field Description
useTimeType	String	Coupon usage time type: RANGE - Time range, DAY - Days
dayOfUse	Integer	Number of days available after claiming (returned when useTimeType=DAY)
remainAmount	Integer	Remaining claimable quantity

Rule Field Description

Parameter	Type	Description
condition	String	Coupon usage condition: UNCONDITIONAL - No threshold, FULL_REDUCE - Spend-based discount
unconditional	Unconditional	No threshold rule See details in Unconditional Field Description
fullReduce	FullReduce	Spend-based discount rule See details in FullReduce Field Description
limitPerPerson	Integer	Maximum claims per person, -1 means unlimited

Unconditional Field Description

Parameter	Type	Description
enable	Boolean	Whether it is available
unit	String	Unit: MONEY - Yuan, DISCOUNT - Percent off
value	Double	Value

FullReduce Field Description

Parameter	Type	Description
enable	Boolean	Whether it is available
unit	String	Unit: MONEY - Yuan, DISCOUNT - Percent off
full	Double	Minimum spend amount
reduce	Double	Discount amount

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponds to error.code

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
  "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
}

Error Example

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