获取直播间签到名单--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间签到名单

最近更新时间：2023.11.08 09:30:21首次发布时间：2023.02.01 14:10:46

获取直播间的签到名单。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetCheckInRecordStatisticsAPI`	接口名称。当前 API 的名称为 `GetCheckInRecordStatisticsAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`175450930238536`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageNo	Integer	否	`1`	分页查询页码，默认取值为 `1`
PageItemCount	Integer	否	`10`	分页查询数量，默认取值为 `10`
CheckInId	String	是	`checkIn1754478641140752`	签到 ID。您可以通过调用 GetCheckInListAPI 接口查询 ID

返回参数

参数	类型	示例值	描述
CheckInStatisticsList	Array of CheckInStatisticsList	`-`	签到观众信息列表
PageNo	Integer	`1`	分页查询页码
PageItemCount	Integer	`10`	分页查询数量
PageTotalCount	Integer	`1`	查询结果总数

CheckInStatisticsList

参数	类型	示例值	描述
ActivityId	Long	`175450930238536`	直播间 ID
CheckInID	String	`checkIn1754478641140752`	签到 ID
UserID	Long	`1738686737584142`	观众 ID
UserName	String	`aa`	观众昵称
LoginTel	String	`158xxxx66`	观众登录手机号
Email	String	`zhibo@xxxx.com`	观众邮箱
CheckInTime	Integer	`1673202796`	观众的签到时间，Unix 时间戳，单位为秒
PersonInfo	String	`aa`	观众的签到信息
Extra	String	`abc`	业务方扩展字段
UserAgent	String	`Intel Mac OS X 10_15_7`	观众终端设备
Ip	String	`10.5.22.56`	观众的 IP 地址
ExternalId	String	`1605756488530014`	观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetCheckInRecordStatisticsAPI&Version=2020-06-01&ActivityId=175450930238536&CheckInId=checkIn1754478641140752&PageItemCount=10&PageNo=1

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023011522495018E7584C094220D803B5",
    "Action": "GetCheckInRecordStatisticsAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673794190
  },
  "Result": {
    "PageNo": 1,
    "PageItemCount": 10,
    "PageTotalCount": 1,
    "CheckInStatisticsList": [
      {
        "ActivityId": 175450930238536,
        "CheckInID": "checkIn1754478641140752",
        "UserID": 1738686737584142,
        "UserName": "aa",
        "LoginTel": "158xxxx66",
        "Email": "zhibo@xxxx.com",
        "CheckInTime": 1673202796,
        "PersonInfo": "aa",
        "Extra": "abc",
        "UserAgent": "Intel Mac OS X 10_15_7",
        "Ip": "10.5.22.56",
        "ExternalId": "1605756488530014"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter.ActivityIDInvalid	The specified parameter ActivityID is invalid.	直播间 ID 不符合规范，请修改后重试
500	InternalError	The request has failed due to an unknown error.	请求处理过程中出现了未知错误，请联系技术支持获取帮助