修改频道商品配置

更新时间：2025-04-10 11:28:24

接口描述

1、修改频道商品配置
2、接口支持https协议

接口URL

https://api.polyv.net/live/v4/channel/product/push/rule

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看 2、若参数不正确则会响应400异常

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	Integer	频道号

请求体参数描述

参数名	必选	类型	说明
productExplainEnabled	false	String	商品讲解开关(Y-开，N-关)
productExplainingAutoPushAndSticky	false	String	商品讲解中自动推送和置顶开关(Y-开，N-关)
productListSortType	false	String	频道商品库列表排序(ASC-升序, DESC-降序[默认])
productTagSortType	false	String	商品标签排序方式(DEFAULT-默认排序,CUSTOM-自定义排序)
productPushRule	false	String	推送规则(smallCard-小卡片，bigCard-大卡片，chooseCard-推送时选择)
productHotEffectEnabled	false	String	商品热卖特效开关
normalProductHotEffectTips	false	String	商品热卖特效提示
jobProductHotEffectTips	false	String	职位商品热卖特效提示
financeProductHotEffectTips	false	String	金融商品热卖特效提示
outLinkProductRedirectEnabled	false	String	外链购买，是否直接跳转(Y-直接跳转，N-查看商品详情)
productTagSortOrderIds	false	Array	商品关联标签 ID 列表

示例

http://api.polyv.net/live/v4/channel/product/push/rule?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342

请求体json参数：

{
    "productExplainEnabled": "N",
    "productExplainingAutoPushAndSticky":"N",
    "productListSortType":"ASC",
    "productTagSortType":"DEFAULT",    
    "productPushRule": "smallCard",
    "productHotEffectEnabled": "Y",
    "normalProductHotEffectTips": "热卖中",
    "jobProductHotEffectTips": "投送中",
    "financeProductHotEffectTips": "选购中",
    "outLinkProductRedirectEnabled": "Y",
    "productTagSortOrderIds": [1,2,3]
}

响应描述

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

Error响应描述

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

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道商品设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateProductSetting() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/product/push/rule";
    String channelId = "2779045";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
    String jsonStr = "{\"productPushRule\":\"smallCard\",\"productHotEffectEnabled\":\"Y\",\"normalProductHotEffectTips\":\"热卖中\"," +
    "\"jobProductHotEffectTips\":\"投送中\",\"financeProductHotEffectTips\":\"选购中\"}";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, jsonStr, null);
    
    log.info("测试修改频道商品配置，返回值：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "9bedc2b44dcc4fdb8db8352905a17993.74.17270604170410039",
    "data": null,
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

直播服务端 API