调用 PresenterChatAPIV2 接口,以主持人的身份在指定直播间发送文字评论。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | PresenterChatAPIV2 | 接口名称。当前 API 的名称为 PresenterChatAPIV2。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Comment | String | 是 | 大家好 | 主持人待发送的评论内容。 |
AudienceGroupId | Long | 否 |
| 直播分组 ID。默认值为 说明 该参数仅在开启直播分组功能后生效。更多有关直播分组的内容,详见直播分组。 |
TopStatus | Integer | 否 |
| 是否置顶当前评论。默认值为
说明 使用该参数对当前评论置顶时,置顶区的评论数上限为 1 条。即当置顶区已有评论时,使用该字段置顶评论,将先取消所有已置顶的评论,再置顶当前评论;
|
TopStatusV2 | Integer | 否 |
| (推荐)是否置顶当前评论。默认值为
说明
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| status | Boolean | true | 评论是否发送成功。成功返回 true。 |
POST https://livesaas.volcengineapi.com/?Action=PresenterChatAPIV2&Version=2020-06-01 { "ActivityId": 173****312, "Comment": "大家好", "AudienceGroupId": -2, "TopStatus": 0, "TopStatusV2": 0 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "PresenterChatAPIV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "status": true } }