Modify Channel Card Push

API Description

1、修改频道卡片推送，对应新版后台的 营销-卡片
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/card-push/update

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

2. Optional request parameters use default values if not provided, except for related fields (e.g., the conditionUnit field is required when showCondition is WATCH).

Request Parameter Description

Request Body Parameter Description

Example

http://api.polyv.net/live/v4/channel/card-push/update?cardPushId=1282&appId=frlr1zazn3&sign=72F9A8F43AA957F17A8A5CDDB7DC6BA3&channelId=2477096&timestamp=1634268781984

Request body parameters:

{
    "duration": "10",
    "conditionUnit": "SECONDS",
    "showCondition": "WATCH",
    "countdownMsg": "测试8个字符成功",
    "link": "http://www.polyv.net",
    "conditionValue": "30",
    "enterEnabled": "Y",
    "title": "测试卡片推送1015",
    "imageType": "giftbox",
    "linkEnabled": "Y"
}

Response Parameter Description

Error Parameter Description

Java Request Example

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

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

/**
 * 测试修改频道卡片推送
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateChannelCardPush() 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/card-push/update";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", "2477096");
    requestMap.put("cardPushId", "1282");
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("imageType", "giftbox");
    jsonMap.put("title", "测试卡片推送1015");
    jsonMap.put("link", "http://www.polyv.net");
    jsonMap.put("duration", "10");
    jsonMap.put("showCondition", "WATCH");
    jsonMap.put("conditionValue", "30");
    jsonMap.put("conditionUnit", "SECONDS");
    jsonMap.put("countdownMsg", "测试8个字符成功");
    jsonMap.put("enterEnabled", "Y");
    jsonMap.put("linkEnabled", "Y");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试修改频道卡片推送成功，返回值：{}", response);
}

Response Example

Success example

{
    "code": 200,
    "status": "success",
    "requestId": "847f0716fa76461baf8979aaa4415dc3.65.16342687861804037",
    "data": null,
    "success": true
}

Error example

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360830583026105",
    "error": {
        "code": 30004,
        "desc": "找不到频道"
    },
    "success": false
}