置頂頻道商品

更新時間：2026-03-05 18:09:21

介面描述

1、将指定频道商品置顶
2、（timestamp, appId, channelId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/product/topping

線上API呼叫

請求方式

POST

介面限制

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

2、僅允許對已存在且處於上架狀態的商品執行置頂操作

3、同一頻道僅允許一個商品處於置頂狀態，置頂新商品會自動取消原置頂商品

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
channelId	true	Integer	頻道號

請求體參數描述

參數名	必選	類型	說明
productId	true	Integer	頻道商品ID

範例

http://api.polyv.net/live/v4/channel/product/topping?appId=frlr1zazn3&timestamp=1710468881000&sign=2F87D9D7F1234567890ABCDEFFEDCBA&channelId=1965681

請求體json參數：

{
  "productId": 27537
}

回應參數描述

參數名	類型	說明
code	Integer	狀態碼，與http狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求生成的唯一的UUID，僅可用於排查、除錯，不應該和業務掛鉤
data	Object	回應資料，成功時通常為null
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(ChannelProductTest.class);
/**
 * 置顶频道商品
 */
@Test
public void testToppingChannelProduct() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/product/topping";
    String channelId = "1965681";
    Integer productId = 27537;

    //http 调用逻辑
    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));
    url = HttpUtil.appendUrl(url, requestMap);

    Map<String, Object> bodyMap = new HashMap<>();
    bodyMap.put("productId", productId);

    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(bodyMap), null);
    log.info("测试置顶频道商品，返回值：{}", response);
}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "ac58000e9651475aaf4f48d7dae318cd.72.17104688816896941",
  "data": null,
  "success": true
}

異常範例（商品不存在）

{
  "code": 400,
  "status": "error",
  "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
  "error": {
    "code": 40243,
    "desc": "商品不存在"
  },
  "success": false
}

異常範例（下架商品不允許操作）

{
  "code": 400,
  "status": "error",
  "requestId": "f92e5d4f3fd948c08c46c64d6f2329f7.57.17104689999231312",
  "error": {
    "code": 40258,
    "desc": "下架商品不允许操作"
  },
  "success": false
}