Pin Channel Product

Updated: 2026-03-05 18:09:21

Interface Description

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

Interface URL

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

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details
Only existing products that are in the listed state can be pinned.
Only one product per channel can be pinned at a time. Pinning a new product will automatically unpin the previously pinned product.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining credentials
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	Integer	Channel ID

Request Body Parameter Description

Parameter	Required	Type	Description
productId	true	Integer	Channel product ID

Example

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

Request body JSON parameters:

{
  "productId": 27537
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
data	Object	Response data, usually null on success
error	Object	Error information when status code is not 200 See Error field description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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);
}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example (Product Not Found)

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

Error Example (Unlisted Product Not Allowed)

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