本文介绍如何获取房间内被禁言的成员列表。

请求

URI

bashGET https://{endpoint}/neroom/v1/rooms/:room_archive_id/mute_list?chat=:chat&video=:video&audio=:audio&page_number=:page_number&page_size=:page_size

• {endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。
• Content-Type: application/json; charset=utf-8。

Header

请求 Header 的设置请参见 请求结构。

路径参数

参数名称	类型	是否必须	描述
room_archive_id	String	是	房间ID。
chat	Boolean	否	true 表示查询被禁言的用户。
video	Boolean	否	true 表示查询视频被禁的用户。
audio	Boolean	否	true 表示查询音频被禁的用户 。
page_number	Number	否	页码，从1开始，默认1。
page_size	Number	否	每页显示的被禁言成员数量，最大1000，默认50。

请求体示例

curl   https://roomkit-dev.netease.im/neroom/v1/rooms/441301/mute_list?chat=true&audio=true&page_number=1&page_size=50

响应

响应字段

字段名称	类型	示例	描述
code	Integer	0	状态码，0表示成功，具体信息请参见错误码。
msg	String	Operation succeeded.	业务结果描述，Success表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
cost	String	405ms	处理该请求所消耗的时间。
request_id	String	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
+ data	JsonObject	-	被禁言成员信息。
total	Number	100	被禁言成员的总数量。
+ users	Array of objects	-	被禁言成员数组。
user_uuid	String	test01	被禁言成员账号
user_name	String	张三	被禁言成员名字
+ chat	JsonObject	-	聊天室禁言情况
mute	Boolean	true	是否被禁言，true=被禁言
create_time	Number	1684374465150	被禁言时的毫秒时间戳。
expire_time	Number	1684374465150	禁言过期时间的毫秒时间戳。
duration	Number	100	禁言总时长，单位秒 。
operator_user_uuid	String	test01	操作人的userUuid 。
+ video	JsonObject	-	音频禁言情况
mute	Boolean	true	是否被禁言，true=被禁言
create_time	Number	1684374465150	被禁言时的毫秒时间戳。
expire_time	Number	1684374465150	禁言过期时间的毫秒时间戳。
duration	Number	100	禁言总时长，单位秒 。
operator_user_uuid	String	test01	操作人的userUuid 。
+ audio	JsonObject	-	视频禁言情况
mute	Boolean	true	是否被禁言，true=被禁言
create_time	Number	1684374465150	被禁言时的毫秒时间戳。
expire_time	Number	1684374465150	禁言过期时间的毫秒时间戳。
duration	Number	100	禁言总时长，单位秒 。
operator_user_uuid	String	test01	操作人的userUuid 。

响应示例

json{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1684374465150,
    "cost": "405ms",
    "request_id": "local_b3d293d26bf74cc1aaca3d589c9d2366",
    "data":
    {
        "total": 1,
        "users":
        [
            {
                "user_uuid": "test02",
                "user_name": "test02",
                "chat":
                {
                    "mute": true,
                    "create_time": 1699443305535,
                    "duration": 100,
                    "expire_time": 1699443405535,
                    "operator_user_uuid": "test01"
                },
                "video":
                {
                    "mute": true,
                    "create_time": 1699443305686,
                    "duration": 100,
                    "expire_time": 1699443405686,
                    "operator_user_uuid": "test01"
                },
                "audio":
                {
                    "mute": true,
                    "create_time": 1699443305685,
                    "duration": 100,
                    "expire_time": 1699443405685,
                    "operator_user_uuid": "test01"
                }
            }
        ]
    }
}

错误码

错误码	错误信息	说明	处理建议
400	Invalid parameter.	参数错误	检查接口传参
1004	Room not found.	房间不存在或者已经结束。	检查房间ID(room_archive_id)和房间状态。