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

通过本接口,可以更新指定直播间的指定自定义表情专辑的启用状态。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong1772285976257直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
EmojiSetIdLong1772285976258自定义表情专辑 ID。您可以通过 ListActivityCustomEmojiSets 接口查询 ID。

EmojiSetStatus

Integer

2

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

  • 1:开启
  • 2:关闭

返回参数

参数类型示例值描述

Status

Boolean

true

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

  • true:成功
  • false:失败

示例

请求示例

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

返回示例

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

错误码

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

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