跳到主要内容

设置指定会话免打扰

为指定用户（requestId）设置指定会话（targetId）的免打扰逻辑。支持的会话类型包括：单聊、群聊、超级群、系统会话。设置后 SDK 可实时获取到最新的会话免打扰状态信息。

提示
  • 当前设置为用户级别设置。
  • 超级群业务还提供针对指定超级群、指定群频道全员生效的默认免打扰配置。详见「超级群管理」下的设置群/频道默认免打扰。

请求方法​

POST： https://数据中心域名/conversation/notification/set.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
conversationTypeString是会话类型。支持的会话类型包括：1（二人会话）、3（群组会话）、6（系统会话）、10（超级群会话）。
requestIdString是设置消息免打扰的用户 ID。
targetIdString是目标 ID，根据不同的会话类型（ConversationType），可能是用户 ID、群组 ID、超级群 ID 等。
isMutedInt是消息免打扰设置状态，0 表示关闭，1 表示开启。

该字段已废弃，推荐使用 unpushLevel。isMuted 与 unpushLevel 只需要传一个。如果都传，使用 unpushLevel。
busChannelString否超级群的会话频道 ID。
  • 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。
  • 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。
unpushLevelInt是
  • -1： 全部消息通知
  • 0： 未设置（用户未设置情况下，默认以群 或者 APP级别的默认设置为准，如未设置则全部消息都通知）
  • 1： 仅针对 @ 消息进行通知
  • 2： 仅针对 @ 指定用户进行通知

    如：@张三 则张三可以收到推送，@所有人 时不会收到推送。

  • 4： 仅针对 @ 群全员进行通知，只接收 @所有人 的推送信息。
  • 5： 不接收通知
注意：IMKit 5.2.1 及之前版本不支持 -1、2、4、5，具体表现为 -1、2、4 无法弹出本地通知，5 不生效。推荐 IMKit 用户升级到 5.2.2 及之后版本。

请求示例​

POST /conversation/notification/set.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

conversationType=1&requestId=b5NwvIrW8&targetId=UAhIaLkR0&unpushLevel=0

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}
最后于 更新