修改頻道卡片推送
更新時間:2025-11-03 18:26:29
介面描述
1、修改频道卡片推送,对应新版后台的 营销-卡片
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/channel/card-push/update
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、非必選的請求參數,如果不傳則使用預設項,關聯關係除外(如:conditionUnit欄位在showCondition為WATCH時,需必填)
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 頻道號 |
| cardPushId | true | Long | 卡片推送主鍵ID |
請求體參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| cardType | false | String | 卡片類型,common-普通卡片,qrCode-二維碼,預設:common |
| imageType | false | String | 卡片樣式類型 giftbox:禮物領取樣式 redpack:紅包樣式 custom:自訂 weixinWork:企微 |
| title | false | String | 卡片標題,最多16個字元 |
| link | false | String | 卡片跳轉連結位址,需要帶http:等協定頭(當 hrefType=common 時使用) |
| duration | false | Integer | 卡片倒數計時時長,取值:0,5,10,20,30,單位:秒,0為不顯示倒數計時時長 |
| durationPosition | false | String | 卡片倒數計時時長顯示位置,bottom-底部,top-右上角 |
| showCondition | false | String | 彈出方式 PUSH:推送後立即彈出 WATCH:觀看後彈出 |
| conditionValue | false | Integer | 觀看後彈出的觀看時長,showCondition為WATCH時生效 |
| conditionUnit | false | String | 觀看後彈出的觀看時長單位 SECONDS:秒 MINUTES:分鐘 showCondition為WATCH時,該值生效且必填 |
| countdownMsg | false | String | 倒數計時文案,showCondition為WATCH時生效,最多8個字元 |
| enterEnabled | false | String | 卡片入口開關 Y:開啟 N:關閉 |
| linkEnabled | false | String | 卡片跳轉開關 Y:開啟 N:關閉 |
| redirectType | false | String | 跳轉方式 iframe:頁內顯示 tab:新開頁面 |
| enterImage | false | String | 卡片入口圖片 |
| cardImage | false | String | 卡片圖片 |
| weixinWordQrCodeId | false | String | 企微渠道碼ID(當 imageType=weixinWork 時生效) |
| qrCodeImage | false | String | 二維碼圖片(當 cardType=qrCode 時生效) |
| hrefType | false | String | 跳轉類型,common-普通(使用 link 欄位),multiplatform-多平台(使用多端連結欄位) |
| 以下參數,當 hrefType=multiplatform 時生效 | |||
| pcLink | false | String | 電腦瀏覽器連結 |
| mobileLink | false | String | 手機瀏覽器連結 |
| wxMiniprogramOriginalId | false | String | 微信小程式原始ID |
| wxMiniprogramAppId | false | String | 微信小程式appId |
| wxMiniprogramLink | false | String | 微信小程式頁面路徑 |
| mobileAppLink | false | String | 手機App連結 |
範例
http://api.polyv.net/live/v4/channel/card-push/update?cardPushId=1282&appId=frlr1zazn3&sign=72F9A8F43AA957F17A8A5CDDB7DC6BA3&channelId=2477096×tamp=1634268781984
請求體參數:
{
"duration": "10",
"conditionUnit": "SECONDS",
"showCondition": "WATCH",
"countdownMsg": "测试8个字符成功",
"link": "http://www.polyv.net",
"conditionValue": "30",
"enterEnabled": "Y",
"title": "测试卡片推送1015",
"imageType": "giftbox",
"linkEnabled": "Y"
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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 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);
}
回應範例
成功範例
{
"code": 200,
"status": "success",
"requestId": "847f0716fa76461baf8979aaa4415dc3.65.16342687861804037",
"data": null,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360830583026105",
"error": {
"code": 30004,
"desc": "找不到频道"
},
"success": false
}
