You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

获取直播间投票列表信息

最近更新时间2023.03.10 11:30:24

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

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

请求说明

  • 接口名称:GetVoteListAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=GetVoteListAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageNoInt分页查询页码,默认取值为 1
PageCountInt分页查询数量,默认取值为 10

返回参数

参数类型描述
PageNoInt分页查询页码
PageCountInt分页查询数量
VoteListArray of VoteList 直播间投票列表信息

VoteList

参数类型描述
VoteIdString投票 ID
TitleString投票标题
TotalCountInt参与人数

ChoiceType

String

投票类型

  • Single:单选
  • Multiple:多选
DeadlineInt投票的截止时间。Unix 时间戳,单位为秒

Status

String

投票的状态

  • Init:已创建
  • Export:已发送
  • Deadline:已截止
  • Delete:已删除
ActivityIdInt直播间 ID

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetVoteListAPI&Version=2020-06-01&ActivityId=1231231231

正常返回示例

{
		"ResponseMetadata":{
				"RequestId":"202201201826170101501312091D1C09D2",
    "Action":"GetVoteListAPI",
    "Version":"2020-06-01",
    "Service":"livesaas",
    "Region":"cn-north-1",
       "SystemTime":1656067132
  }
    "Result": {
        "VoteList": [
            {
                "VoteId": "vote1754472505032763",
                "Title": "投票标题",
                "TotalCount": 1,
                "ChoiceType": "Single",
                "Deadline": 1673456594,
                "Status": "Init",
                "ActivityId": 1754450930238536
            }
        ],
        "PageNo": 1,
        "PageCount": 10
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023010901154861C57537B04A4A16B7C1",
        "Action": "GetVoteListAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.ActivityIdNotFound",
            "Message": "The specified parameter ActivityId is invalid."
        },
        "SystemTime": 1673198148
    },
    "Result": null
}

错误码

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

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