最近更新时间:2023.02.24 10:02:40
首次发布时间:2022.07.29 09:54:20
获取指定直播间用户填写的报名信息。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称 |
Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01 |
ActivityID | Int64 | 是 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID |
StartTime | Int64 | 否 | 筛选开始时间,Unix 时间戳,单位为秒 |
EndTime | Int64 | 否 | 筛选结束时间,Unix 时间戳,单位为秒 |
ReviewStatus | Int32 | 否 | 审核状态。默认取值为
|
Content | String | 否 | 筛选关键字,支持输入中英文字符和数字 |
PageNo | Int | 否 | 分页查询页码,默认取值为 1 |
PageCount | Int | 否 | 分页查询数量,默认取值为 50 |
SortOrder | Int | 是 | 排序方式
|
Extra | String | 否 | 根据业务方扩展参数进行筛选 |
参数 | 类型 | 描述 |
---|---|---|
PageNo | Int | 分页查询页码 |
PageCount | Int | 分页查询数量 |
TotalCount | Int | 查询到的用户总数 |
UserFormList | Array of UserFormList | 直播间观众报名信息列表 |
参数 | 类型 | 描述 |
---|---|---|
UserFormID | Int | 报名 ID |
UserId | Int | 用户 ID |
NickName | String | 用户昵称 |
EnterName | String | 用户姓名 |
EnterTel | String | 报名手机号 |
EnterTime | Int | 报名时间 |
ReviewStatus | Int | 报名审核状态
|
UserAgent | String | 用户终端类型 |
ExternalId | String | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计 |
UserTel | String | 用户手机号 |
Ip | String | 用户的 IP 地址 |
String | 用户邮箱 | |
UserForm | String | 用户填写的报名信息 |
WatchActivityTime | Int | 观看直播的时间,Unix 时间戳,单位为秒 |
IsWatchLive | Int | 是否观看直播
|
Extra | String | 业务方扩展参数 |
Get http://livesaas.volcengineapi.com/?Action=ListUserSubmitEnterReviewAPI&Version=2020-06-01&ActivityID=1231231231&StartTime=123&EndTime=124&ReviewStatus=-1&PageNo=1&PageCount=10&SortOrder=0
{ "ResponseMetadata":{ "RequestId":"202201201826170101501312091D1C09D2", "Action":"ListUserSubmitEnterReviewAPI", "Version":"2020-06-01", "Service":"livesaas", "Region":"cn-north-1", "SystemTime":1656067132 } "Result":{ "PageNo": 1, "PageCount": 10, "TotalCount": 1, "Extra":"abc", "UserFormList": [ { "UserFormID": 1, "UserId": 1312312, "NickName": "sansan", "EnterName": "张三", "EnterTel": "+86156xxxx680", "EnterTime": 12312313, "ReviewStatus": 1, "UserAgent": "Intel Mac OS X 10_15_7", "ExternalId": "1605756488530014", "UserTel": "139***6965", "Ip": "10.5.22.56", "Email": "zhibo@xxx.com", "UserForm": "[{\"key\":\"name\",\"value\":\"张三\",\"title\":\"你的姓名\"},\"key\":\"phone\",\"value\":\"+86156xxxx680\",\"title\":\"你的手机号码\"},\"key\":\"position\",\"value\":\"职位名称\",\"title\":\"你的职位\"}]", "WatchActivityTime": "12312313457", "IsWatchLive": 1 }] } }
{ "ResponseMetadata": { "RequestId": "20230128141655C4A94C6D3E9F4CF8AD18", "Action": "ListUserSubmitEnterReviewAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "Error": { "Code": "InvalidParameter.ActivityIDInvalid", "Message": "The specified parameter ActivityID is invalid." }, "SystemTime": 1674886615 }, "Result": null }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |