黑名单/静音管理
更新时间: 2024/03/15 14:31:50
网易云信 IM 服务端支持设置/取消黑名单和静音功能。
设置黑名单/静音
功能描述
网易云信 IM 服务端支持拉黑/取消拉黑用户,以及设置/取消静音功能。
每个账号的黑名单和静音上限都为 3000。
API 使用限制
单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。
URL
POST https://api.netease.im/nimserver/user/setSpecialRelation.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数名称 | 类型 | 字符串长度上限 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|---|
accid | String | 32 | 必填 | zhangsan | 用户账号accid |
targetAcc | String | 32 | 必填 | lisi | 被拉黑或被静音的账号accid |
relationType | int | / | 必填 | 1 | 本次操作的类型 1 黑名单操作(拉黑);2 设置静音操作 |
value | int | / | 必填 | 0 |
操作值 0 取消拉黑或静音;1 加入黑名单或静音 |
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | int | 200 | 状态码 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&targetAcc=lisi&relationType=1&value=0' 'https://api.netease.im/nimserver/user/setSpecialRelation.action'
返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200
}
查看指定用户的黑名单和静音列表
API 使用限制
单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。
URL
POST https://api.netease.im/nimserver/user/listBlackAndMuteList.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考接口概述。
- POST 请求中 Body 的设置如下:
参数名称 | 类型 | 字符串长度上限 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|---|
accid | String | 32 | 必填 | zhangsan | 用户账号accid |
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
mutelist | String | ["abc","cde"] | 被静音的账号列表 |
blacklist | String | ["abc","cde"] | 被拉黑的账号列表 |
code | int | 200 | 状态码 |
示例
请求示例(curl)
curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tgg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***5583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/user/listBlackAndMuteList.action'
返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"mutelist": [ //被静音的账号列表
"abc",
"cde"
],
"blacklist": [ //加黑的账号列表
"abc"
],
"code": 200
}
状态码
上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码。
此文档是否对你有帮助?