GetCoupon - 查询卡券库卡券信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetCoupon - 查询卡券库卡券信息

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

调用 GetCoupon 接口，根据卡券 ID 或关联卡券 ID，查询卡券库中的指定卡券信息。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetCoupon`	接口名称。当前 API 的名称为 `GetCoupon`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
Id	Long	否	`1823****3443`	卡券 ID。您可通过调用 ListCoupons 接口获取 ID。说明 `Id` 或 `ThirdPartyId` 至少需要传一个，且同时传入时，`Id` 的优先级更高。使用子账号调用接口时，确保卡券对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
ThirdPartyId	String	否	`uuid1`	关联卡券 ID，即您自有商城系统中的卡券 ID。说明 `Id` 或 `ThirdPartyId` 至少需要传一个，且同时传入时，`Id` 的优先级更高。

返回参数

参数	类型	示例值	描述
Coupons	Array of Coupons	`-`	查询到的卡券列表。

Coupons

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

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetCoupon&Version=2023-08-01&Id=1823****3443

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetCoupon",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Coupons": [
            {
                "Id": 1823****3443,
                "Name": "手机优惠券",
                "Description": "满 500 减 50",
                "ThirdPartyId": "uuid1",
                "Pic": "https://www.example.com/a.png",
                "IsRepeatPickupEnable": 1
            }
        ]
    }
}

错误码

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