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

通用推送字段

sender_info和user_info字段#

{
            "avatar": "https://imgheybox.max-c.com/avatar/2024/05/22/d00c1ab1820ee5860372aadaf57cb4f9.png",
            "avatar_decoration": {
                "src_type": "image",
                "src_url": "https://cdn.max-c.com/heybox/dailynews/img/9a8254caf5c8cb8a048f583e6ec9d30b.png"
              },
            "bot": false,
            "level": 2,
            "medals": [
                {
                  "name": "厂商认证",
                  "name_short": "",
                  "description": "ceshi ",
                  "color": "",
                  "img_url": "https://imgheybox.max-c.com/oa/2023/07/17/f6e4e6d8bf3f64061caf4313c0935b5e.png",
                  "medal_id": 56
                }
              ],
            "nickname": "测试测试222",
            "tag": {
                "bg_color": "#2B74D9",
                "text_color": "#ffffff",
                "text": "机器人"
              },
            "user_id": 8829926
        }
字段类型描述
avatarstring用户头像 URL
avatar_decorationobject用户头像装饰信息
botboolean是否为机器人
levelint用户等级
medalsarray用户勋章信息,包含名称、简称、描述、颜色、图片 URL 和勋章 ID
nicknamestring用户昵称
tagobject用户标签信息
user_idint64用户 ID
avatar_decoration 字段
字段类型描述
src_typestring用户头像装饰类型目前有["image"]
src_urlstring用户头像装饰url 链接
medals 字段
字段类型描述
namestring勋章名称
name_shortstring勋章简称
descriptionstring勋章描述
colorstring勋章颜色
img_urlstring勋章图片 URL
medal_idnumber勋章 ID
tag字段
字段类型描述
bg_colorstring背景颜色
text_colorstring文本颜色
textstring文本内容

room_base_info 字段#

"room_base_info": {
            "room_avatar": "",
            "room_id": "3611849174284943360",
            "room_name": "酸辣鸡杂面的房间"
        }
房间的基本信息
字段类型描述
room_avatarstring房间的头像图片链接,如果为空则表示没有特定的头像
room_idstring房间的唯一标识 ID ,发送消息的必需字段
room_namestring房间名称

channel_base_info 字段#

"channel_base_info": {
            "channel_id": "3611849174307799042",
            "channel_name": "默认频道",
            "channel_type": 1
        }
字段类型描述
channel_idstring频道的唯一标识 ID ,发送消息的必需字段
channel_namestring频道名称
channel_typeint频道类型

频道类型#

频道类型
频道类型值频道类型使用场景
0语音频道语音聊天频道
1文字频道仅文字聊天频道
2公告频道公告频道仅管理员发言
3分组类型的频道
4临时频道24小时后被删除
5临时频道管理器点击生成临时频道
修改于 2024-10-10 07:51:42
上一页
事件说明
下一页
用户使用Bot命令
Built with