You need to enable JavaScript to run this app.
导航
更新聊天互动基础配置
最近更新时间:2024.06.19 11:33:30首次发布时间:2024.03.14 12:17:06

您可通过此接口更新指定直播间是否开启热门评论、全体禁言及图片评论等聊天互动菜单的基础配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdInteger17869471456640直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
CommentConfigObject of CommentConfig-聊天互动菜单的基础配置信息。

CommentConfig

参数类型是否必选示例值描述

IsHotListEnable

Integer

0

是否开启热门评论功能。支持以下取值:

  • 0:关闭
  • 1:开启

HotListName

String

热门评论

热门评论列表的名称。最多支持输入 100 个字符。

说明

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

IsManualHotListEnable

Integer

0

是否开启手动筛选热门评论功能。支持以下取值:

  • 0:关闭
  • 1:开启

说明

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

HotListCount

Integer

10

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

说明

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

IsLikeNumberShowEnable

Integer

1

是否在观看页显示评论点赞图标和热门评论的点赞数。支持以下取值:

  • 0:关闭
  • 1:开启

说明

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

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

IsBulletScreenEnable

Integer

0

是否开启弹幕功能。支持以下取值:

  • 0:关闭
  • 1:开启

IsCommentTranslateEnable

Integer

0

是否开启评论翻译功能。支持以下取值:

  • 0:关闭
  • 1:开启
    如需使用该功能,请在企业直播控制台观看页管理 > 基础信息页面,打开页面语言开关并选择相应的语言。例如,直播间的评论大部分是中文,但您希望不懂中文的观众也能看懂评论区,就可以将英文设置为页面语言。对于 PC 端浏览器默认语言是英文的观众以及移动端系统语言是英文的观众而言,评论区的评论会被自动翻译成英文。观众也可以在观看页手动切换页面语言为英文,从而查看英文评论。

说明

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

IsWelcomeMessageEnable

Integer

1

是否开启欢迎语功能,即观众进入直播间时系统自动发送的聊天欢迎语。支持以下取值:

  • 0:关闭
  • 1:开启
WelcomeMessageTitleString系统提示欢迎语的标题。最多支持输入 15 个字符。
WelcomeMessageContentString欢迎来到直播间,请不要发布色情、违法、低俗、侵权等内容信息,绿色健康参与直播。欢迎语的内容。最多支持输入 150 个字符。

IsAutoSilenceAllEnable

Integer

0

是否开启仅直播时允许聊天功能,即禁止观众在直播开始前和结束后发送评论。支持以下取值:

  • 0:关闭
  • 1:开启

IsImageCommentEnable

Integer

0

是否开启图片评论功能。支持以下取值:

  • 0:关闭
  • 1:开启
MenuNameString聊天互动聊天互动菜单的名称。最多支持输入 20 个字符。

IsViewerDeleteCommentsEnable

Integer

1

是否开启允许观众删除评论功能,即允许观众将自己发送的文字评论、图片评论和表情从观看页的聊天互动评论区删除。支持以下取值:

  • 0:关闭
  • 1:开启

IsSendCommentEnable

Integer

1

是否开启全体禁言功能。支持以下取值:

  • 0:开启
  • 1:关闭

返回参数

参数类型示例值描述

Status

Boolean

true

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

  • true:成功
  • false:失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityCommentConfig&Version=2023-08-01
{
    "ActivityId": 17869471456640,
    "CommentConfig": {
        "IsHotListEnable": 0,
        "HotListName": "热门评论",
        "HotListCount": 10,
        "VoiceInterval": 3,
        "InputBoxPrompt": "跟大家聊聊呗~",
        "PresenterName": "主持人",
        "IsBulletScreenEnable": 0,
        "IsCommentTranslateEnable": 0,
        "IsManualHotListEnable": 0,
        "IsLikeNumberShowEnable": 1,
        "IsWelcomeMessageEnable": 1,
        "WelcomeMessageTitle": "系统提示",
        "WelcomeMessageContent": "欢迎来到直播间,请不要发布色情、违法、低俗、侵权等内容信息,绿色健康参与直播。",
        "IsAutoSilenceAllEnable": 0,
        "IsImageCommentEnable": 0,
        "MenuName": "聊天互动",
        "IsViewerDeleteCommentsEnable":1,
        "IsSendCommentEnable":1
    }
}

返回示例

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

错误码

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