发送消息 SendMessage--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

发送消息 SendMessage

最近更新时间：2024.04.17 17:37:38首次发布时间：2023.04.24 11:11:46

你可以使用此接口指定用户在某个会话中进行消息发送。

使用说明

接口行为

你可以调用SendMessage接口，指定你所属的AppId和，发送者 UserId、会话 ID、消息类型和消息内容，进行消息发送。
用户需要在会话中才允许消息发送，且不会触发第三方回调。
发送消息前不会检查发送方是否禁言，也不会检查会话是否开启禁言。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 50。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=SendMessage&Version=2020-12-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
Sender	Long	是	`000010`	消息发送人 UserId
ConversationShortId	Long	是	`000001`	会话 ID
MsgType	Integer	是	`10001`	消息类型
Content	String	是	`Your_Content`	消息内容。当你给客户端发消息时，`Content` 内容需符合客户端格式，详细信息请参看消息格式。
MentionedUsers	Array of Long	否	`[111111,222222]`	会话中@的人
RefMsgInfo	Object of RefMsgInfo	否	`-`	引用消息。该接口中，该字段只需传入 `ReferencedMessageId` 和 `Hint` 参数
VisibleUsers	Array of Long	否	`[111111]`	消息可见会话成员列表
InvisibleUsers	Array of Long	否	`[111111]`	消息不可见会话成员列表。`VisibleUsers` 和 `InvisibleUsers`均为空时，代表对所有人可见。
Ext	JSON Map	否	`{"key":"value"}`	消息的扩展字段，key 的数据类型为 String，value 的数据类型为 String。
ClientMsgId	String	否	`"unique-key"`	幂等id，如果创建时指定了此字段，并且数据库中存在此 id 对应的消息，不会重复发送。如果不指定，会随机生成一个。
CreateTime	Long	否	`1666613688658`	消息对应时间戳，单位为毫秒。
Priority	Integer	否	`1`	消息优先级。 `0`：低优先级。 `1`：普通优先级。 `2`：高优先级。该字段仅对直播群有效。为避免直播群中消息频率太多导致服务端压力过大，你可以设置消息的优先级。当前直播群下，普通优先级和低优先级消息共用频控阈值为 30 条/秒，超过部分会被服务端直接丢弃。高优消息频控阈值为 10 条/秒，超过部分服务端无法保证不丢失。

RefMsgInfo

参数	类型	是否必选	示例值	描述
ReferencedMessageId	Long	否	`7171391232210504000`	被引用的消息 ID
Hint	String	否	`[图片]`	消息引用时展示的文本内容
ReferencedMessageType	Integer	否	`10001`	被引用的消息类型 `10001`：文本。 `10003`：图片。 `10004`：视频 `10005`：文件 `10006`：音频 `10012`：自定义消息
Status	Integer	否	`0`	被引用的消息状态 `0`：消息可见 `1`：消息已过期 `2`：消息（对用户）不可见 `3`：消息被撤回 `4`：消息本身可见，后因删除不可见

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
MessageId	Long	`10003`	消息Id

请求示例

POST https://rtc.volcengineapi.com?Action=SendMessage&Version=2020-12-01
{
    "AppId":000000, 
    "Sender":000010,
    "ConversationShortId":000001,
    "MsgType":10001, 
    "Content":"Your_Content",
    "MentionedUsers":[111111,222222],
    "RefMsgInfo": {
		    "ReferencedMessageId": 000013,
        "Hint": "[图片]"
		}
}

返回示例

{
    "ResponseMetadata": {
	      "RequestId": "Your_RequestId",    
        "Action": "SendMessage",
        "Version": "2020-12-01",
        "Service": "rtc",        
        "Region": "cn-north-1"
    },
    "Result": {
        "MessageId": 123
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。