GetVoteListAPI - 获取直播间投票配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetVoteListAPI - 获取直播间投票配置信息

最近更新时间：2025.03.24 16:50:55首次发布时间：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&PageNo=1&PageCount=10

返回示例

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

错误码

访问公共错误码和错误码获取详细信息。