直播间内停止发放卡券--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

直播间内停止发放卡券

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

您可通过此接口，在指定直播间内停止发放指定卡券互动工具的卡券。

说明

仅当卡券互动工具的状态为领取中且领取时间限制为手动停止发放时，即 ListActivityCoupons 接口中返回参数 Status 和 Rule 的取值均为 1 时，可调用当前接口停止发放卡券。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Id	Long	是	`1865****5341`	卡券互动工具 ID。您可通过调用 ListActivityCoupons 接口获取 ID。
ActivityId	Long	是	`1865****5340`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否成功停止发放卡券。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=StopActivityCoupon&Version=2023-08-01
{
    "Id": 1865****5341,
    "ActivityId": 1865****5340
}

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.StatusInvalid	Operation is denied because the activity coupon is not being sent.	仅支持停止发放领取中状态的卡券。请停止发放其他卡券。
403	OperationDenied.RuleInvalid	Operation is denied because the activity coupon cannot be manual stopped.	仅支持停止发放领取时间限制为手动停止发放的卡券。请停止发放其他卡券。