最近更新时间：2023.02.01 14:10:46
首次发布时间：2023.02.01 14:10:46
获取直播间的签到名单。
以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| Action | String | 是 | 接口名称 |
| Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01 |
| ActivityId | Int64 | 是 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID |
| PageNo | Int | 否 | 分页查询页码，默认取值为 1 |
| PageItemCount | Int | 否 | 分页查询数量，默认取值为 10 |
| CheckInId | String | 是 | 签到 ID。您可以通过调用 GetCheckInListAPI 接口查询 ID |
| 参数 | 类型 | 描述 |
|---|---|---|
| CheckInStatisticsList | Array of CheckInStatistic | 签到观众信息列表 |
| PageNo | Int | 分页查询页码 |
| PageItemCount | Int | 分页查询数量 |
| PageTotalCount | Int | 查询结果总数 |
| 参数 | 类型 | 描述 |
|---|---|---|
| ActivityId | Int | 直播间 ID |
| CheckInID | String | 签到 ID |
| UserID | Int | 观众 ID |
| UserName | String | 观众昵称 |
| LoginTel | string | 观众登录手机号 |
| String | 观众邮箱 | |
| CheckInTime | Int | 观众的签到时间，Unix 时间戳，单位为秒 |
| PersonInfo | String | 观众的签到信息 |
| Extra | String | 业务方扩展字段 |
| UserAgent | String | 观众终端设备 |
| Ip | String | 观众的 IP 地址 |
| ExternalId | String | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计 |
Get http://livesaas.volcengineapi.com/?Action=GetCheckInRecordStatisticsAPI&Version=2020-06-01&ActivityId=175450930238536&CheckInId=checkIn1754478641140752
{ "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" } ] } }
{ "ResponseMetadata": { "RequestId": "2023010901154861C57537B04A4A16B7C1", "Action": "GetCheckInRecordStatisticsAPI", "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 }
下表提供了该接口特有的错误码，公共错误码请参见公共错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范，请修改后重试 |
| 500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误，请联系技术支持获取帮助 |