跳到主要内容

查询指定会话免打扰

查询指定用户(requestId) 为指定会话(targetId)的设置的免打扰状态。

提示

该设置为用户级别设置。对应的设置接口详见设置指定会话免打扰

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
conversationTypeString会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、6(系统会话)、10(超级群会话)。如需查询超级群指定频道的免打扰设置,请传入频道 ID(busChannel)。
requestIdString设置消息免打扰的用户 ID。
targetIdString目标 ID,根据不同的会话类型(ConversationType),可能是用户 ID、群组 ID。
busChannelString超级群的会话频道 ID。
  • 如果传入频道 ID,则查询该频道的消息免打扰级别。
  • 注意:如果不指定频道 ID,则查询指定超级群会话(targetId)中不属于任何频道的消息的免打扰状态级别。

请求示例

POST /conversation/notification/get.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=2&requestId=b5NwvIrW8&targetId=2MqOJa1Un

返回结果

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

返回值返回类型说明
codeNumber返回码,200 为正常。
isMutedInt消息免打扰设置状态。
  • -1: 全部消息通知
  • 0: 未设置(用户未设置情况下,默认以群 或者 APP级别的默认设置为准,如未设置则全部消息都通知)
  • 1: 仅针对 @ 消息进行通知
  • 2: 仅针对 @ 指定用户进行通知
  • 4: 仅针对 @ 群全员进行通知。
  • 5: 不接收通知

返回结果示例

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

{"code":200,"isMuted":0}