ListActivityCoupons - 直播间内获取卡券互动工具列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListActivityCoupons - 直播间内获取卡券互动工具列表

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

调用 ListActivityCoupons 接口，在指定直播间内获取卡券互动工具列表，包括卡券互动工具的 ID、状态、领取的卡券数量等信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListActivityCoupons`	接口名称。当前 API 的名称为 `ListActivityCoupons`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1815****1544`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
IsSent	Boolean	否	`false`	卡券互动工具是否已发送至观看页。默认不根据发送状态进行筛选。取值如下： `true`：已发送 `false`：未发送
IsDeleted	Boolean	否	`false`	是否获取已删除的卡券互动工具。默认值为 `false`。取值如下： `true`：获取 `false`：不获取

返回参数

参数	类型	示例值	描述
ActivityCoupons	Array of ActivityCoupons	`-`	卡券互动工具信息列表。

ActivityCoupons

参数	类型	示例值	描述
AllowCloseIcon	Boolean	`true`	观看页的卡券图标是否支持关闭。取值如下： `true`：支持 `false`：不支持
Count	Long	`10000`	发放的卡券个数。取值为 `-1` 表示无限制。
Rule	Integer	`2`	领取卡券的截止时间。取值如下： `0`：无时间限制。卡券互动工具被发送至观看页后，观众可随时领取卡券 `1`：卡券在手动停止发放前，均支持领取 `2`：卡券互动工具被发送至观看页后的指定分钟数内，均支持领取卡券 `3`：卡券在截止时间前，均支持领取
Duration	Integer	`12`	倒计时。单位为分钟。说明该参数仅在 `Rule` 取值为 `2` 时生效。
CutOffTime	Long	`1725850100`	定时截止时间。Unix 时间戳，单位为秒。说明该参数仅在 `Rule` 取值为 `3` 时生效。
Status	Integer	`1`	卡券互动工具的状态。取值如下： `0`：未发送（初始状态） `1`：领取中 `2`：已结束 `3`：已撤回 `4`：已删除
Id	Long	`1852****53445`	卡券互动工具 ID。
PickupCount	Long	`10`	领取的卡券数量。
PickupPeopleCount	Long	`10`	领取卡券的人数。
SendTime	Long	`1725850925`	卡券互动工具的发送时间。Unix 时间戳，单位为秒。
EndTime	Long	`1725851645`	卡券互动工具的结束时间。Unix 时间戳，单位为秒。结束后，观众无法领取卡券。
Coupon	Object of Coupon	`-`	卡券信息。
IsWatchLiveLimit	Integer	`1`	是否开启观看直播参与条件。取值如下： `0`：不开启。在卡券被发送至观看页后，观众可直接领取卡券，而无需先观看直播。 `1`：开启。在卡券被发送至观看页后，观众必须先观看直播，才能领取卡券。
IsViewerLevelLimit	Integer	`1`	是否开启观众等级参与条件。取值如下： `0`：不开启。卡券的领取不受观众等级限制。 `1`：开启。在卡券被发送至观看页后，满足观众等级条件的用户才能看见并领取卡券。说明当 `IsViewerLevelLimit` 被设为 `1` 后：若卡券发送之前，您在直播间关闭了观众等级功能或更换了观众等级库，或您所绑定的等级被全部删除，那么 `IsViewerLevelLimit` 字段将被置为 `0`。若卡券发送之后，您在直播间关闭了观众等级功能或更换了观众等级库，或您所绑定的等级被全部删除，那么 `IsViewerLevelLimit` 字段将仍为 `1`。
ViewerLevelConfigMetas	Array of ViewerLevelConfigMetas	`[{"ViewerLevelConfigId":123456789,"ViewerLevelConfigName":"VIP 等级"}]`	观众等级条件中的等级配置信息列表。表示仅当观众满足该等级配置时，才能看见并领取卡券。说明当 `IsViewerLevelLimit` 为 `1` 时，该参数生效。

Coupon

参数	类型	示例值	描述
Name	String	`手机优惠券`	卡券名称。
Description	String	`满 500 减 50`	卡券描述。
ThirdPartyId	String	`uuid1`	关联卡券 ID，即您自有商城系统中的卡券 ID。通过该 ID，可将当前卡券绑定您商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。
Pic	String	`https://www.example.com/a.png`	卡券图片的 URL，包含协议头。
Id	Long	`186****561`	卡券 ID。
IsRepeatPickupEnable	Integer	`1`	卡券是否允许重复领取。取值如下： `0`：不允许。观众只能领取一次当前卡券，领取后，在任一直播间点击该卡券，均会提示已领取过该卡券。 `1`：允许。观众可以在任一直播间多次领取当前卡券。

ViewerLevelConfigMetas

参数	类型	示例值	描述
ViewerLevelConfigId	Long	`10088`	观众等级配置 ID。
ViewerLevelConfigName	String	`VIP1`	观众等级配置名称。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListActivityCoupons&Version=2023-08-01&ActivityId=1815****1544

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListActivityCoupons",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ActivityCoupons": [
            {
                "Count": 10000,
                "Rule": 2,
                "Duration": 12,
                "CutOffTime": 1725850100,
                "Status": 1,
                "Id": 1852****53445,
                "PickupCount": 10,
                "Coupon": {
                    "Name": "手机优惠券",
                    "Description": "满 500 减 50",
                    "ThirdPartyId": "uuid1",
                    "Pic": "https://www.example.com/a.png",
                    "Id": 186****561,
                    "IsRepeatPickupEnable": 1
                },
                "AllowCloseIcon": true,
                "SendTime": 1725850925,
                "EndTime": 1725851645,
                "PickupPeopleCount": 10,
                "IsWatchLiveLimit": 1,
                "IsViewerLevelLimit": 1,
                "ViewerLevelConfigMetas": [
                    {
                        "ViewerLevelConfigId": 10086,
                        "ViewerLevelConfigName": "VIP1"
                    }
                ]
            }
        ]
    }
}

错误码

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