获取直播间签到列表

获取直播间的签到列表。

请求说明

• 接口名称：GetCheckInListAPI
• 请求方式：GET
• 接口地址：http://livesaas.volcengineapi.com/?Action=GetCheckInListAPI&Version=2020-06-01
• 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

返回参数

CheckInConfig

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetCheckInListAPI&Version=2020-06-01&ActivityId=175450930238536

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023011522403120E0E772EF629DDF8229",
        "Action": "GetCheckInListAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673793631
    },
    "Result": {
        "CheckInList": [
            {
                "CheckInId": "checkIn1754478641140736",
                "CheckInName": "签到开始",
                "CheckInCount": 0,
                "Deadline": 1,
                "Status": "Deadline",
                "ActivityId": 175450930238536,
                "NeedPersonInfo": 0,
                "OpenCheckTime": 1673202771,
                "CheckInInfo": "",
                "StartTime": 1673202711
            }
        ],
        "PageNo": 1,
        "PageCount": 10
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023010901154861C57537B04A4A16B7C1",
        "Action": "GetCheckInListAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.ActivityIdNotFound",
            "Message": "The specified parameter ActivityId is invalid."
        },
        "SystemTime": 1673198148
    },
    "Result": null
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码文档。