更新自定义表情专辑排序--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新自定义表情专辑排序

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

您可通过此接口更新指定直播间中已添加的自定义表情专辑的排序。

说明

确保传入该直播间已添加的全部自定义表情专辑。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Integer	是	`17722859762847`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
EmojiSetLocations	Array of EmojiSetLocations	是	`-`	自定义表情专辑信息列表。说明确保传入该直播间已添加的全部自定义表情专辑。最多支持配置 10 个自定义表情专辑。

EmojiSetLocations

参数	类型	是否必选	示例值	描述
EmojiSetId	Long	是	`177276259`	自定义表情专辑 ID。您可以通过 ListActivityCustomEmojiSets 接口查询 ID。
EmojiSetLocation	Integer	是	`2`	自定义表情专辑的排序号。该参数取值为从 `1` 开始的连续且不重复的整数，如 `1`、`2`、`3`。取值范围为 [1,10]，取值越小，在主持人和观众看到的界面中位置越靠前。

返回参数

参数类型示例值描述

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

Status

Boolean

true

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

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=ModifyActivityCustomEmojiSets&Version=2023-08-01
{
    "ActivityId": 17722859762847,
    "EmojiSetLocations": [
        {
            "EmojiSetId": 177276258,
            "EmojiSetLocation": 1
        },
        {
            "EmojiSetId": 177276259,
            "EmojiSetLocation": 2
        }
    ]
}

返回示例

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

错误码

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