接口说明
获取房间角色列表
GET 请求参数
值 | 类型 | 描述 | 是否必须 |
---|---|---|---|
room_id | string | 房间ID | true |
修改角色相关信息
创建角色
{
"color": 15158588,
"icon": "https://imgheybox.max-c.com/dev/avatar/2024/10/14/2597c1318c14b26c45732d6177ffc2b6.jpeg",
"name": "测试管理员",
"type": 0,
"hoist": 1,
"permissions": "1",
"heybox_ids": [],
"room_id": "3690041195409809408",
"department_id": "3690041195409809408",
"nonce": "undefined"
}
字段 | 类型 | 示例值 | 说明 | 是否必须 |
---|---|---|---|---|
name | string | 机器人 | 角色名称。 | true |
icon | string | https://imgheybox.max-c.com/dev/avatar/2023/08/10/be2f127109038a6644c15ab9cf678b9e.png | 角色的图标,这里为空表示没有特定图标。 | false |
color_list | array | [15027858,14985695] | 渐变色的颜色数组,颜色值10进制,在其他未完成的房间无法使用 | false |
room_id | string | 3230476736336502784 | 房间 ID | true |
permissions | string | 34359738369 | 权限值,具体参考 (权限说明) | true |
type | int | 0 | 类型标识,用于区分不同类型的角色具体参考(角色类型常量表),机器人创建的角色建议默认为0 | true |
color | int | 0 | 颜色值10进制,在界面展示中用于区分不同角色。,不填则为默认颜色(跟随主题) | false |
hoist | int | 1 | 是否将该角色成员在右侧和普通成员区分显示,1是区分0是不区分 | true |
nonce | string | 123456 | 随机字符串,防止重复创建 | true |
更新角色
[更新角色](/apidoc/shared/43256fe4-9a8c-4f22-949a-74a3f8b431f5/api-220893910
{
"color": 15158588,
"icon": "https://imgheybox.max-c.com/dev/avatar/2024/10/14/2597c1318c14b26c45732d6177ffc2b6.jpeg",
"name": "测试管理员",
"type": 0,
"hoist": 1,
"permissions": "1",
"heybox_ids": [],
"room_id": "3690041195409809408",
"department_id": "3690041195409809408",
"nonce": "undefined",
"id": "3690041195495620610"
}
字段 | 类型 | 示例值 | 说明 | 是否必须 |
---|---|---|---|---|
id | string | 3690041195495620610 | 角色id | true |
name | string | 机器人 | 角色名称。 | true |
icon | string | https://imgheybox.max-c.com/dev/avatar/2023/08/10/be2f127109038a6644c15ab9cf678b9e.png | 角色的图标,这里为空表示没有特定图标。 | false |
color_list | array | [15027858,14985695] | 渐变色的颜色数组,颜色值10进制,在其他未完成的房间无法使用 | false |
room_id | string | 3230476736336502784 | 房间 ID | true |
permissions | string | 34359738369 | 权限值,具体参考 (权限说明) | true |
type | int | 0 | 类型标识,用于区分不同类型的角色具体参考(角色类型常量表),机器人创建的角色建议默认为0 | true |
color | int | 0 | 颜色值10进制,在界面展示中用于区分不同角色。,不填则为默认颜色(跟随主题) | false |
hoist | int | 1 | 是否将该角色成员在右侧和普通成员区分显示,1是区分0是不区分 | true |
nonce | string | 123456 | 随机字符串,防止重复创建 | true |
删除角色
{
"role_id": "3691463336116027392",
"room_id": "3690041195409809408"
}
字段名 | 类型 | 描述 | 是否必须 |
---|---|---|---|
role_id | string | 角色 ID | true |
room_id | string | 房间 ID | true |
对指定用户授予和剥夺指定权限
对指定用户剥夺指定权限
{
"to_user_id": 66837313,
"role_id": "3581310465983111170",
"room_id": "3581310465924767744"
}
字段名 | 类型 | 描述 | 是否必须 |
---|---|---|---|
to_user_id | int | 目标用户 ID | true |
role_id | string | 角色 ID | true |
room_id | string | 房间 ID | true |
修改于 2024-10-14 09:16:44