跳到主要内容

查询默认免打扰配置

获取指定的超级群,或指定频道设置默认的免打扰逻辑。

提示

该设置一般由管理员配置或修改。设置接口详见设置免打扰

请求方法

POST: https://数据中心域名/ultragroup/notdisturb/get.json

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
groupIdString超级群 ID
busChannelString频道 ID,不传时为群的默认免打扰设置

请求示例

POST /ultragroup/notdisturb/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP: 1480479442
SIGNATURE: 9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=abcdefg

返回结果

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

返回值返回类型说明
codeNumber返回码,200 为正常。
groupIdString超级群 ID
busChannelString频道 ID,不传时为群的默认免打扰设置
unpushLevelInt
  • -1:全部消息通知
  • 0:未设置(用户未设置时为此状态,为全部消息都通知,在此状态下,如设置了超级群默认状态以超级群的默认设置为准)
  • 1:仅针对 @ 消息进行通知,包括 @指定用户 和 @所有人
  • 2:仅针对 @ 指定用户消息进行通知,且仅通知被 @ 的指定的用户进行通知。

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

  • 4:仅针对 @群全员进行通知,只接收 @所有人 的推送信息
  • 5:不接收通知,即使为 @ 消息也不推送通知。

返回结果示例

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

{
"code": 200,
"groupId": "abcdefg",
"busChannel": "",
"unpushLevel": 2
}