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

文档中心

立即注册

导航

企业直播

直播间内新增卡券互动工具

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

您可通过此接口在指定直播间内新增卡券互动工具。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityCoupons	Array of ActivityCoupons	是	`-`	卡券互动工具信息列表。单次接口调用新增卡券互动工具数量上限为 10。直播间内卡券互动工具数量上限为 200。
ActivityId	Long	是	`1815****16514`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

ActivityCoupons

参数	类型	是否必选	示例值	描述
CouponId	Long	是	`18156****51458`	卡券 ID。您可通过调用 ListCoupons 接口获取 ID。
AllowCloseIcon	Boolean	否	`true`	观看页的卡券图标是否支持关闭。默认值为 `false`。取值如下： `true`：支持 `false`：不支持
Count	Long	是	`1000`	发放的卡券个数。取值范围为 -1 和 [1,1000000]。取值为 `-1` 表示无限制。
Rule	Integer	否	`2`	卡券的领取时间限制。默认值为 `0`。取值如下： `0`：无时间限制。卡券互动工具被发送至观看页后，观众可随时领取卡券 `1`：卡券在手动停止发放前，均支持领取 `2`：卡券互动工具被发送至观看页后的指定分钟数内，均支持领取卡券 `3`：卡券在截止时间前，均支持领取
Duration	Integer	否	`12`	发送时长。取值范围为 [1,300]。单位为分钟。说明当 `Rule` 取值为 `2` 时，该参数必选。
CutOffTime	Long	否	`1725850100`	截止领取时间，需晚于当前时间。Unix 时间戳，单位为秒。说明当 `Rule` 取值为 `3` 时，该参数必选。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否成功新增所有指定的卡券互动工具。成功返回 `true`。
Ids	Array of Long	`[1734****94334]`	成功新增的卡券互动工具 ID 列表。说明该参数仅在 `Status` 取值为 `true` 时有值。

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateActivityCoupons&Version=2023-08-01
{
    "ActivityCoupons": [
        {
            "CouponId": 18156****51458,
            "AllowCloseIcon": true,
            "Count": 1000,
            "Rule": 2,
            "Duration": 12,
        }
    ],
    "ActivityId": 1815****16514
}

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.ActivityCouponsInvalid	Operation is denied because the length of activity coupon is over limit.	直播间内卡券互动工具数量已达上限 200。可通过调用 DeleteActivityCoupons 接口删除部分卡券互动工具后重试。