黑盒语音接口
  1. 房间角色接口
黑盒语音接口
  • 教程
  • 开发者服务协议
  • 使用交流
  • 更新日志
  • 开发计划
  • 资源
    • 请求速率限制
    • Websocket
    • Bot命令
  • WEBSOCKET 连接请求
    • 连接到黑盒语音服务
  • HTTP接口
    • 消息接口
      • 发送消息接口的参数
      • 发送消息接口的返回值
      • 发送图片形式的频道消息
      • 发送Markdown文档
      • 更新指定频道消息
      • 删除指定的频道消息
      • 对某条频道消息增加/取消回应(小表情)
      • 发送卡片消息
      • 给用户发送私聊消息
      • 发送频道图片消息
      • 发送频道消息
      • 发送卡片消息
      • 发送频道消息@全体成员/@在线成员
      • 更新指定的频道消息
      • 删除指定的频道消息
      • 对某条频道消息增加/取消回应(小表情)
      • 给用户发送私聊消息
    • 媒体文件上传
      • 上传媒体文件的参数解析
      • 上传媒体文件
    • 房间角色接口
      • 权限相关说明
      • 接口说明
      • 获取房间角色列表
        GET
      • 创建角色
        POST
      • 更新角色
        POST
      • 删除角色
        POST
      • 对指定用户授予指定权限
        POST
      • 对指定用户剥夺指定权限
        POST
    • 房间表情
      • 房间表情包
      • 获取房间上传的表情包
      • 房间删除表情包
      • 房间更新表情包名称
    • 房间接口
      • 房间相关接口文档
      • 修改房间内昵称
      • 分页获取加入的房间列表
      • 获取房间信息
      • 退出房间
      • 房间踢人
      • 获取房间用户列表
  • 服务端推送事件
    • 事件说明
    • 通用推送字段
    • 机器人命令
      • 用户使用Bot命令
    • 频道消息事件
      • 频道消息事件
    • 房间消息事件
      • 房间消息事件
  1. 房间角色接口

接口说明

获取房间角色列表#

获取房间角色列表
'https://chat.xiaoheihe.cn/chatroom/v2/room_role/roles?room_id=&client_type=heybox_chat&x_client_type=web&os_type=web&x_os_type=bot&x_app=heybox_chat&chat_os_type=bot&chat_version=1.24.5'
GET 请求参数
值类型描述是否必须
room_idstring房间IDtrue

修改角色相关信息#

角色相关的POST的接口都需要管理员权限(0)或者管理角色权限(16)才能进行操作权限接口描述

创建角色#

创建角色
{
    "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"
}
字段类型示例值说明是否必须
namestring机器人角色名称。true
iconstringhttps://imgheybox.max-c.com/dev/avatar/2023/08/10/be2f127109038a6644c15ab9cf678b9e.png角色的图标,这里为空表示没有特定图标。false
color_listarray[15027858,14985695]渐变色的颜色数组,颜色值10进制,在其他未完成的房间无法使用false
room_idstring3230476736336502784房间 IDtrue
permissionsstring34359738369权限值,具体参考 (权限说明)true
typeint0类型标识,用于区分不同类型的角色具体参考(角色类型常量表),机器人创建的角色建议默认为0true
colorint0颜色值10进制,在界面展示中用于区分不同角色。,不填则为默认颜色(跟随主题)false
hoistint1是否将该角色成员在右侧和普通成员区分显示,1是区分0是不区分true
noncestring123456随机字符串,防止重复创建true

更新角色#

"id": "3690041195495620610"
[更新角色](/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’字段,指定角色的id
字段类型示例值说明是否必须
idstring3690041195495620610角色idtrue
namestring机器人角色名称。true
iconstringhttps://imgheybox.max-c.com/dev/avatar/2023/08/10/be2f127109038a6644c15ab9cf678b9e.png角色的图标,这里为空表示没有特定图标。false
color_listarray[15027858,14985695]渐变色的颜色数组,颜色值10进制,在其他未完成的房间无法使用false
room_idstring3230476736336502784房间 IDtrue
permissionsstring34359738369权限值,具体参考 (权限说明)true
typeint0类型标识,用于区分不同类型的角色具体参考(角色类型常量表),机器人创建的角色建议默认为0true
colorint0颜色值10进制,在界面展示中用于区分不同角色。,不填则为默认颜色(跟随主题)false
hoistint1是否将该角色成员在右侧和普通成员区分显示,1是区分0是不区分true
noncestring123456随机字符串,防止重复创建true

删除角色#

删除角色
{
    "role_id": "3691463336116027392",
    "room_id": "3690041195409809408"
}
字段名类型描述是否必须
role_idstring角色 IDtrue
room_idstring房间 IDtrue

对指定用户授予和剥夺指定权限#

对指定用户授予指定权限
对指定用户剥夺指定权限
{
    "to_user_id": 66837313,
    "role_id": "3581310465983111170",
    "room_id": "3581310465924767744"
}
字段名类型描述是否必须
to_user_idint目标用户 IDtrue
role_idstring角色 IDtrue
room_idstring房间 IDtrue
修改于 2024-10-14 09:16:44
上一页
权限相关说明
下一页
获取房间角色列表
Built with