用户全局禁言

更新时间：2022 年 5 月 19 日

随着监管机制日益完善，对 app 的监管不断加强，安全合规逐渐成为 app 的生命线。

为加强 app 管理，环信即时通讯提供全局禁言功能，对 app 提供用户 ID 级别的禁言管理，支持在管理员发现用户违规后进行全局禁言，以维护 app 良好的内容生态环境。禁言到期后，服务器会自动解除禁言，恢复该用户发送消息的权限。

你可以对单个用户 ID 设置单聊、群组或聊天室消息全局禁言。禁言后，该用户将无法在对应的单聊、群组或聊天室发送消息；无论通过调用客户端 API，还是使用服务端 RESTful API 都不行。

该功能可广泛应用于实时互动 app 中，例如发现某用户频繁向多个聊天室发送违规广告，则可以对该用户开启全局聊天室禁言 15 天；发现某用户发表触犯红线的政治言论，则可以全局永久禁言，用户申诉通过后可以解禁。

环信即时通讯 IM REST API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，都必须在请求头部填入如下 Authorization 字段：

Authorization：Bearer ${YourAppToken}

为提高项目的安全性，环信使用 Token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。本文 REST API 仅支持使用 app token，详见使用 app Token 鉴权。

设置单个用户 ID 的单聊、群组、聊天室消息全局禁言。

请求方法：POST

接入点： https://{host}/{orgName}/{appName}/mutes

curl -L -X POST 'https://a1.easemob.com/easemob-demo/testappkey/mutes' \
-H 'Authorization: Bearer {{token}}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "username": "zs1",
    "chat": 100,
    "groupchat": 100,
    "chatroom": 100
}'

{
    "path": "/mutes",
    "uri": "https://a1.easemob.com/easemob-demo/testappkey/mutes",
    "timestamp": 1631609754727,
    "organization": "easemob-demo",
    "application": "357169f0-492a-11e9-9b3a-f1af649cc48d",
    "action": "post",
    "data": {
        "result": "ok"
    },
    "duration": 74,
    "applicationName": "testappkey"
}

查询单个用户的单聊/群聊/聊天室消息禁言。

方法：GET

接入点：https://{host}/{orgName}/{appName}/mutes/username

curl -L -X GET 'https://a1.easemob.com/easemob-demo/testappkey/mutes/zs1' \
-H 'Authorization: Bearer {{token}}' \
-H 'Content-Type: application/json'

{
    "path": "/mutes",
    "uri": "https://a1.easemob.com/easemob-demo/testappkey/mutes",
    "timestamp": 1631609831800,
    "organization": "easemob-demo",
    "application": "357169f0-492a-11e9-9b3a-f1af649cc48d",
    "action": "get",
    "data": {
        "userid": "easemob-demo#restys_zs1",
        "chat": 96,
        "groupchat": 96,
        "chatroom": 96,
        "unixtime": 1631609831
    },
    "duration": 13,
    "applicationName": "testappkey"
}

该方法查询 app 下所有全局禁言的用户及其禁言剩余时间。

方法：GET

接入点： https://{host}/{orgName}/{appName}/mutes

curl -L -X GET 'https://a1.easemob.com/easemob-demo/testappkey/mutes?pageNum=1&pageSize=10' \
-H 'Authorization: Bearer {{token}}' \
-H 'Content-Type: application/json'

{
    "path": "/mutes",
    "uri": "https://a1.easemob.com/easemob-demo/testappkey/mutes",
    "timestamp": 1631609858771,
    "organization": "easemob-demo",
    "application": "357169f0-492a-11e9-9b3a-f1af649cc48d",
    "action": "get",
    "data": {
        "data": [
            {
                "username": "zs2",
                "chatroom": 0
            },
            {
                "username": "zs1",
                "groupchat": 69
            },
            {
                "username": "zs1",
                "chat": 69
            },
            {
                "username": "zs1",
                "chatroom": 69
            },
            {
                "username": "h2",
                "chatroom": 0
            },
            {
                "username": "h2",
                "groupchat": 0
            },
            {
                "username": "h2",
                "chat": 0
            }
        ],
        "unixtime": 1631609858
    },
    "duration": 17,
    "applicationName": "testappkey"
}