API 参考
在线调试

设置聊天室成员角色

更新时间: 2024/07/17 17:57:01

功能描述

聊天室成员可分为固定成员和非固定成员两大角色。

  • 固定成员属于聊天室的常驻成员,无论用户当前是否在线/在聊天室里,都可以作为聊天室成员被获取到,目前固定成员包括:创建者、管理员、普通成员,总计上限 1000 人。
  • 非固定成员包括普通游客、匿名游客以及虚构用户。游客只有在线时才属于聊天室的非固定成员;游客离开聊天室或下线后,将不再出现在聊天室用户列表内。游客进入聊天室又退出后,不属于聊天室的任何成员(和聊天室没有任何关系)。
成员类型 角色描述
创建者 拥有聊天室最高权限,包括设置管理员、拉黑、禁言、踢人、设置普通成员。
管理员 管理员具有拉黑、禁言、踢人、设置普通成员权限。管理员由创建者分配和管理。管理员不能对创建者和其他管理员进行操作。
普通成员 普通成员主要区别于游客,即使离开聊天室(当前不在线),也可以作为聊天室成员被获取到。
普通游客 普通游客是以登录状态进入聊天室内的用户,且未被设置为固定成员。除了创建者,其他成员刚加入聊天室时均默认是游客。
匿名游客 匿名游客在无需登录的情况下即可进入聊天室,相比于普通游客,匿名游客不支持发消息、被禁言、被拉黑、被设置为管理员/普通成员等操作。
虚构用户 虚构用户通常只用于增加聊天室在线人数,不用于正常交流,如需要使用虚构成员,请参考 添加聊天室虚构用户

本接口用于设置聊天室用户的成员角色,也可以设置用户的部分信息,包括昵称、头像、扩展信息等。

  • 只有聊天室创建者可以将成员设置为管理员。
  • 聊天室创建者和管理员可以将用户设置为普通成员或游客。
  • 设置为游客,即表示删除其固定成员的身份。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

POST https://open.yunxinapi.com/im/v2/room_members/:{account_id}

请求 Header 的参数说明请参见 请求 Header

路径参数

参数名称 类型 是否必选 描述
account_id String 必选 需要设置角色的聊天室成员账号 ID。

请求体参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。
operator_account_id String 可选 操作者账号 ID。只有聊天室创建者或管理员才能设置其他用户的角色。
  • 不填,默认为聊天室创建者。
  • 否则以填入 ID 为准,校验是否为创建者或管理员。
  • member_role Integer 必选 需要将成员设置为的角色类型。
  • 0:普通成员。设置为 0 时,对应的 operator_account_id 可以为聊天室创建者或管理员
  • 2:管理员。设置为 2 时,对应的 operator_account_id 必须为聊天室创建者。
  • 3:游客。设置为 2 时,即表示删除该固定成员,使其成为游客角色。设置为 3 时,对应的 operator_account_id 可以为聊天室创建者或管理员。
  • room_nick String 必选 成员在聊天室中的昵称。
    room_avatar String 可选 成员在聊天室中的头像。
    member_level Integer 可选 自定义的成员级别。
    extension String 可选 自定义扩展字段。
    notification_enabled Boolean 可选 操作完成后是否发送通知消息。false(默认):不发送;true:发送。
    notification_extension String 可选 通知扩展字段,JSON 格式,长度上限为 2048 位字符。
    antispam_configuration Object 可选 安全通相关配置项。

    请求体示例

    json{
        "room_id": 1602801663,
        "operator_account_id": "yx1",
        "member_role": 0,
        "room_nick": "ygy test",
        "room_avatar": "http://www.baidu.com",
        "notification_enabled": false,
        "notification_extension": "string",
        "member_level": 0,
        "extension": "string"
    }
    

    响应

    Header

    响应 Header 的参数说明请参见 响应 Header

    响应体参数

    参数名称 类型 描述 是否必返回
    code Integer 状态码,200 表示请求成功。
    msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
    data Object 返回的 JSON 数据对象,请求失败则返回空对象。

    响应体示例

    json{
        "code": 200,
        "msg": "success",
        "data": {}
    }
    

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    416 频率超限 rate limit exceeded
    102404 用户不存在 account not exist
    113410 聊天室服务未开通 chatroom service disabled
    113404 聊天室不存在 chatroom not exist
    113406 聊天室已关闭 chatroom closed
    114432 仅允许聊天室所有者或管理员操作 chatroom owner or manager operation permission required
    114427 仅允许聊天室所有者操作 chatroom owner operation permission required
    114437 聊天室成员数量超限 chatroom member limit
    114404 聊天室成员不存在 chatroom member not exist
    114408 聊天室成员已删除 Member: %s was already deleted
    500 服务端内部错误 internal server error
    503 服务器繁忙 server busy
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 调用频率
    • 请求
    • URL
    • Header
    • 路径参数
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码