获取指定直播间用户填写的报名信息。
请求频率:单用户请求频率限制为 120 次/分钟。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListUserSubmitEnterReviewAPI | 接口名称。当前 API 的名称为 ListUserSubmitEnterReviewAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
ActivityID | Long | 是 | 177588964 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。 |
StartTime | Long | 否 | 1697007500 | 筛选开始时间,Unix 时间戳,单位为秒。 |
EndTime | Long | 否 | 1697007570 | 筛选结束时间,Unix 时间戳,单位为秒。 |
ReviewStatus | Integer | 否 |
| 审核状态。默认取值为
|
Content | String | 否 | 观众 A | 筛选关键字,支持输入中英文字符和数字 |
PageNo | Integer | 否 | 1 | 分页查询页码,默认取值为 1 |
PageCount | Integer | 否 | 50 | 分页查询数量,默认取值为 50 |
SortOrder | Integer | 是 |
| 排序方式。
|
Extra | String | 否 | abc | 根据业务方扩展参数进行筛选。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNo | Integer | 1 | 分页查询页码 |
PageCount | Integer | 50 | 分页查询数量 |
TotalCount | Integer | 1 | 查询到的用户总数 |
UserFormList | Array of UserFormList | - | 直播间观众报名信息列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
UserFormID | Integer | 6301 | 报名 ID |
UserId | Long | 1744663139363934 | 用户 ID |
NickName | String | 观众 A | 用户昵称 |
EnterName | String | 李 | 用户姓名 |
EnterTel | String | +86182****5709 | 报名手机号 |
EnterTime | Integer | 1697007561 | 报名时间 |
ReviewStatus | Integer |
| 报名审核状态
|
UserAgent | String | Windows 10 | 用户终端类型 |
ExternalId | String | 31210506554471 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计 |
UserTel | String | 182****5709 | 用户手机号 |
Ip | String | 114.251.196.100 | 用户的 IP 地址 |
String | zhibo@exmple.com | 用户邮箱 | |
UserForm | String | [{"key":"name","value":"李","title":"你的姓名"},{"key":"phone","value":"+86182****5709","title":"你的手机号码"},{"key":"position","value":"员工","title":"你的职位"}] | 用户填写的报名信息 |
WatchActivityTime | Integer | 1697007561 | 观看直播的时间,Unix 时间戳,单位为秒 |
IsWatchLive | Integer |
| 是否观看直播
|
Extra | String | abc | 业务方扩展参数 |
GET https://livesaas.volcengineapi.com/?Action=ListUserSubmitEnterReviewAPI&Version=2020-06-01&ActivityID=177588964&Content=%E8%A7%82%E4%BC%97%20A&EndTime=1697007570&Extra=abc&PageCount=50&PageNo=1&ReviewStatus=1&SortOrder=0&StartTime=1697007500
{ "ResponseMetadata": { "RequestId": "20231011150432650D61AE6232576EAFC7", "Action": "ListUserSubmitEnterReviewAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697007872 }, "Result": { "PageNo": 1, "PageCount": 50, "TotalCount": 1, "UserFormList": [ { "UserForm": "[{\"key\":\"name\",\"value\":\"李\",\"title\":\"你的姓名\"},{\"key\":\"phone\",\"value\":\"+86182****5709\",\"title\":\"你的手机号码\"},{\"key\":\"position\",\"value\":\"员工\",\"title\":\"你的职位\"}]", "ReviewStatus": 1, "UserId": 1744663139363934, "NickName": "观众 A", "EnterTime": 1697007561, "UserFormID": 6301, "EnterName": "李", "EnterTel": "+86182****5709", "IsWatchLive": 1, "WatchActivityTime": 1697007561, "ExternalId": "31210506554471", "UserAgent": "Windows 10", "Ip": "114.251.196.100", "Extra": "abc", "Email": "zhibo@exmple.com", "UserTel": "182****5709" } ] } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |