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

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetActivityCommentConfig接口名称。当前 API 的名称为 GetActivityCommentConfig。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是177****9762直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

参数类型示例值描述
CommentConfigObject of CommentConfig-聊天互动菜单的基础配置信息。

CommentConfig

参数类型示例值描述
MenuNameString聊天互动聊天互动菜单的名称。

IsHotListEnable

Integer

1

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

  • 0：关闭
  • 1：开启

HotListName

String

热门评论

热门评论列表的名称。

说明

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

IsManualHotListEnable

Integer

1

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

  • 0：关闭
  • 1：开启

说明

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

IsLikeNumberShowEnable

Integer

1

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

  • 0：不显示
  • 1：显示

说明

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

HotListCount

Integer

10

热门条数，即热门评论列表中最多可以显示多少条热门评论。

说明

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

VoiceIntervalInteger5主持人和观众的最短发言间隔。单位为秒。
InputBoxPromptString跟大家聊聊呗观看页评论输入框内的默认文案。
PresenterNameString主持人主持人昵称。

IsBulletScreenEnable

Integer

1

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

  • 0：关闭
  • 1：开启

IsCommentTranslateEnable

Integer

1

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

  • 0：关闭
  • 1：开启

说明

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

IsImageCommentEnable

Integer

1

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

  • 0：关闭
  • 1：开启

IsWelcomeMessageEnable

Integer

1

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

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

IsAutoSilenceAllEnable

Integer

1

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

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

IsSendCommentEnable

Integer

1

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

  • 0：开启
  • 1：关闭

IsViewerDeleteCommentsEnable

Integer

1

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

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

IsViewInPurchaseEnable

Integer

1

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

  • 0：关闭
  • 1：开启。开启后，每当有观众点击商品卡片，跳转至商品详情页时，观看页会展示查看商品信息
    更多有关查看商品消息的内容，详见展示查看商品消息和下单购买消息。

说明

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

IsViewOrderEnable

Integer

1

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

说明

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

IsCommentLLMAnalyzeEnable

Integer

1

是否开启聊天 AI 分析功能。取值如下：

  • 0：关闭
  • 1：开启。功能开启且观众在观看页发送聊天内容后，会产生聊天 AI 分析结果。更多有关聊天 AI 分析的内容，详见聊天 AI 分析。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityCommentConfig&Version=2023-08-01&ActivityId=177****9762

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityCommentConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "CommentConfig": {
            "HotListCount": 10,
            "HotListName": "热门评论",
            "InputBoxPrompt": "跟大家聊聊呗",
            "IsAutoSilenceAllEnable": 1,
            "IsBulletScreenEnable": 1,
            "IsCommentTranslateEnable": 1,
            "IsHotListEnable": 1,
            "IsImageCommentEnable": 1,
            "IsLikeNumberShowEnable": 1,
            "IsManualHotListEnable": 1,
            "IsWelcomeMessageEnable": 1,
            "PresenterName": "主持人",
            "VoiceInterval": 5,
            "WelcomeMessageContent": "欢迎来到直播间",
            "WelcomeMessageTitle": "系统提示",
            "MenuName": "聊天互动",
            "IsViewerDeleteCommentsEnable": 1,
            "IsSendCommentEnable": 1,
            "IsCommentLLMAnalyzeEnable": 1,
            "IsViewInPurchaseEnable": 1,
            "IsViewOrderEnable": 1
        }
    }
}

错误码

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