You need to enable JavaScript to run this app.
导航
获取自定义表情专辑详情
最近更新时间:2024.03.14 12:17:06首次发布时间:2024.03.14 12:17:06

通过本接口,获取指定直播间的指定自定义表情专辑的详细配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetActivityCustomEmojiSetDetail接口名称。当前 API 的名称为 GetActivityCustomEmojiSetDetail
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01
ActivityIdInteger17722856256759直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
EmojiSetIdInteger17275286自定义表情专辑 ID。您可以通过 ListActivityCustomEmojiSets 接口查询 ID。

返回参数

参数类型示例值描述
EmojiSetObject of EmojiSet-自定义表情专辑的详细配置信息。

EmojiSet

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

EmojiSetStatus

Integer

1

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

  • 1:开启
  • 2:关闭

EmojiSetType

Integer

1

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

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

IsSystemEmojiSet

Integer

2

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

  • 1:是
  • 2:否
EmojiSetIconStringhttps://www.example.com/a.png表情专辑聊天页图标的链接,包含协议头。聊天页图标是指展示在聊天互动菜单表情列表的图标。
EmojisArray of Emojis-表情专辑中表情图片的配置信息列表。

Emojis

参数类型示例值描述
EmojiIdLong16256表情图片 ID。
EmojiNameString大笑表情图片的含义词。
EmojiImageStringhttps://www.example.com/b.png表情图片的链接,包含协议头。

EmojiType

Integer

1

表情图片的尺寸类型。支持以下取值:

  • 1:60*60
  • 2:240*240
EmojiLocationInteger1表情图片在表情专辑中的排序号。取值范围为 [1,120],取值越小,在主持人和观众看到的界面中位置越靠前。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityCustomEmojiSetDetail&Version=2023-08-01&ActivityId=17722856256759&EmojiSetId=17275286

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetActivityCustomEmojiSetDetail",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1692941618
    },
    "Result": {
        "EmojiSet": {
            "EmojiSetId": 17275286,
            "EmojiSetName": "卡通",
            "EmojiSetStatus": 1,
            "EmojiSetType": 1,
            "EmojiNum": 1,
            "EmojiSetLocation": 1,
            "IsSystemEmojiSet": 2,
            "EmojiSetIcon": "https://www.example.com/a.png",
            "Emojis": [
                {
                    "EmojiId": 16256,
                    "EmojiName": "大笑",
                    "EmojiImage": "https://www.example.com/b.png",
                    "EmojiType": 1,
                    "EmojiLocation": 1
                }
            ]
        }
    }
}

错误码

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

状态码错误码错误信息说明
403OperationDenied.EmojiSetIdInValidOperation is denied because the emoji set is not found.未找到对应的表情专辑。请修改后重试。