You need to enable JavaScript to run this app.
导航
查询观众奖券奖品的中奖情况
最近更新时间:2023.04.17 17:45:47首次发布时间:2022.09.09 11:00:56

若您配置的直播间累计抽奖奖品中包括奖券奖品类型,您可以使用该接口查询您账号体系下观众奖券奖品的中奖情况。

注意

请求说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64直播间 ID。您可通过 ListActivityAPI 接口查询 ID
ExternalIdString第三方用户 ID

TaskAwardId

String

累计抽奖配置 ID。请从观众点击领取奖品按钮后的跳转链接中获取该参数值,目前暂不对其校验。
例如:控制台配置奖品链接为:https://www.aaa.com ,观众点击领取奖品按钮后的跳转链接为 https://www.aaa.com/?ActivityId=1741076911&TaskAwardId=17409206167&TaskAwardItemId=7863 ,则 TaskAwardId 取值为 17409206167

TaskAwardItemId

String

奖品 ID。请从观众点击领取奖品按钮后的跳转链接中获取该参数值。
例如:控制台配置奖品链接为:https://www.aaa.com ,观众点击领取奖品按钮后的跳转链接为 https://www.aaa.com/?ActivityId=1741076911&TaskAwardId=17409206167&TaskAwardItemId=7863 ,则 TaskAwardItemId 取值为 7863

AwardItemTypeInt奖品类型。取值固定为 4,表示奖券奖品

返回参数

参数类型描述

IsWin

Boolean

是否中奖。

  • true:中奖;
  • false:未中奖。

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetUserTaskAwardResultAPI&Version=2020-06-01&ActivityId=123&ExternalId=458158514&TaskAwardId=1&TaskAwardItemId=2&AwardItemType=4

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022062820372601021***",
        "Action": "GetUserTaskAwardResultAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656419846
    },
    "Result": {
    		"IsWin": true
    }
}

异常返回示例

{
  	"ResponseMetadata":{
        "RequestId":"201806041104200100***",
        "Action":"GetUserTaskAwardResultAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
		}
}

错误码

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