设置会话消息免打扰
POST
https://zim-api.zego.im/
调用过此接口,可批量设置单聊或群聊会话的消息免打扰状态。设置为免打扰后,ZIM SDK 将不会向用户推送相关会话的消息通知,同时用户的“消息未读总数”也不会增加。
用户默认最多可对 500 个单聊会话设置为免打扰。如需上调,请联系 ZEGO 技术支持,最多可为 1000。
群聊会话的免打扰上限是各用户加入群组的数量上限。
客户端将通过 ZIM SDK 的回调接口,接收会话的消息免打扰状态变化。
| iOS | Android | macOS | Windows |
|---|---|---|---|
| conversationChanged | onConversationChanged | conversationChanged | onConversationChanged |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| conversationChanged | conversationChanged | onConversationChanged | conversationChanged |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnConversationChanged | conversationChanged | conversationChanged |
说明
参数 FromUserId 仅支持数字,英文字符和 {'!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'}。
说明
调用频率限制:20 次/秒。
Request
Query Parameters
Action string必填
可选值: [SilenceConvNotification]
接口原型参数
https://zim-api.zego.im/?Action=SilenceConvNotification
AppId uint32必填
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
- application/json
Responses
- 200
OK
- application/json

