You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

添加或更新自定义表情专辑

最近更新时间：2024.03.14 12:21:53

首次发布时间：2024.03.14 12:17:06

我的收藏

通过本接口，可以在指定直播间中添加自定义表情专辑或更新已有自定义表情专辑的配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是CreateOrUpdateActivityCustomEmojiSet接口名称。当前 API 的名称为 CreateOrUpdateActivityCustomEmojiSet。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
ActivityIdInteger是1772285976254直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

EmojiSet

Object of EmojiSet

是

-

自定义表情专辑的配置信息列表。

说明

最多支持配置 10 个自定义表情专辑。

EmojiSet

参数类型是否必选示例值描述

EmojiSetId

Long

否

1772285976257

自定义表情专辑 ID。您可以通过 ListActivityCustomEmojiSets 接口查询 ID。

说明

不传该参数或取值为 0 时，表示新增自定义表情专辑。

EmojiSetName

String

否

卡通

表情专辑名称。最多支持输入 50 个字符。

说明

通过该接口新增自定义表情专辑时，该参数必传。

EmojiSetType

Integer

否

1

表情专辑中表情图片的尺寸类型。支持以下取值：

  • 1：60*60
  • 2：240*240

说明

通过该接口新增自定义表情专辑时，该参数必传。

EmojiSetIcon

String

否

https://www.example.com/b.png

表情专辑聊天页图标的链接，需包含协议头。聊天页图标是指展示在聊天互动菜单表情列表的图标。支持配置大小不超过 100 KB、尺寸为 50*50 的 PNG 格式的图片。

说明

通过该接口新增自定义表情专辑时，该参数必传。

Emojis

Array of Emojis

否

-

表情专辑中表情图片的配置信息列表。

说明

  • 若通过该接口新增自定义表情专辑，则该参数必传且最多支持配置 120 张表情图片。
  • 若通过该接口更新自定义表情专辑，则需传入该专辑的所有表情图片。新传入的表情图片会覆盖原表情图片。您可以调用 GetActivityCustomEmojiSetDetail 接口，通过返回参数 Emojis 获取当前表情专辑中的所有表情图片信息。

Emojis

参数类型是否必选示例值描述

EmojiId

Long

否

1772285976256

表情图片 ID。您可以通过 GetActivityCustomEmojiSetDetail 接口查询 ID。

说明

不传该参数或取值为 0 时，表示新增表情图片。

EmojiName

String

是

大笑

表情图片的含义词。最多支持输入 50 个字符。

说明

  • 不支持配置冒号（:）。
  • 同一专辑中不同表情图片的含义词不能重复。

EmojiImage

String

是

https://www.example.com/a.png

表情图片的链接，需包含协议头。支持配置大小不超过 500 KB 的 JPG、PNG 和 GIF 格式的图片。尺寸大小具体要求如下：

  • 当 EmojiSetType 取值为 1 时，尺寸为 60*60。
  • 当 EmojiSetType 取值为 2 时，尺寸为 240*240。
EmojiLocationInteger是1表情图片在表情专辑中的排序号。该参数取值为从 1 开始的连续且不重复的整数，如 1、2、3。取值范围为 [1,120]，取值越小，在主持人和观众看到的界面中位置越靠前。

返回参数

参数类型示例值描述

Status

Boolean

true

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

  • true：成功
  • false：失败

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateOrUpdateActivityCustomEmojiSet&Version=2023-08-01
{
    "ActivityId": 1772285976254,
    "EmojiSet": {
        "EmojiSetId": 1772285976257,
        "EmojiSetName": "卡通",
        "EmojiSetType": 1,
        "EmojiSetIcon": "https://www.example.com/a.png",
        "Emojis": [
            {
                "EmojiId": 1772285976256,
                "EmojiName": "大笑",
                "EmojiImage": "https://www.example.com/b.png",
                "EmojiLocation": 1
            }
        ]
    }
}

返回示例

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

错误码

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

状态码错误码错误信息说明
403OperationDenied.EmojiSetLimitOperation is denied because the number of emoji set in the activity has reached the limit.表情专辑数量已达到上限，请检查后重试。