获取卡券库卡券列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取卡券库卡券列表

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

您可通过此接口，获取当前账号及其子账号卡券库中的卡券列表，包括卡券 ID、名称、关联卡券 ID 等信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListCoupons`	接口名称。当前 API 的名称为 `ListCoupons`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
Name	String	否	`A`	卡券名称，长度为 1 到 100 个字符。支持模糊搜索，大小写不敏感。例如，该参数取值为 `A`，则返回`卡券 A`、`卡券 abc` 等名称的卡券。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 1。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。取值范围为 [1,500]。

返回参数

参数	类型	示例值	描述
TotalCount	Long	`1`	查询结果总数。
Coupons	Array of Coupons	`-`	卡券库卡券列表。

Coupons

参数	类型	示例值	描述
Id	Long	`1872****32312`	卡券 ID。
Name	String	`手机优惠券`	卡券名称。
Description	String	`满 500 减 50`	卡券描述。
ThirdPartyId	String	`uuid1`	关联卡券 ID，即您自有商城系统中的卡券 ID。通过该 ID，可将当前卡券绑定您商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。
Pic	String	`https://www.example.com/a.png`	卡券图片的 URL，包含协议头。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListCoupons&Version=2023-08-01&PageNumber=1&PageSize=10

返回示例

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

错误码

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