You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/菜单栏控制/Version：2023-08-01/更新聊天互动菜单基础配置信息
更新聊天互动菜单基础配置信息
最近更新时间：2025.01.03 14:47:35首次发布时间：2024.03.14 12:17:06
我的收藏

调用 UpdateActivityCommentConfig 接口，更新指定直播间聊天互动菜单的基础配置信息，例如是否开启热门评论、弹幕、欢迎语等功能。

说明

启用聊天互动菜单后，基础配置信息才会在观看页生效。您可通过调用 ModifyActivityMenus 接口，启用聊天互动菜单。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong是17869****56640直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
CommentConfigObject of CommentConfig是-聊天互动菜单的基础配置信息。

CommentConfig

参数类型是否必选示例值描述
MenuNameString否聊天互动聊天互动菜单的名称。长度为 1 到 20 个字符。

IsHotListEnable

Integer

否

0

是否开启热门评论功能。取值如下：

  • 0：关闭
  • 1：开启

HotListName

String

否

热门评论

热门评论列表的名称。长度为 1 到 100 个字符。

说明

该参数仅在 IsHotListEnable 取值为 1 时生效。

IsManualHotListEnable

Integer

否

0

是否开启手动筛选热门评论功能。取值如下：

  • 0：关闭
  • 1：开启

说明

该参数仅在 IsHotListEnable 取值为 1 时生效。

IsLikeNumberShowEnable

Integer

否

0

是否在观看页显示评论点赞图标和热门评论的点赞数。取值如下：

  • 0：不显示
  • 1：显示

说明

该参数仅在 IsHotListEnable 取值为 1 时生效。

HotListCount

Integer

否

10

热门条数，即热门评论列表中最多可以显示多少条热门评论。取值范围为 [10,50]。

说明

该参数仅在 IsHotListEnable 取值为 1 时生效。

VoiceIntervalInteger否3主持人和观众的最短发言间隔。取值范围为 [1,300]。单位为秒。例如将最短发言间隔设置为 3 秒，主持人和观众在自己发送评论后的 3 秒内，无法再次发送评论。
InputBoxPromptString否跟大家聊聊呗~观看页评论输入框内的默认文案。长度为 1 到 100 个字符。
PresenterNameString否主持人主持人昵称。长度为 1 到 100 个字符。

IsBulletScreenEnable

Integer

否

0

是否开启弹幕功能。取值如下：

  • 0：关闭
  • 1：开启

IsCommentTranslateEnable

Integer

否

0

是否开启评论翻译功能。取值如下：

  • 0：关闭
  • 1：开启。仅在开启页面语言时评论翻译功能生效，您可调用 UpdateActivityBasicConfigAPI 接口，开启页面语言

说明

目前仅支持简体中文、英文、日文、韩文之间的相互转换，以及将繁体中文转换成简体中文、英文、日文、韩文。

IsImageCommentEnable

Integer

否

0

是否开启图片评论功能。取值如下：

  • 0：关闭
  • 1：开启

IsWelcomeMessageEnable

Integer

否

1

是否开启欢迎语功能。取值如下：

  • 0：关闭
  • 1：开启。开启后，观众进入直播间时系统会自动发送聊天欢迎语
WelcomeMessageTitleString否系统提示欢迎语的标题。长度为 1 到 15 个字符。
WelcomeMessageContentString否欢迎来到直播间欢迎语的内容。长度为 1 到 150 个字符。

IsAutoSilenceAllEnable

Integer

否

0

是否开启仅直播时允许聊天功能。取值如下：

  • 0：关闭
  • 1：开启。开启后，观众无法在直播开始前和结束后发送评论

IsSendCommentEnable

Integer

否

1

是否开启全体禁言功能。取值如下：

  • 0：开启
  • 1：关闭

IsViewerDeleteCommentsEnable

Integer

否

1

是否开启允许观众删除评论功能。取值如下：

  • 0：关闭
  • 1：开启。开启后，观众可以将自己发送的文字评论、图片评论和表情从观看页的聊天互动评论区删除

IsViewInPurchaseEnable

Integer

否

1

是否开启查看商品消息。取值如下：

  • 0：关闭
  • 1：开启。开启后，每当有观众点击商品卡片，跳转至商品详情页时，观看页会展示查看商品信息。为确保观看页能够展示查看商品消息，必须同时满足以下条件：

说明

如果同时触发了查看商品消息和下单购买消息，则优先展示下单购买消息。

IsViewOrderEnable

Integer

否

1

是否开启下单购买消息。取值如下：

说明

如果同时触发了查看商品消息和下单购买消息，则优先展示下单购买消息。

返回参数

参数类型示例值描述

Status

Boolean

true

基础配置信息是否更新成功。取值如下：

  • true：成功
  • false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityCommentConfig&Version=2023-08-01
{
    "ActivityId": 17869****56640,
    "CommentConfig": {
        "IsHotListEnable": 0,
        "HotListName": "热门评论",
        "HotListCount": 10,
        "VoiceInterval": 3,
        "InputBoxPrompt": "跟大家聊聊呗~",
        "PresenterName": "主持人",
        "IsBulletScreenEnable": 0,
        "IsCommentTranslateEnable": 0,
        "IsManualHotListEnable": 0,
        "IsLikeNumberShowEnable": 0,
        "IsWelcomeMessageEnable": 1,
        "WelcomeMessageTitle": "系统提示",
        "WelcomeMessageContent": "欢迎来到直播间",
        "IsAutoSilenceAllEnable": 0,
        "IsImageCommentEnable": 0,
        "MenuName": "聊天互动",
        "IsViewerDeleteCommentsEnable": 1,
        "IsSendCommentEnable": 1,
        "IsViewInPurchaseEnable": 1,
        "IsViewOrderEnable": 1
    }
}

返回示例

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

错误码

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