保利威文档中心

幫助中心

查詢頻道卡片推播

更新時間:2023-10-11 15:57:19

介面描述

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
channelId true String 頻道ID

範例

http://api.polyv.net/live/v4/channel/card-push/list?appId=frlr1zazn3&sign=56C7EFE6CFA7A76CA3AAB272CABAC22F&channelId=2523307&timestamp=1632994650498

回應參數描述

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

data參數描述

參數名 類型 說明
element ChannelCardPushVO 【詳見element欄位說明

Error參數描述

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

element參數描述

參數名 類型 說明
id Long 卡片推播ID
channelId Integer 頻道ID
title String 卡片標題,最多16個字元
imageType String 卡片樣式類型
giftbox:禮物領取樣式
redpack:紅包樣式
custom:自訂
duration Integer 卡片倒數計時時長,取值:0,5,10,20,30,單位:秒,0為不顯示倒數計時時長
link String 卡片跳轉連結位址,帶http://等协议头
pushEndTime Long 推播結束時間,13位時間戳
createdTime Long 建立時間,13位時間戳
lastModified Long 修改時間,13位時間戳
pushStatus String 推播狀態
Y:推播中
N:未推播
L:上次推播
pushTime Long 推播時間,13位時間戳
enterEnabled String 卡片入口
Y:開啟
N:關閉
showCondition String 彈出方式
PUSH:推播後立即彈出
WATCH:觀看後彈出
conditionValue Integer 觀看時長
conditionUnit String 觀看時長單位
SECONDS:秒
MINUTES:分鐘
countdownMsg String 倒數計時文案,showCondition為WATCH時生效,最多8個字元
linkEnabled String 卡片跳轉開關
Y:開啟
N:關閉
redirectType String 跳轉方式
iframe:頁內顯示
tab:新開頁面
enterImage String 卡片入口圖片
cardImage String 卡片圖片

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 测试查询频道卡片推送
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getChannelCardPush() 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/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", "2523307");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url,requestMap);
    
    log.info("测试查询频道卡片推送,返回值:{}", response);
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "f36c6ee6-354a-4a45-b7db-ffd002490604",
    "data": [
        {
            "id": 1141,
            "channelId": 2523307,
            "title": "aaa",
            "imageType": "redpack",
            "duration": 0,
            "link": "http://www.polyv.net",
            "pushEndTime": 1631095525000,
            "createdTime": 1631092742000,
            "lastModified": 1631095536000,
            "pushStatus": "N",
            "pushTime": 1631095525000,
            "enterEnabled": "Y",
            "showCondition": "PUSH",
            "conditionValue": 10,
            "conditionUnit": "MINUTES",
            "countdownMsg": ""
        },
        {
            "id": 1187,
            "channelId": 2523307,
            "title": "卡片推送",
            "imageType": "redpack",
            "duration": 10,
            "link": "http://www.polyv.net",
            "pushEndTime": 1632882522000,
            "createdTime": 1632882522000,
            "lastModified": null,
            "pushStatus": "N",
            "pushTime": null,
            "enterEnabled": "Y",
            "showCondition": "PUSH",
            "conditionValue": 20,
            "conditionUnit": "SECONDS",
            "countdownMsg": "测试8个字符"
        }
    ],
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360829427963481",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询