You need to enable JavaScript to run this app.
导航

发送消息 SendMessage

最近更新时间2023.11.27 20:36:34

首次发布时间2023.04.24 11:11:46

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

接口行为

你可以调用SendMessage接口,指定你所属的AppId和,发送者 UserId、会话 ID、消息类型和消息内容,进行消息发送。

用户需要在会话中才允许消息发送,且不会触发第三方回调。

发送消息前不会检查发送方是否禁言,也不会检查会话是否开启禁言。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringSendMessage接口名称,本接口取值:SendMessage
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
SenderInt000010消息发送人 UserId
ConversationShortIdInt000001会话 ID
MsgTypeInt10001消息类型
ContentStringYour_Content消息内容。当你给客户端发消息时,Content 内容需符合客户端格式,详细信息请参看消息格式
MentionedUsersArray of Int[111111,222222]会话中@的人
VisibleUsersArray of Int[111111]消息可见会话成员列表
InvisibleUsersArray of Int[111111]消息不可见会话成员列表。VisibleUsersInvisibleUsers均为空时,代表对所有人可见。
Extmap-key(string)-value(string){"key":"value"}消息的扩展字段
ClientMsgIdstring"unique-key"幂等id,如果创建时指定了此字段,并且数据库中存在此 id 对应的消息,不会重复发送。如果不指定,会随机生成一个。
RefMsgInfoRefMsgInfo/引用消息。该接口中,该字段只需传入 ReferencedMessageIdHint 参数
CreateTimeInt1666613688658消息对应时间戳,单位为毫秒。
PriorityInt1消息优先级。
  • 0:低优先级。
  • 1:普通优先级。
  • 2:高优先级。
该字段仅对直播群有效。关于消息优先级的详细说明,参看注释1

注释 1:
为避免直播群中消息频率太多导致服务端压力过大,你可以设置消息的优先级。当前直播群下,普通优先级和低优先级消息共用频控阈值为 30 条/秒,超过部分会被服务端直接丢弃。高优消息频控阈值为 10 条/秒,超过部分服务端无法保证不丢失。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=SendMessage&Version=2020-12-01

Body

{
    "AppId":000000, 
    "Sender":000010,
    "ConversationShortId":000001,
    "MsgType":10001, 
    "Content":"Your_Content",
    "MentionedUsers":[111111,222222],
    "RefMsgInfo": {
		    "ReferencedMessageId": 000013,
        "Hint": "[图片]"
		}
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

参数名类型描述
MessageIdInt10003

正常返回示例

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