You need to enable JavaScript to run this app.
导航
获取用户填写的报名信息
最近更新时间:2023.11.08 09:30:20首次发布时间:2022.07.29 09:54:20

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListUserSubmitEnterReviewAPI接口名称。当前 API 的名称为 ListUserSubmitEnterReviewAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
ActivityIDLong177588964直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
StartTimeLong1697007500筛选开始时间,Unix 时间戳,单位为秒。
EndTimeLong1697007570筛选结束时间,Unix 时间戳,单位为秒。

ReviewStatus

Integer

1

审核状态。默认取值为 0

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

SortOrder

Integer

0

排序方式。

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

返回参数

参数类型示例值描述
PageNoInteger1分页查询页码
PageCountInteger50分页查询数量
TotalCountInteger1查询到的用户总数
UserFormListArray of UserFormList-直播间观众报名信息列表

UserFormList

参数类型示例值描述
UserFormIDInteger6301报名 ID
UserIdLong1744663139363934用户 ID
NickNameString观众 A用户昵称
EnterNameString用户姓名
EnterTelString+86182****5709报名手机号
EnterTimeInteger1697007561报名时间

ReviewStatus

Integer

1

报名审核状态

  • 0:未审核
  • 1:审核拒绝
  • 2:审核通过
  • 3:自动通过
UserAgentStringWindows 10用户终端类型
ExternalIdString31210506554471观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
UserTelString182****5709用户手机号
IpString114.251.196.100用户的 IP 地址
EmailStringzhibo@exmple.com用户邮箱
UserFormString[{"key":"name","value":"李","title":"你的姓名"},{"key":"phone","value":"+86182****5709","title":"你的手机号码"},{"key":"position","value":"员工","title":"你的职位"}]用户填写的报名信息
WatchActivityTimeInteger1697007561观看直播的时间,Unix 时间戳,单位为秒

IsWatchLive

Integer

1

是否观看直播

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

示例

请求示例

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"
      }
    ]
  }
}

错误码

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

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