调用SendComment发送弹幕消息,该弹幕消息会推送给房间内所有在线人员。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用加粗字体表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imp:SendComment | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。 | 7m***q |
RoomId | string | 是 | 房间的唯一标识,在调用CreateRoom时返回。 | AE35****T95F |
SenderId | string | 是 | 弹幕消息发送者的用户ID,最大长度不超过32个字节。 | 62**59 |
SenderNick | string | 否 | 弹幕消息的发送者昵称,最大长度不得超过128个字节。如果为空,则采用弹幕消息发送者的用户ID在进入房间时注册的昵称。如果对应昵称仍然为空,则显示为空。 | Tom |
Content | string | 是 | 弹幕消息的内容。最大的长度不超过256个字节。 | Hello, World |
Extension | object | 否 | 扩展字段,key-value形式,服务端会把拓展字段信息一并推送到客户端。 | |
string | 否 | value |
返回参数
示例
请求示例
http(s)://[Endpoint]/?Action=SendComment
&AppId=7m***q
&RoomId=AE35****T95F
&SenderId=62**59
&SenderNick=Tom
&Content=Hello, World
&Extension={"key":"value"}
&公共请求参数
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
"Result": {
"CommentVO": {
"CommentId": "09***f8",
"SenderId": "62**59",
"SenderNick": "Tom",
"CreateAt": 1628438400000,
"Content": "Hello,World",
"Extension": {
"key": "value"
}
}
}
}
XML
格式
<SendCommentResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
<Result>
<CommentVO>
<CommentId>09***f8</CommentId>
<SenderId>62**59</SenderId>
<SenderNick>Tom</SenderNick>
<CreateAt>1628438400000</CreateAt>
<Content>Hello,World</Content>
<Extension>
<key>value</key>
</Extension>
</CommentVO>
</Result>
</SendCommentResponse>
错误码
Http code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Forbidden.Chat.HasBeenBanned | The user is banned from posting a comment. | 您已被管理员禁言。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2021-08-11 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | |||||||||
|