logo
即时通讯
机器人
ZIM Audio
当前页

设置会话消息免打扰

POST

https://zim-api.zego.im/

调用过此接口,可批量设置单聊或群聊会话的消息免打扰状态。设置为免打扰后,ZIM SDK 将不会向用户推送相关会话的消息通知,同时用户的“消息未读总数”也不会增加。

用户默认最多可对 500 个单聊会话设置为免打扰。如需上调,请联系 ZEGO 技术支持,最多可为 1000。

群聊会话的免打扰上限是各用户加入群组的数量上限。

客户端将通过 ZIM SDK 的回调接口,接收会话的消息免打扰状态变化。

iOSAndroidmacOSWindows
conversationChangedonConversationChangedconversationChangedonConversationChanged
Web小程序FlutterReact Native
conversationChangedconversationChangedonConversationChangedconversationChanged
Unity3Duni-app | uni-app xHarmonyOS
OnConversationChangedconversationChangedconversationChanged
说明
参数 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必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    请求设置该 UserID(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)的会话消息免打扰状态。

    ConvType number必填

    可选值: [0, 2]

    会话类型:

    • 0:单聊会话。
    • 2:群聊会话。
    ConvIds string[]必填

    可选值: <= 10

    待设置免打扰状态的会话 ID 列表,长度不超过 10。

    • 单聊会话:会话 ID 为用户 ID。
    • 群聊会话:会话 ID 为群组 ID。

    注意

    此列表中的会话类型需保持一致,否则会导致接口调用失败。

    Enable boolean必填

    是否免打扰:

    • true:开启免打扰。
    • false:取消免打扰。

Responses

OK
Schema
    Code number

    返回码。

    以下仅列出了接口业务逻辑相关的 Code 和 SubCode ,完整返回码请参考 全局返回码

    说明

    当您发起请求修改多个会话的免打扰状态时:

    • 只需成功修改 1 个或以上会话的状态,Code 都会返回 0,表示成功。此时请参考 ErrorList 中的具体信息,了解会话修改状态失败详情。
    • 如果所有会话的状态都修改失败,Code 会返回相关返回码,具体请参考 全局返回码
    Code / SubCode说明处理建议
    660000001业务类通用错误。请重试,或联系 ZEGO 技术支持。
    660000002输入参数错误。请检查输入的参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660500002FromUserId 未注册。请先注册 FromUserId。
    660600001群组不存在。请确认输入的 GroupId 是否正确。
    660600009获取群相关信息失败。请先确认 GroupID 是否正确。如果正确,请联系 ZEGO 技术支持。
    660600024FromUserId 不在目标群组中。请先加入该群组。
    660700015
    • 如果此错误码是 code,表示所有单聊会话的对端用户都未注册。
    • 如果此错误码是 subCode,表示 ConvID 对应的单聊会话对端用户未注册。
    请先注册对端用户。
    660800030用户的免打扰列表超过长度限制,默认 500,可联系技术支持配置,最大可为 1000。请联系 ZEGO 技术支持。
    660800051会话已为免打扰,无法再次设置为免打扰。无需处理。
    660800052会话已被取消免打扰,无法再次取消。无需处理。
    Message string

    请求结果的说明信息。

    RequestId string

    请求 ID。

    ErrorList object[]

    失败列表。

    • Code 为 0:
    • ErrorList 为空,全部会话的免打扰状态修改成功。
    • ErrorList 不为空,表示部分会话的免打扰状态修改失败。请参考 SubCode、SubMessage 处理。
    • Code 不为 0:
    • ErrorList 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorList 不为空,表示全部会话免打扰状态都修改失败。
  • Array[
  • ConvId string

    免打扰状态修改失败的会话 ID。

    • 单聊会话:会话 ID 为用户 ID。
    • 群聊会话:会话 ID 为群组 ID。
    SubCode number

    免打扰状态修改失败的具体错误码,完整返回码请参考 Code 说明或者 全局返回码

    SubMessage string

    免打扰状态修改失败的具体错误描述。

  • ]

Previous

拒绝呼叫邀请

Next

置顶会话

当前页

返回到顶部