删除自定义表情专辑--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

删除自定义表情专辑

最近更新时间：2024.07.19 10:43:05首次发布时间：2024.03.14 12:17:06

您可通过此接口删除指定直播间的指定自定义表情专辑。

说明

系统默认表情专辑不支持删除。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1772285976257`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
EmojiSetId	Long	是	`1772976258`	自定义表情专辑 ID。您可以通过 ListActivityCustomEmojiSets 接口查询 ID。说明系统默认表情专辑不支持删除。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否更新成功。支持以下取值： `true`：成功 `false`：失败

Status

Boolean

true

是否更新成功。支持以下取值：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=DeleteActivityCustomEmojiSet&Version=2023-08-01
{
    "ActivityId": 1772285976257,
    "EmojiSetId": 1772976258
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DeleteActivityCustomEmojiSet",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1692940902
    },
    "Result": {
        "Status": true
    }
}

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.EmojiSetIdInValid	Operation is denied because the emoji set is default and cannot be deleted.	系统默认表情专辑不支持删除。