Query Invitation Poster Detail Data

API Description

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

API URL

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

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

2. The time span between start time and end time is at most 12 months. The default query is for the last 12 months of data.

Request Parameter Description

Example

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

Response Parameter Description

Error Parameter Description

data Parameter Description

contents Parameter Description

Java Request Example

For quick integration of 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 in 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.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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