SendComment - 发送弹幕消息

调用SendComment发送弹幕消息,该弹幕消息会推送给房间内所有在线人员。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imp:SendCommentWrite
  • IMP
    acs:imp:*:{#accountId}:*

请求参数

名称类型必填描述示例值
AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
RoomIdstring

房间的唯一标识,在调用CreateRoom时返回。

AE35****T95F
SenderIdstring

弹幕消息发送者的用户ID,最大长度不超过32个字节。

62**59
SenderNickstring

弹幕消息的发送者昵称,最大长度不得超过128个字节。如果为空,则采用弹幕消息发送者的用户ID在进入房间时注册的昵称。如果对应昵称仍然为空,则显示为空。

Tom
Contentstring

弹幕消息的内容。最大的长度不超过256个字节。

Hello, World
Extensionobject

扩展字段,key-value形式,服务端会把拓展字段信息一并推送到客户端。

string

扩展字段key-value键值对中,value的示例值。

value

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

调用发送房间弹幕消息的返回结果。

0io**Fs6Q384
CommentVOobject

返回的弹幕消息数据模型。

0io**Fs6Q384
CommentIdstring

弹幕消息的唯一ID。

09***f8
SenderIdstring

弹幕消息发送者的用户ID。

62**59
SenderNickstring

弹幕消息发送者的昵称。

Tom
CreateAtLong

弹幕消息的创建时间,Unix时间戳,单位:毫秒。

1628438400000
Contentstring

弹幕消息的内容。

Hello,World
Extensionobject

扩展字段,key-value形式,其值等同于请求时传递的Extension参数。

string

扩展字段key-value键值对中,value的示例值。

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错误码错误信息描述
400Forbidden.Chat.HasBeenBannedThe user is banned from posting a comment.您已被管理员禁言。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-08-11OpenAPI 错误码发生变更、 OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:SenderNick
阿里云首页 低代码音视频工厂 相关技术圈