您可通过本接口更新指定直播间的指定自定义表情专辑的启用状态。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateActivityCustomEmojiSetStatus | 接口名称。当前 API 的名称为 UpdateActivityCustomEmojiSetStatus 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 1772285976257 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
EmojiSetId | Long | 是 | 1772285976258 | 自定义表情专辑 ID。您可以通过 ListActivityCustomEmojiSets 接口查询 ID。 |
EmojiSetStatus | Integer | 是 |
| 自定义表情专辑的启用状态。支持以下取值:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | Boolean |
| 是否更新成功。支持以下取值:
|
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 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
403 | OperationDenied.EmojiSetIdInValid | Operation is denied because the emoji set is not found. | 未找到对应的表情专辑。请修改后重试。 |