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

文档中心

立即注册

导航

企业直播

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

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

调用 CreateActivityCoupons 接口，在指定直播间内新增卡券互动工具。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
使用限制：单次接口调用新增卡券互动工具数量上限为 10。直播间内卡券互动工具数量上限为 200。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityCoupons	Array of ActivityCoupons	是	`-`	卡券互动工具信息列表。
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` 时，该参数必选。
IsWatchLiveLimit	Integer	否	`0`	是否开启观看直播参与条件。默认值为 `0`。取值如下： `0`：不开启。在卡券被发送至观看页后，观众可直接领取卡券，而无需先观看直播。 `1`：开启。在卡券被发送至观看页后，观众必须先观看直播，才能领取卡券。
IsViewerLevelLimit	Integer	否	`0`	是否开启观众等级参与条件。默认值为 `0`。取值如下： `0`：不开启。卡券的领取不受观众等级限制。 `1`：开启。在卡券被发送至观看页后，满足观众等级条件的用户才能看见并领取卡券。
ViewerLevelConfigIds	Array of Long	否	`[10088,10089]`	开启观众等级参与条件后，观众需满足的观众等级的 ID 列表。传入观众等级 ID 之前，请确保当前直播间已绑定观众等级库，且传入的观众等级 ID 属于该等级库。建议先调用 GetActivityBasicConfigAPI 接口，获取当前直播间绑定的等级库 ID （`BindAccountLevelGroupId`）；再调用 GetViewerLevelConfig 接口，获取等级库中的等级 ID（`LevelId`）。说明当 `IsViewerLevelLimit` 取值为 `1` 时，该参数必选。

返回参数

参数	类型	示例值	描述
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,
            "Count": 1000,
            "Rule": 2,
            "CutOffTime": 1725850100,
            "Duration": 12,
            "AllowCloseIcon": true,
            "IsWatchLiveLimit": 0,
            "IsViewerLevelLimit": 1,
            "ViewerLevelConfigIds": [
                10088,
                10089
            ]
        }
    ],
    "ActivityId": 1815****16514
}

返回示例

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

错误码

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

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