Create Channel Card Push

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameters Description

Example

http://api.polyv.net/live/v4/channel/card-push/create?duration=10&showCondition=PUSH&countdownMsg=%E6%B5%8B%E8%AF%958%E4%B8%AA%E5%AD%97%E7%AC%A6%E6%88%90%E5%8A%9F&appId=frlr1zazn3&link=http%3A%2F%2Fwww.polyv.net&sign=7C51748CDDE6CE707031B3B9F75F8E0D&conditionValue=20&enterEnabled=Y&title=%E5%8D%A1%E7%89%87%E6%8E%A8%E9%80%81&imageType=redpack&channelId=2523307&timestamp=1632882516916

Response Parameters Description

Error Parameter Description

Data Parameter Description

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java from the test cases are included in the downloaded 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 pools.

    /**
     * 测试创建频道卡片推送
     * @throws IOException
     * @throws NoSuchAlgorithmException
     */
    @Test
    public void testCreateChannelCardPush() 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/create";
    
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", "2523307");
        
        requestMap.put("imageType", "redpack");
        requestMap.put("title", "卡片推送");
        requestMap.put("link", "http://www.polyv.net");
        requestMap.put("duration", "10");
        requestMap.put("showCondition", "PUSH");
        requestMap.put("conditionValue", "20");
        requestMap.put("countdownMsg", "测试8个字符成功");
        requestMap.put("enterEnabled", "Y");
    
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
        String response = HttpUtil.get(url,requestMap);
    
        log.info("测试创建频道卡片推送成功，返回值：{}", response);
    }

Response Example

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "3118812d-f657-409b-b149-631f6799f7d1",
    "data": {
        "id": 1187,
        "channelId": 2523307,
        "title": "卡片推送",
        "imageType": "redpack",
        "duration": 10,
        "link": "http://www.polyv.net",
        "pushEndTime": 1632882522413,
        "createdTime": 1632882522416,
        "lastModified": null,
        "pushStatus": "N",
        "pushTime": null,
        "enterEnabled": "Y",
        "showCondition": "PUSH",
        "conditionValue": 20,
        "conditionUnit": null,
        "countdownMsg": "测试8个字符成功",
        "linkEnabled": "Y",
        "cardType": "common",
        "hrefType": "common",
        "pcLink": null,
        "mobileLink": null,
        "wxMiniprogramOriginalId": "xxx",
        "wxMiniprogramAppId": "xxx",
        "wxMiniprogramLink": "xxx",
        "durationPosition": null,
        "mobileAppLink": null
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360829892566053",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}