保利威文档中心

幫助中心

修改頻道商品資訊

更新時間:2026-03-05 17:30:30

介面描述

1、编辑频道商品库商品信息
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/product/update

線上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 頻道號

請求體參數說明

參數名 必填 類型 說明
productId true Integer 商品庫商品productId
name true String 商品名稱,必填,長度範圍:1-100
註:介面可支援100字元,直播後台設定僅支援50個字元
status true Integer 商品上下架狀態
1:上架狀態
2:下架狀態
linkType true Integer 商品連結類型
10:通用連結
11:多平台連結
cover false String 商品封面連結,長度範圍:1-500
yield false String 金融商品參數,產品收益率/價格,如:87.99%
link false String 通用連結(linkType=10)
商品連結,長度1-500,必填
多平台連結(linkType=11),非必填
pcLink false String pc端跳轉連結,長度1-500
mobileLink false String 行動web端連結
wxMiniprogramLink false String 小程式端連結
wxMiniprogramOriginalId false String 小程式端Id
wxMiniprogramAppId false String 小程式端appId
mobileAppLink false String 行動App端連結
productDesc false String 產品描述
androidLink false String 多平台連結,行動APP-安卓系統原生頁面連結
iosLink false String 多平台連結,行動APP-蘋果系統原生頁面連結
btnShow false String 按鈕顯示文案
params false String 自訂參數,json物件,例如:{"id":21,"color":"blue","level":1}
該參數以String類型接收,請求時需要轉義,見下方請求體參數範例
tagIds false String 商品標籤ID, json物件 例如: [1,2,3]
productDetail false String 商品詳情
ext false String 擴展資訊:JSON物件字串:{"coverList":["封面圖地址,最多15個"], "videoList":[{"videoSource":"影片來源", "videoId":"影片ID"}]} 【詳情見EXT
features false String 該參數以String類型的json物件接收,請求時需要轉義,見下方請求體參數範例
普通商品(productType為normal)時,產品標籤,json陣列,例如:["tab1", "tab2"]
金融商品(productType為finance)時,產品標籤,json陣列,例如:["tab1", "tab2"]
職位商品(productType為position)時,職位標籤,json陣列,例如:["tab1", "tab2", "tab3"],職位商品標籤不足三個時用空字串代替
- - - 以下為普通商品專用參數 (productType=normal)
priceType false String 商品實際價格類型,可選值有:
AMOUNT: 金額
CUSTOM: 自訂
不傳時預設為 AMOUNT
realPrice false Float 商品實際價格-金額,priceType=AMOUNT 時必傳,最高精確度為兩位小數,如 12.34
customPrice false String 商品實際價格-自訂,priceType=CUSTOM 時必傳,最多20個字元
originalPriceType false String 商品原始價格(劃線價格)類型,可選值有:
AMOUNT: 金額
CUSTOM: 自訂
預設為 AMOUNT
price false Float 商品原始價格(劃線價格)-金額,originalPriceType=AMOUNT 時生效,最高精確度為兩位小數,如 12.34
customOrignalPrice false String 商品原始價格(劃線價格)-自訂,originalPriceType=CUSTOM 時生效,最多20個字元
備註:如果 price 和 customOriginalPrice 都為空,則表示不啟用原始價格(劃線價格)
- - - 以上為普通商品專用參數 (productType=normal)

EXT

參數名 必填 類型 說明
coverList true Array 封面圖網址陣列,最多15個
videoList false Array 影片陣列,最多1個【詳見ChannelProductExtVideo】需開通素材庫才能使用
jumpWay false String 購買方式為外部連結購買-通用連結的跳轉方式: POP_UP-彈出視窗開啟、NEW_WINDOW-新視窗開啟、CURRENT_WINDOW-當前視窗開啟

ChannelProductExtVideo

參數名稱 必填 類型 說明
videoId true String 影片ID
videoSource true String 影片來源: MATERIAL_LIBRARY-素材庫

範例

http://api.polyv.net/live/v3/channel/product/update?appId=frlr1zazn3&sign=4C8FCD995644EEB248AB2CE70329F4D2&channelId=1965681&timestamp=1621843510009

請求體參數

{
    "productId": 27538,
    "name": "开心豆",
    "price": 0.99,
    "cover": "//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235",
    "link": "",
    "status": 1,
    "realPrice": 1.99,
    "yield": "87.99%",
    "linkType": 11,
    "pcLink": "https://www.polyv.net/",
    "mobileLink": "",
    "wxMiniprogramLink": "",
    "wxMiniprogramOriginalId": "",
    "mobileAppLink": "",
    "params": "{\"color\": \"red\"}",
    "productDetail" : "<p>这是商品详情!</p>"
}

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 回應成功回傳SUCCESS,失敗回傳空

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 testUpdateChannelProduct() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/product/update";
    String channelId = "1965681";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);

    String body = "{\"productId\":27538,\"name\":\"开心豆\",\"price\":0.99,\"cover\":\"//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235\",\"link\":\"\",\"status\":1,\"realPrice\":1.99,\"linkType\":11,\"pcLink\":\"https://www.polyv.net\",\"mobileLink\":\"\",\"wxMiniprogramLink\":\"\",\"wxMiniprogramOriginalId\":\"\",\"mobileAppLink\":\"\",\"params\":\"{\\\"cc\\\": 11}\"}";

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    log.info("测试修改商品信息:{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "SUCCESS"
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询