获取直播间投票列表信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间投票列表信息

最近更新时间：2023.11.08 09:30:21首次发布时间：2023.02.01 14:10:46

获取直播间的投票列表信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetVoteListAPI`	接口名称。当前 API 的名称为 `GetVoteListAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1779168288280`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID
PageNo	Integer	否	`1`	分页查询页码，默认取值为 `1`
PageCount	Integer	否	`10`	分页查询数量，默认取值为 `10`

返回参数

参数	类型	示例值	描述
PageNo	Integer	`1`	分页查询页码
PageCount	Integer	`10`	分页查询数量
VoteList	Array of VoteList	`-`	直播间投票列表信息

VoteList

参数	类型	示例值	描述
VoteId	String	`vote1779514244272189`	投票 ID
Title	String	`投票`	投票标题
TotalCount	Integer	`1`	参与人数
ChoiceType	String	`Single`	投票类型 Single：单选 Multiple：多选
Deadline	Integer	`1697166317`	投票的截止时间。Unix 时间戳，单位为秒
Status	String	`Export`	投票的状态 Init：已创建 Export：已发送 Deadline：已截止 Delete：已删除
ActivityId	Long	`1779168288280`	直播间 ID

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetVoteListAPI&Version=2020-06-01&ActivityId=1779168288280&PageCount=10&PageNo=1

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20231012110601BC86AE9262518102B429",
    "Action": "GetVoteListAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1697079961
  },
  "Result": {
    "VoteList": [
      {
        "VoteId": "vote1779514244272189",
        "Title": "投票",
        "TotalCount": 1,
        "ChoiceType": "Single",
        "Deadline": 1697166317,
        "Status": "Export",
        "ActivityId": 1779168288280
      }
    ],
    "PageNo": 1,
    "PageCount": 10
  }
}

错误码

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

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