设置聊天室成员角色

POST/im/v2/room_members/{account_id}

请求参数

Path 参数

account_id

string

必需

需要设置角色的聊天室成员账号 ID。

room_id

integer <long>

聊天室 ID

必需

聊天室 ID。

operator_account_id

string

操作者账号 ID

可选

操作者账号 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

string

自定义成员级别

可选

自定义的成员级别。

extension

string

扩展字段

可选

自定义扩展字段。

notification_enabled

boolean

是否发送通知消息

可选

操作完成后是否发送通知消息。false（默认）：不发送；true：发送。

notification_extension

string

通知扩展字段

可选

通知扩展字段，JSON 格式，长度上限为 2048 位字符。

need_antispam

string

是否需要进行反垃圾审核

可选

是否需要进行反垃圾审核，true，需要；false（默认），不需要。

antispam_business_id

string

安全通业务 ID

可选

安全通业务 ID，可以指定当前成员信息过安全通某个检测策略。JSON 字符串，例如 {"textbid":"","picbid":""}。默认情况下云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前成员信息过安全通的指定检测策略。

{
  "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,
  "antispam_business_id": "",
  "extension": "string",
  "need_antispam": "true"
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

code

integer

必需

msg

string

必需

data

object

必需

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

最后修改时间： 9 个月前