查询频道优惠券列表
更新时间:2026-01-06 09:17:49
接口描述
1、查询频道优惠券列表
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/channel/coupon/list
请求方式
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×tamp=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
}
