You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/菜单栏控制/获取自定义表情专辑列表
获取自定义表情专辑列表
最近更新时间：2024.07.19 10:43:05首次发布时间：2024.03.14 12:17:06
我的收藏

您可通过此接口获取指定直播间的自定义表情专辑的 ID、启用状态及表情数量信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListActivityCustomEmojiSets接口名称。当前 API 的名称为 ListActivityCustomEmojiSets。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdInteger是17722976256759直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述
EmojiSetsArray of EmojiSets-自定义表情专辑信息列表。

EmojiSets

参数类型示例值描述
EmojiSetIdLong1772285976257表情专辑 ID。
EmojiSetNameString卡通表情专辑名称。

EmojiSetStatus

Integer

1

表情专辑的启用状态。支持以下取值：

  • 1：开启
  • 2：关闭

EmojiSetType

Integer

1

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

  • 1：60*60
  • 2：240*240
EmojiNumInteger10表情专辑中的表情数量。
EmojiSetLocationInteger1表情专辑的排序号。取值范围为 [1,10]，取值越小，在主持人和观众看到的界面中位置越靠前。

IsSystemEmojiSet

Integer

2

是否为系统默认表情专辑。支持以下取值：

  • 1：是
  • 2：否
EmojiSetIconStringhttps://www.example.com/b.png表情专辑聊天页图标的链接，包含协议头。聊天页图标是指展示在聊天互动菜单表情列表的图标。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListActivityCustomEmojiSets&Version=2023-08-01&ActivityId=17722976256759

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListActivityCustomEmojiSets",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656419846
    },
    "Result": {
        "EmojiSets": [
            {
                "EmojiSetId": 1772285976257,
                "EmojiSetName": "卡通",
                "EmojiSetStatus": 1,
                "EmojiSetType": 1,
                "EmojiNum": 10,
                "EmojiSetLocation": 1,
                "IsSystemEmojiSet": 2,
                "EmojiSetIcon": "https://www.example.com/b.png"
            }
        ]
    }
}

错误码

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