PresenterChatAPIV2 - 主持人发言--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

PresenterChatAPIV2 - 主持人发言

最近更新时间：2025.03.24 17:08:25首次发布时间：2024.02.20 11:25:57

调用 PresenterChatAPIV2 接口，以主持人的身份在指定直播间发送文字评论。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=PresenterChatAPIV2&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PresenterChatAPIV2`	接口名称。当前 API 的名称为 `PresenterChatAPIV2`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`173****312`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Comment	String	是	`大家好`	主持人待发送的评论内容。
AudienceGroupId	Long	否	`-2`	直播分组 ID。默认值为 `-2`，即在所有直播分组中发送该条评论。您可通过调用 GetAudienceGroupConfig 接口获取 ID。说明该参数仅在开启直播分组功能后生效。更多有关直播分组的内容，详见直播分组。
TopStatus	Integer	否	`0`	是否置顶该条评论。默认值为 `0`。取值如下： `0`：不置顶 `1`：置顶

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	评论是否发送成功。取值如下： `true`：发送成功 `false`：发送失败

Status

Boolean

true

评论是否发送成功。取值如下：

true：发送成功
false：发送失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=PresenterChatAPIV2&Version=2020-06-01
{
    "ActivityId": 173****312,
    "Comment": "大家好",
    "AudienceGroupId": -2,
    "TopStatus": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "PresenterChatAPIV2",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    },
    "Result": {
        "Status": true
    }
}

错误码

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