获取直播间的投票数据。
注意事项 请求频率:单用户请求频率限制为 120 次/分钟 。
请求说明 请求方式:GET 请求地址:https://livesaas.volcengineapi.com/?Action=GetVoteStatisticsAPI&Version=2020-06-01 请求参数 以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数 。
Query 参数 类型 是否必选 示例值 描述 Action String 是 GetVoteStatisticsAPI
接口名称。当前 API 的名称为 GetVoteStatisticsAPI
。 Version String 是 2020-06-01
接口版本。当前 API 的版本为 2020-06-01
。 ActivityId Long 是 1231231231
直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID PageNo Integer 否 1
分页查询页码,默认取值为 1
PageCount Integer 否 10
分页查询数量,默认取值为 10
VoteId String 是 vote1754472505032763
投票 ID。您可以通过调用 GetVoteListAPI 接口查询投票 ID
返回参数 参数 类型 示例值 描述 PageNo Integer 1
分页查询页码 PageCount Integer 10
分页查询数量 TotalCount Integer 1
查询结果总数 VoteStatisticsList Array of VoteStatisticsList -
投票观众信息列表
VoteStatisticsList 参数 类型 示例值 描述 UserChose Array of UserChose -
投票信息 UserName String aa1
观众昵称 IP String 10.5.22.56
观众的 IP 地址 VoteTime Integer 1673169500
投票时间 Extra String abc
业务方扩展参数 UserID Long 1738686737584142
观众 ID UserTel String 137xxxxx88
观众手机号 Email String zhibo@xxx.com
观众邮箱 UserAgent String Intel Mac OS X 10_15_7
观众终端类型 ExternalId String 1605756488530014
观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
UserChose 参数 类型 示例值 描述 OptionSite String D
投票选项 OptionName String 投票内容
投票选项的内容
示例 请求示例 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
}
}
错误码 下表提供了该接口特有的错误码,公共错误码请参见公共错误码 文档。
状态码 错误码 错误信息 说明 400 InvalidParameter.ActivityIDInvalid The specified parameter ActivityID is invalid. 直播间 ID 不符合规范,请修改后重试 500 InternalError The request has failed due to an unknown error. 请求处理过程中出现了未知错误,请联系技术支持获取帮助