You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

获取用户填写的报名信息

最近更新时间2023.02.24 10:02:40

首次发布时间2022.07.29 09:54:20

获取指定直播间用户填写的报名信息。

请求说明

  • 接口名称:ListUserSubmitEnterReviewAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=ListUserSubmitEnterReviewAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIDInt64直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
StartTimeInt64筛选开始时间,Unix 时间戳,单位为秒
EndTimeInt64筛选结束时间,Unix 时间戳,单位为秒

ReviewStatus

Int32

审核状态。默认取值为 0

  • -1:查询全部
  • 0:未审核
  • 1:审核拒绝
  • 2:审核通过
  • 3:自动通过
ContentString筛选关键字,支持输入中英文字符和数字
PageNoInt分页查询页码,默认取值为 1
PageCountInt分页查询数量,默认取值为 50

SortOrder

Int

排序方式

  • 0:根据报名时间倒序排列
  • 1:根据报名时间顺序排列
ExtraString根据业务方扩展参数进行筛选

返回参数

参数类型描述
PageNoInt分页查询页码
PageCountInt分页查询数量
TotalCountInt查询到的用户总数
UserFormListArray of UserFormList直播间观众报名信息列表

UserFormList

参数类型描述
UserFormIDInt报名 ID
UserIdInt用户 ID
NickNameString用户昵称
EnterNameString用户姓名
EnterTelString报名手机号
EnterTimeInt报名时间

ReviewStatus

Int

报名审核状态

  • 0:未审核
  • 1:审核拒绝
  • 2:审核通过
  • 3:自动通过
UserAgentString用户终端类型
ExternalIdString观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
UserTelString用户手机号
IpString用户的 IP 地址
EmailString用户邮箱
UserFormString用户填写的报名信息
WatchActivityTimeInt观看直播的时间,Unix 时间戳,单位为秒

IsWatchLive

Int

是否观看直播

  • 0:未观看
  • 1:观看
ExtraString业务方扩展参数

示例

请求示例

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
}

错误码

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

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