直播间内更新卡券互动工具信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

直播间内更新卡券互动工具信息

最近更新时间：2024.11.15 11:15:19首次发布时间：2024.11.15 11:15:19

您可通过此接口，在指定直播间内更新卡券互动工具的信息，包括发放的卡券个数、卡券的领取时间限制等。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`181****6156`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
Id	Long	是	`185****6513`	卡券互动工具 ID。您可通过调用 ListActivityCoupons 接口获取 ID。说明仅未发送状态的卡券互动工具支持更新，即 ListActivityCoupons 接口中返回参数 `Status` 的取值为 `0` 时。
CouponId	Long	否	`181****4511`	卡券 ID。您可通过调用 ListCoupons 接口获取 ID。
AllowCloseIcon	Boolean	否	`true`	观看页的卡券图标是否支持关闭。取值如下： `true`：支持 `false`：不支持
Count	Long	否	`100`	发放的卡券个数。取值范围为 -1 和 [1,1000000]。取值为 `-1` 表示无限制。
Rule	Integer	否	`2`	卡券的领取时间限制。取值如下： `0`：无时间限制。卡券互动工具被发送至观看页后，观众可随时领取卡券 `1`：卡券在手动停止发放前，均支持领取 `2`：卡券互动工具被发送至观看页后的指定分钟数内，均支持领取卡券 `3`：卡券在截止时间前，均支持领取
Duration	Integer	否	`12`	发送时长。取值范围为 [1,300]。单位为分钟。说明该参数仅在 `Rule` 取值为 `2` 时生效。
CutOffTime	Long	否	`1725850100`	截止领取时间，需晚于当前时间。Unix 时间戳，单位为秒。说明该参数仅在 `Rule` 取值为 `3` 时生效。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否成功更新卡券互动工具的信息。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityCoupon&Version=2023-08-01
{
    "ActivityId": 181****6156,
    "Id": 185****6513,
    "AllowCloseIcon": true
}

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.ActivityCouponInvalid	Operation is denied because the activity coupon has been sent.	已发送的卡券互动工具不支持更新。请更新其他卡券互动工具。