获取直播间签到列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间签到列表

最近更新时间：2024.10.29 18:12:27首次发布时间：2023.02.01 14:10:46

通过本接口，获取指定直播间的所有签到信息，包括签到 ID、参与人数及签到时长等。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetCheckInListAPI&Version=2020-06-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetCheckInListAPI`	接口名称。当前 API 的名称为 `GetCheckInListAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`177916828715`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageNo	Integer	否	`1`	分页查询页码，默认取值为 `1`。
PageCount	Integer	否	`10`	分页查询数量。取值范围为 [1,500]，默认取值为 `10`。

返回参数

参数	类型	示例值	描述
CheckInList	Array of CheckInList	`-`	签到信息列表。
PageNo	Integer	`1`	分页查询页码。
PageCount	Integer	`10`	分页查询数量。

CheckInList

参数	类型	示例值	描述
CheckInId	String	`checkIn1754478641140736`	签到 ID。
CheckInName	String	`签到开始`	签到标题。
CheckInCount	Integer	`0`	参与签到的人数。
Deadline	Integer	`1`	签到时长中的分钟数。
DeadlineSecond	Integer	`31`	签到时长中的秒数。
Status	String	`Deadline`	签到状态。取值如下： `Init`：已创建 `Export`：已发送 `Deadline`：已截止 `Delete`：已删除 `Retract`：已撤回
ActivityId	Long	`175450930238536`	直播间 ID。
NeedPersonInfo	Integer	`0`	是否需要填写签到信息。取值如下： `0`：不需要 `1`：需要
OpenCheckTime	Integer	`1673202771`	签到截止时间。Unix 时间戳，单位为秒。
CheckInInfo	String	`请签到`	签到提示文案。
StartTime	String	`1673202711`	签到开始时间。Unix 时间戳，单位为秒。
IsSendComment	Integer	`1`	签到后是否发送评论。取值如下： `0`：不发送 `1`：发送
CommentContent	String	`#用户昵称#已签到`	签到后发送的评论文案。说明仅当 `IsSendComment` 取值为 `1` 时，该参数会生效。
CannotWathcLiveWhenNotCheckIn	Integer	`1`	未按时签到的观众是否会被踢出直播间。取值如下： `0`：不被踢出。 `1`：被踢出。
SendType	Integer	`1`	签到发送方式。取值如下： `0`：手动发送。 `1`：定时发送。
AutoSendTime	Long	`1723455354`	定时发送的时间。Unix 时间戳，单位为秒。说明仅当 `SendType` 取值为 `1` 时，该参数生效。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetCheckInListAPI&Version=2020-06-01&ActivityId=177916828715

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetCheckInListAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1701074367
    },
    "Result": {
        "CheckInList": [
            {
                "CheckInId": "checkIn1754478641140736",
                "CheckInName": "签到开始",
                "CheckInCount": 0,
                "Deadline": 1,
                "DeadlineSecond": 31,
                "Status": "Deadline",
                "ActivityId": 175450930238536,
                "NeedPersonInfo": 0,
                "OpenCheckTime": 1673202771,
                "CheckInInfo": "请签到",
                "StartTime": "1673202711",
                "IsSendComment": 1,
                "CommentContent": "#用户昵称#已签到",
                "CannotWathcLiveWhenNotCheckIn": 1,
                "SendType": 1,
                "AutoSendTime": 1723455354
                
            }
        ],
        "PageNo": 1,
        "PageCount": 10
    }
}

错误码

访问公共错误码和错误码获取详细信息。