You need to enable JavaScript to run this app.
导航

获取直播间签到列表

最近更新时间2024.03.14 12:17:05

首次发布时间2023.02.01 14:10:46

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetCheckInListAPI接口名称。当前 API 的名称为 GetCheckInListAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
ActivityIdLong177916828715直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageNoInteger1分页查询页码,默认取值为 1
PageCountInteger10分页查询数量,默认取值为 10

返回参数

参数类型示例值描述
CheckInListArray of CheckInList-签到信息列表。
PageNoInteger1分页查询页码。
PageCountInteger10分页查询数量。

CheckInList

参数类型示例值描述
CheckInIdStringcheckIn1754478641140736签到 ID。
CheckInNameString签到开始签到标题。
CheckInCountInteger0参与签到的人数。
DeadlineInteger1签到时长。单位为分。

Status

String

Deadline

签到状态。支持以下取值:

  • Init:已创建
  • Export:已发送
  • Deadline:已截止
  • Delete:已删除
  • Retract:已撤回
ActivityIdLong175450930238536直播间 ID。

NeedPersonInfo

Integer

0

是否需要填写签到信息。支持以下取值:

  • 0:不需要
  • 1:需要
OpenCheckTimeInteger1673202771签到截止时间。Unix 时间戳,单位为秒。
CheckInInfoString请签到签到提示文案。
StartTimeString1673202711签到开始时间。Unix 时间戳,单位为秒。

IsSendComment

Integer

1

签到后是否发送评论。支持以下取值:

  • 0:不发送
  • 1:发送

CommentContent

String

#用户昵称#已签到

签到后发送的评论文案。

说明

仅当 IsSendComment 取值为 1 时,该参数会生效。

示例

请求示例

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

返回示例

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

错误码

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