新增或更新奖品库奖品--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

新增或更新奖品库奖品

最近更新时间：2024.10.16 12:10:37首次发布时间：2024.10.16 12:10:37

您可通过此接口在奖品库中新增奖品，或更新已有奖品的名称、库存等信息。

使用说明

接口行为

通过本接口的 Id 参数，您可以新增和更新奖品库中的奖品。

新增奖品：在请求参数中不传 Id（奖品 ID）或传入 Id 且参数取值为 0，则可新增奖品。
更新奖品信息：在请求参数中传入待更新信息的奖品 ID 作为 Id 参数值，即可更新奖品信息。您可通过调用 GetAwardItemList 接口获取 ID。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateAwardItem&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateAwardItem`	接口名称。当前 API 的名称为 `UpdateAwardItem`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
AwardItem	Object of AwardItem	是	`-`	奖品信息。

AwardItem

参数	类型	是否必选	示例值	描述
AwardItemIcon	String	否	`https://www.example.com/test.png`	奖品图片的 URL，需包含协议头。支持配置大小不超过 2 MB 的 JPG 或 PNG 格式的图片。建议图片尺寸为 160*160。
AwardItemType	Integer	否	`1`	奖品类型。取值如下： `1`：实物奖品 `2`：虚拟奖品 `3`：自定义奖品 `4`：奖券奖品说明如需新增奖品，该参数必填。
AwardItemName	String	否	`奖品`	奖品名称，长度为 1 到 20 个字符。说明如需新增奖品，该参数必填。
Id	Long	否	`1715****1256`	奖品 ID。新增奖品：不传该参数或传入该参数且取值为 `0`。奖品库奖品数量上限为 1000。更新奖品信息：传入待更新信息的奖品 ID。您可通过调用 GetAwardItemList 接口获取 ID。
AwardItemStock	Long	否	`200`	奖品库存。取值范围为 [1,100000]。取值 `-1` 表示不限库存。说明如需新增奖品，该参数必填。
AwardLotteryTicketAddr	String	否	`https://example.com`	奖券奖品的领奖链接。长度为 1 到 256 个字符。说明该参数在 `AwardItemType` 取值为 `4` 时必填。
AwardItemNum	String	否	`48151841`	自定义奖品的奖品批次。长度为 1 到 256 个字符。说明该参数在 `AwardItemType` 取值为 `3` 时必填。
DeliveryMethod	Integer	否	`1`	自定义奖品的发放方式。取值如下： `1`：卡券 `2`：积分说明该参数在 `AwardItemType` 取值为 `3` 时必填。
AwardItemAmounts	Long	否	`1`	自定义奖品积分发放方式的中奖金额。取值范围为 [0,99999]。说明该参数在 `AwardItemType` 取值为 `3` 且 `DeliveryMethod` 取值为 `2` 时必填。
WinnerInfoType	Array of Integer	否	`[1,2,3]`	实物或虚拟奖品的中奖人填写信息类型。取值如下： `1`：收货地址 `2`：手机号 `3`：收件人说明该参数在 `AwardItemType` 取值为 `1` 或 `2` 时必填。 `AwardItemType` 取值为 `2` 时，该参数仅支持取值为 `2`。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否成功新增或更新奖品。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateAwardItem&Version=2023-08-01
{
    "AwardItem": {
        "AwardItemIcon": "https://www.example.com/test.png",
        "AwardItemType": 1,
        "AwardItemName": "奖品",
        "AwardItemStock": 200,
        "WinnerInfoType": [1,2,3]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateAwardItem",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1685969459
    },
    "Result": {
        "Status": true
    }
}

错误码

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