You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/系统消息/更新直播间系统消息设置
更新直播间系统消息设置
最近更新时间：2025.01.10 10:53:37首次发布时间：2025.01.10 10:53:37
我的收藏

调用 UpdateActivityMessageConfig 接口更新指定直播间的系统消息配置，包括是否开启或关闭抽奖通知、送礼消息、进场消息等。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong是1770****81234直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

IsLotteryMessageEnable

Integer

否

1

是否开启抽奖通知。取值如下：

  • 1：开启
  • 2：关闭

IsRedPacketMessageEnable

Integer

否

1

是否开启红包通知。取值如下：

  • 1：开启
  • 2：关闭

IsDynamicEmojiMessageEnable

Integer

否

1

是否开启动态表情包消息。取值如下：

  • 1：开启
  • 2：关闭

IsGiftMessageEnable

Integer

否

1

是否开启送礼消息。取值如下：

  • 1：开启
  • 2：关闭

IsEntryMessageEnable

Integer

否

1

是否开启进场消息。取值如下：

  • 1：开启
  • 2：关闭

IsCustomMessageEnable

Integer

否

2

是否开启自定义消息。取值如下：

  • 1：开启
  • 2：关闭

说明

您可调用 SendCustomSystemMessageAPI 接口，发送自定义消息。

返回参数

参数类型示例值描述

IsLotteryMessageEnable

Integer

1

是否开启抽奖通知。取值如下：

  • 1：开启
  • 2：关闭

IsRedPacketMessageEnable

Integer

1

是否开启红包通知。取值如下：

  • 1：开启
  • 2：关闭

IsDynamicEmojiMessageEnable

Integer

1

是否开启动态表情包消息。取值如下：

  • 1：开启
  • 2：关闭

IsGiftMessageEnable

Integer

1

是否开启送礼消息。取值如下：

  • 1：开启
  • 2：关闭

IsEntryMessageEnable

Integer

1

是否开启进场消息。取值如下：

  • 1：开启
  • 2：关闭

IsCustomMessageEnable

Integer

2

是否开启自定义消息。取值如下：

  • 1：开启
  • 2：关闭

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityMessageConfig&Version=2023-08-01
{
    "ActivityId": 1770****81234,
    "IsEntryMessageEnable": 1,
    "IsGiftMessageEnable": 1,
    "IsLotteryMessageEnable": 1,
    "IsRedPacketMessageEnable": 1,
    "IsCustomMessageEnable": 2,
    "IsDynamicEmojiMessageEnable": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityMessageConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "IsEntryMessageEnable": 1,
        "IsGiftMessageEnable": 1,
        "IsLotteryMessageEnable": 1,
        "IsRedPacketMessageEnable": 1,
        "IsDynamicEmojiMessageEnable": 1,
        "IsCustomMessageEnable": 2
    }
}

错误码

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