设置房间成员封禁状态

更新时间: 2024/03/25 11:00:43

封禁房间内指定成员,使其发布的音视频不被订阅,您可以设置封禁时长。

接口地址信息

  • 请求方法:POST

  • URL:

    网易云信为该功能提供以下两个 API 请求地址,使用 V2 地址需在请求 Body 中指定 cid,使用 V3 地址需在 URL 中指定 cname,您可以根据业务需求调用任一接口。

    • https://logic-dev.netease.im/v2/api/right/change
    • https://logic-dev.netease.im/v3/api/right/change?cname={cname}

URL 中参数说明

参数名称 类型 示例 描述
cname String abc 房间名称。
仅在调用 V3 接口时需要设置。

接口请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制

请求参数

  • 请求中 Header 的设置请参考请求结构描述。

  • 请求中 Body 须为 JSON 格式,参数说明如下:

参数名称 类型 是否必选 示例 描述
cid Number 必选,仅适用于 V2 接口 1345315683331808 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID,仅在调用 V2 接口时需要设置。
uid Number 必选 999911110 被封禁权限的用户 ID。

audioRight

Number

必选

1

音频封禁状态:

  • 1:禁止音频被订阅。
  • 2:允许音频被订阅。
audioDuration Number 可选 86400 设置音频封禁状态时长。单位为秒,取值范围为 0 ~ 2147483647,默认值为 0。
  • 若时长设为 0,则表示一直维持封禁状态,直到被封禁成员重新加入房间后解禁。
  • 当被封禁成员在房间内即可生效;若被封禁成员退出并重新加入房间,只要未超时,则仍旧生效。

videoRight

Number

必选

1

视频封禁状态:

  • 1:禁止视频被订阅。
  • 2:允许视频被订阅。
videoDuration Number 可选 86400 设置视频封禁状态时长。单位为秒,取值范围为 0 ~ 2147483647,默认值为 0。
  • 若时长设为 0,则表示一直维持封禁状态,直到被封禁成员重新加入房间后解禁。
  • 当被封禁成员在房间内即可生效;若被封禁成员退出并重新加入房间,只要未超时,则仍旧生效。

返回参数

参数名称 类型 示例 描述
code Number 200 业务错误码,200 表示请求成功。
errmsg String - 错误信息。
requestId String f8f274c1-0e9f-4583-a243-c61c06a19475 请求 ID。若请求出现问题,可以提供此 ID 给技术支持进行排查。

示例

请求示例


{
    "cid": 1345315683331808,
    "uid": 999911110,
    "audioDuration": 86400,
    "audioRight": 0
}

返回示例

{
    "code":200"errmsg":""
}

错误码

错误码 说明
200 API 调用成功。
400 请求无效,比如房间已关闭。
401 接口鉴权失败。请检查请求 header 中的 CheckSum 字段是否正确。
404 cid 对应的房间不存在,请检查 cid 正确性。
429 请求个数超过频控限制。
500 调用失败,可能是以下原因:
  • 设置封禁状态的 uid 不在房间中。
  • 参数设置错误。
此文档是否对你有帮助?
有帮助
去反馈
  • 接口地址信息
  • 接口请求频率
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 返回示例
  • 错误码