You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取直播间投票数据

最近更新时间：2023.11.08 09:30:21

首次发布时间：2023.02.01 14:10:46

我的收藏

获取直播间的投票数据。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetVoteStatisticsAPI接口名称。当前 API 的名称为 GetVoteStatisticsAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1231231231直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageNoInteger否1分页查询页码，默认取值为 1
PageCountInteger否10分页查询数量，默认取值为 10
VoteIdString是vote1754472505032763投票 ID。您可以通过调用 GetVoteListAPI 接口查询投票 ID

返回参数

参数类型示例值描述
PageNoInteger1分页查询页码
PageCountInteger10分页查询数量
TotalCountInteger1查询结果总数
VoteStatisticsListArray of VoteStatisticsList-投票观众信息列表

VoteStatisticsList

参数类型示例值描述
UserChoseArray of UserChose-投票信息
UserNameStringaa1观众昵称
IPString10.5.22.56观众的 IP 地址
VoteTimeInteger1673169500投票时间
ExtraStringabc业务方扩展参数
UserIDLong1738686737584142观众 ID
UserTelString137xxxxx88观众手机号
EmailStringzhibo@xxx.com观众邮箱
UserAgentStringIntel Mac OS X 10_15_7观众终端类型
ExternalIdString1605756488530014观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计

UserChose

参数类型示例值描述
OptionSiteStringD投票选项
OptionNameString投票内容投票选项的内容

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetVoteStatisticsAPI&Version=2020-06-01&ActivityId=1231231231&PageCount=10&PageNo=1&VoteId=vote1754472505032763

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230111220338BE4E6B41689F6C1A64C1",
    "Action": "GetVoteStatisticsAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673445818
  },
  "Result": {
    "VoteStatisticsList": [
      {
        "UserChose": [
          {
            "OptionSite": "D",
            "OptionName": "投票内容"
          }
        ],
        "UserName": "aa1",
        "IP": "10.5.22.56",
        "VoteTime": 1673169500,
        "Extra": "abc",
        "UserID": 1738686737584142,
        "UserTel": "137xxxxx88",
        "Email": "zhibo@xxx.com",
        "UserAgent": "Intel Mac OS X 10_15_7",
        "ExternalId": "1605756488530014"
      }
    ],
    "PageNo": 1,
    "PageCount": 10,
    "TotalCount": 1
  }
}

错误码

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

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