最近更新时间:2023.03.10 11:30:24
首次发布时间:2023.02.01 14:10:46
获取直播间的投票列表信息。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称 |
Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01 |
ActivityId | Int64 | 是 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID |
PageNo | Int | 否 | 分页查询页码,默认取值为 1 |
PageCount | Int | 否 | 分页查询数量,默认取值为 10 |
参数 | 类型 | 描述 |
---|---|---|
PageNo | Int | 分页查询页码 |
PageCount | Int | 分页查询数量 |
VoteList | Array of VoteList | 直播间投票列表信息 |
参数 | 类型 | 描述 |
---|---|---|
VoteId | String | 投票 ID |
Title | String | 投票标题 |
TotalCount | Int | 参与人数 |
ChoiceType | String | 投票类型
|
Deadline | Int | 投票的截止时间。Unix 时间戳,单位为秒 |
Status | String | 投票的状态
|
ActivityId | Int | 直播间 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 }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |