查詢邀請海報明細資料

介面描述

1、分页查询邀请海报明细数据统计
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/invite/list

線上API呼叫

請求方式

GET

介面限制

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

2、開始時間、結束時間的時間跨度最多12個月，預設查詢最近12個月資料

請求參數描述

範例

http://api.polyv.net/live/v4/channel/invite/list?appId=frlr1zazn3&sign=4C1BD42EA7269623987B3AD78184C5F5&channelId=2272655&timestamp=1652412966735

回應參數描述

Error參數描述

data參數描述

contents參數描述

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 getInviteStatsTest() 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/invite/list";
    String channelId = "2272655";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询邀请海报明细数据统计成功：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "7e1dbcafd52042dba58123f11b82a3be.63.16566368534184845",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "invitee": null,
                "openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "viewerId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "nickname": "sadboy",
                "createdTime": 1651219412000,
                "receiverNickname": "阿白",
                "receiverOpenId": "ovtl9t71yTtyEsGESz3N4kdp01Hw",
                "receiverViewerId": "ovtl9t71yTtyEsGESz3N4kdp01Hw",
                "receiverTime": 1651219575000,
                "receiverAvatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM7tL1eMbJXrbg64nibHqqJUCde9EzoPXQZhFyf7konCRvdGfpH8vD46pMiaLibStiboJVKbszGoKXhEhA/132",
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
                "TBname": null,
                "TBnumber": null
            },
            {
                "invitee": null,
                "openId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "viewerId": "ovtl9t44bqXDfubCPlAukB5ImaeQ",
                "nickname": "sadboy",
                "createdTime": 1651219412000,
                "receiverNickname": "神经蛙",
                "receiverOpenId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
                "receiverViewerId": "ovtl9twa7JHyHBBA8QUNVjjM4WIs",
                "receiverTime": 1651219476000,
                "receiverAvatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM48yCrkV6bNEauNqC60hZJ38eZkVt5YBiasWbq4MA9I5kgs6Oodicc5vpXSICosTibybCT5mgibhIwCNA/132",
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q3auHgzwzM6n3d8AYtzyMiaE1U4fYNAJ7rXJExuB4a2dMweEsPJS4qLcBYK22bXibfa4mJGKSULBKBCMicKJaKtqw/132",
                "TBname": null,
                "TBnumber": null
            }
        ]
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}