推送頻道卡片

更新時間：2022-09-15 09:50:53

介面描述

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

介面URL

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

線上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	頻道號
cardPushId	true	Long	卡片推送主鍵ID

範例

http://api.polyv.net/live/v4/channel/card-push/push?appId=frlr1zazn3&sign=CB444E3E2769FC16CA3B5F02CD97FF6B&channelId=2477096&timestamp=1634268622363

表單參數：

cardPushId=1282

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	成功回應時返回null
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求生成的唯一的UUID，僅可用於排查、除錯，不應該和業務掛鉤

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與error.code對應

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

/**
 * 测试推送频道卡片
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testPushChannelCardPush() 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/push";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", "2477096");
    
    Map<String, String> paramMap = new HashMap<>();
    paramMap.put("cardPushId", "1282");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    
    String response = HttpUtil.postFormBody(url, paramMap);
    
    log.info("测试推送频道卡片成功，返回值：{}", response);
}

回應範例

成功範例

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

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "31a6d48f9b8d43bcad2c0963e526cec3.61.16360830356323521",
    "error": {
        "code": 10001,
        "desc": "cardPushId不能为null"
    },
    "data": null,
    "success": false
}