发送单聊消息
https://zim-api.zego.im/
发送 1v1 单聊消息,支持向单个用户、或批量向多个用户发送消息。
目标客户端将通过 ZIM SDK 的回调接口,接收单聊消息的通知。
| iOS | Android | macOS | Windows |
|---|---|---|---|
| peerMessageReceived | onPeerMessageReceived | peerMessageReceived | onPeerMessageReceived |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| peerMessageReceived | peerMessageReceived | onPeerMessageReceived | peerMessageReceived |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnReceivePeerMessage | peerMessageReceived | peerMessageReceived |
FromUserId 和 ToUserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务,或开发者已调用 服务端 API 注册相关的 userID。参数 FromUserId、ToUserId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'。
如果发送方使用的 SDK 版本(版本说明请参考 发布日志)低于 2.0.0,ZIM 服务端对应的仅支持 MessageType 为 2 的 Command 类型消息,不支持其他类型。 为了给开发者带来更好的体验,ZEGO 推荐开发者使用最新版本的 SDK。
如果发送方请求发送 MessageType 为 1 的文本消息,则发送方对应的客户端(SDK 版本需为 2.7.0 或以上)也会收到该消息。
对于发送和接收 MessageType 为 200 的自定义消息,发送方和接收放对应的客户端的 SDK 版本需为 2.8.0 或以上。
如果接收端的 SDK 版本介乎 [2.0.0, 2.8.0) 区间,可以收到自定义消息时,但会显示此消息类型为未知,且无法获取信息内容。如需获取此条消息,请将 SDK 升级为 2.8.0 或以上版本。
如果接收端的 SDK 版本为 1.x.x 版本,则无法收到自定义消息,也不会收到未知消息。
Request
Query Parameters
可选值: [SendPeerMessage]
接口原型参数
https://zim-api.zego.im/?Action=SendPeerMessage
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
- application/json
Responses
- 200
- application/json
