查詢頻道商品列表
更新時間:2026-05-13 16:46:38
介面描述
1、获取频道商品库商品列表
2、支持分页
3、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/product/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 | 頻道號 |
| status | false | Integer | 上下架狀態【1:上架,2:下架】 |
| productIds | false | String | 商品 ID,多個以逗號分隔 |
| page | false | Integer | 目前頁數,預設 1 |
| size | false | Integer | 每頁資料筆數,預設 10,最大值 100 |
範例
http://api.polyv.net/live/v3/channel/product/list?size=1&appId=frlr1zazn3&sign=4C526B259BEFD10B90F9B159AE1CB92A&page=1&channelId=1965681×tamp=1621843424385
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 請求成功時為商品資訊【詳見Data參數描述】,請求失敗時為空 |
Data參數描述
| 參數名稱 | 類型 | 說明 |
|---|---|---|
| pageSize | Integer | 每頁資料大小 |
| pageNumber | Integer | 當前的頁數 |
| totalItems | Integer | 總筆數 |
| contents | Array | 查詢的結果列表【詳見Contents參數描述】 |
| startRow | Integer | 當前頁第一筆記錄在總結果集中的位置 |
| firstPage | Boolean | 是否為第一頁,值為:true/false |
| lastPage | Boolean | 是否為最後一頁,值為:true/false |
| prePageNumber | Integer | 上一頁編號 |
| nextPageNumber | Integer | 下一頁編號 |
| limit | Integer | 每頁數量大小 |
| totalPages | Integer | 總頁數 |
| endRow | Integer | 當前頁最後一筆記錄在總結果集中的位置 |
| offset | Integer | 分頁起始記錄 |
Contents參數描述
| 參數名稱 | 類型 | 說明 |
|---|---|---|
| productId | Integer | 商品 productId |
| userId | String | POLYV 用戶 ID,與保利威官網一致,取得路徑:官網 -> 登入 -> 直播(開發設定) |
| channelId | String | 頻道號 |
| name | String | 商品名稱 |
| productType | String | 商品類型,可能的值有: normal: 普通商品 finance: 金融商品 position: 職位商品 |
| cover | String | 商品封面連結 |
| link | String | 商品通用類型商品連結 |
| status | Integer | 商品上下架狀態 1:上架狀態 2:下架狀態 |
| createdTime | Long | 建立商品時間,13 位毫秒級時間戳 |
| lastModified | Long | 更新商品時間,13 位毫秒級時間戳 |
| rank | Integer | 商品排序號 |
| type | String | 平台標誌,預設 live,其他無效 |
| linkType | Integer | 商品連結類型 10:通用連結 11:多平台連結 |
| pcLink | String | 多平台連結,PC 端跳轉連結 |
| mobileLink | String | 多平台連結,行動 WEB 端跳轉連結 |
| wxMiniprogramLink | String | 多平台連結,小程式端跳轉連結 |
| wxMiniprogramOriginalId | String | 多平台連結,小程式端 ID |
| mobileAppLink | String | 多平台連結,行動 APP 端跳轉連結 |
| androidLink | String | 多平台連結,行動 APP-安卓系統原生頁面連結 |
| iosLink | String | 多平台連結,行動 APP-蘋果系統原生頁面連結 |
| params | String | 自訂參數,json 物件 |
| showId | Integer | 顯示 id |
| btnShow | String | 按鈕顯示文案 |
| features | String | 產品特色,賣點標籤,json 陣列 |
| productDesc | String | 產品描述,支援特殊字元 |
| yield | String | 產品收益率/價格 |
| originId | String | 源 id,從平台商品庫複製新建的商品有值 |
| productDetail | String | 商品詳情,回傳的是內容存放的地址:例如 https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json url 存放的就是商品詳情內容 |
| ext | String | 擴展資訊:JSON 物件字串:{"coverList":["封面圖地址,最多15個"], "videoList":[{"videoSource":"影片來源", "videoId":"影片ID"}]} 【詳情見EXT】 |
| tags | List | 商品標籤資訊 【詳情見商品標籤資訊】 |
| - | - | 以下為普通商品專用參數 (productType=normal) |
| priceType | String | 商品實際價格類型,可能的值有: AMOUNT: 金額 CUSTOM: 自訂 |
| realPrice | Float | 商品實際價格-金額,最高精確度為兩位小數,如 12.34 |
| customPrice | String | 商品實際價格-自訂 |
| originalPriceType | String | 商品原始價格(劃線價格)類型,可能的值有: AMOUNT: 金額 CUSTOM: 自訂 |
| price | Float | 商品原始價格(劃線價格)-金額,最高精確度為兩位小數,如 12.34 |
| customOrignalPrice | String | 商品原始價格(劃線價格)-自訂備註:如果 price 和 customOriginalPrice 都為空,則表示不啟用原始價格(劃線價格) |
| - | - | 以上為普通商品專用參數 (productType=normal) |
商品詳情 productDetail url 裡存放內容範例
{
"productDetail": "<p>这是商品详情</p>"
}
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-素材庫 |
商品標籤資訊
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| id | true | Long | 標籤ID |
| name | true | String | 標籤名稱 |
Java 請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼,下載後加入自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 查询频道商品库商品列表
* @throws IOException
*/
@Test
public void testGetChannelProductList() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId=super.appId;
String appSecret=super.appSecret;
String userId = super.userId;
String timestamp=String.valueOf(System.currentTimeMillis());
//业务参数
String channelId = "1965681";
String url = "http://api.polyv.net/live/v3/channel/product/list";
String page = "1";
String size = "1";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId", channelId);
requestMap.put("page",page);
requestMap.put("size", size);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道商品库商品列表:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageSize": 1,
"pageNumber": 1,
"totalItems": 53,
"contents": [
{
"productId": 134827,
"userId": "1b448be323",
"channelId": 2272655,
"name": "测试添加金融产品1",
"price": null,
"cover": "",
"link": "http://live.polyv.net",
"status": 1,
"createdTime": 1661390909000,
"lastModified": 1661390909000,
"rank": 55,
"realPrice": 0,
"type": "live",
"linkType": 10,
"pcLink": "",
"mobileLink": "",
"androidLink": null,
"iosLink": null,
"otherLink": null,
"wxMiniprogramLink": "",
"wxMiniprogramOriginalId": "",
"mobileAppLink": "",
"params": "{\"id\": 21, \"color\": \"blue\", \"level\": 1}",
"productType": "finance",
"btnShow": "测试按钮显示",
"features": "[\"tab1\", \"tab2\"]",
"productDesc": "测试产品描述",
"yield": "10.01%",
"showId": 53
}
],
"limit": 1,
"totalPages": 53,
"nextPageNumber": 2,
"endRow": 1,
"startRow": 1,
"firstPage": true,
"lastPage": false,
"prePageNumber": 1,
"offset": 0
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
