跳到主要内容

设置指定会话类型免打扰

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

提示
  • 当前设置为用户级别设置。用户针对“会话类型”设置的免打扰逻辑优先级次于为“指定会话”设置的免打扰逻辑,详见设置指定会话免打扰
  • 超级群业务提供针对指定超级群、指定群频道的默认免打扰逻辑配置。非用户级别配置,优先级较低。详见"超级群管理“下的设置群/频道默认免打扰

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
conversationTypeString会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、6(系统会话)、10(超级群会话)。
requestIdString设置消息免打扰的用户 ID。
unpushLevelInt
  • -1: 全部消息通知
  • 0: 未设置(用户未设置情况下,默认以群或者 APP 级别的默认设置为准,如未设置则全部消息都通知)
  • 1: 仅针对 @ 消息进行通知
  • 2: 仅针对 @ 指定用户进行通知

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

  • 4: 仅针对 @ 群全员进行通知,只接收 @所有人 的推送信息。
  • 5: 不接收通知
注意:IMKit 5.2.1 及之前版本不支持按会话类型设置的免打扰逻辑。推荐 IMKit 用户升级到 5.2.2 及之后版本。

请求示例

POST /conversation/type/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&unpushLevel=2

返回结果

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

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

返回结果示例

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

{"code":200}