保利威文档中心

帮助中心

新增频道优惠券

更新时间:2026-01-06 09:17:49

接口描述

1、将平台优惠券添加到频道中
2、接口支持https协议

接口URL

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

在线API调用

请求方式

POST

接口约束

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
couponIds true Array 优惠券ID列表,数量范围1-30。
如果包含无效、已添加过的优惠券,会忽略,仅处理正确的优惠券ID。
但如果全部优惠券ID都无效,则会返回失败提示。

示例

https://api.polyv.net/live/v4/channel/coupon/create?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

请求体json参数:

{
  "channelId": "123456",
  "couponIds": [
    "caqfi6rqutunvofor5jrqbinswh14p2g",
    "cbbfi6rqutunvofor5jrqbinswh14p2h"
  ]
}

响应参数描述

参数名 类型 说明
code Integer 响应状态码,200为成功返回,非200为失败
status String 响应结果,由业务决定,成功返回success,失败返回error
success Boolean 响应结果,由业务决定,成功返回true,失败返回false
data Boolean 成功返回true
error Object 状态码非200时的错误信息【详见Error字段说明
requestId String 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩

Error参数描述

参数名 类型 说明
code Integer 错误代码,用于确定具体的错误原因
desc String 错误描述,与 error.code 对应

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
  "code": 200,
  "status": "success",
  "requestId": "f9a9577b-cf74-4bf4-96e9-067ea23f1685",
  "data": true,
  "success": true
}

异常示例

{
  "code": 400,
  "status": "error",
  "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}
联系客服,在线咨询