SendLiveMessageUser - 发送消息给指定用户 - 视频直播

发送消息给指定用户，用户身份由ReceiverId标识。

接口说明

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:SendLiveMessageUser	create	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	发送消息的互动消息应用 ID。	demo
ReceiverId	string	是	接收消息的用户 ID，由大小写字母、数字组成，长度不超过 64 字节。说明请确保接收消息的用户的状态为在线！可以通过调用 CheckLiveMessageUsersOnline 来查询该用户状态。	uid2
SenderId	string	是	发送消息的用户 ID，由大小写字母、数字组成，长度不超过 64 字节。	uid1
SenderInfo	string	否	发送消息用户的扩展信息，长度不超过 512 字节。	uid1meta1
Body	string	否	消息体，长度不超过 15KB。	hello, user
MsgType	long	否	消息类型。	2
MsgTid	string	否	消息唯一标识，可作为删除消息的依据。由大小写字母、数字组成，长度不超过 64 字节。	169830****
DataCenter	string	否	数据中心，需要与 CreateLiveMessageApp 中的数据中心一致，当前支持上海（取值为 cn-shanghai)、新加坡（取值为 ap-southeast-1）。	cn-shanghai
HighReliability	boolean	否	设置该条消息是否为高可靠消息。高可靠消息确保接收方已收到该条消息并响应才会返回成功，如果接收方在 3s 内未响应会返回发送失败。 true：表示高可靠消息。 false（默认）：表示非高可靠消息。说明客户端 SDK v1.5.1 及以上版本才支持此参数，发消息给老版本客户端时不等待 ACK 直接返回成功。	false
Storage	boolean	否	设置存储该消息。 true：表示存储该消息。 false（默认），表示不需要存储。	false

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	6CFDE7AB-571A-14EA-B072-989FF753****
MsgTid	string	消息唯一标识，可作为删除消息的依据。由大小写字母、数字组成，长度不超过 64 字节。	169830****

示例

正常返回示例

JSON格式

{
  "RequestId": "6CFDE7AB-571A-14EA-B072-989FF753****",
  "MsgTid": "169830****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试
408	UserNotAck	%s.	发高可靠消息给用户，用户未响应
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。

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

变更历史

变更时间	变更内容概要	操作
2025-01-23	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情