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

发送消息接口的参数

1、消息类型#

在发送的消息中,存在msg_type
{
    "msg": "@{id:72053518}@{id:3663316788343832578} #{id:3665944781964836864}  123",
    "msg_type": 10,
    "heychat_ack_id": "0",
    "reply_id": "",
    "room_id": "3663316788315193344",
    "addition": "{\"img_files_info\":[]}",
    "at_user_id": "72053518",
    "at_role_id": "3663316788343832578",
    "mention_channel_id": "3665944781964836864",
    "channel_id": "3665944781964836864",
    "channel_type": 1
}
msg_type描述建议使用场景
3纯图片的消息类型在发送图片的时候使用
4markdown类型的消息建议优先使用markdown的消息类型
10带有@成员的markdown类型的消息是消息4的扩展

1.1 发送消息字段解析#

字段名类型描述例子是否必须
msgstring代表实际发送的消息内容。格式为 “@{id: 成员 ID}@{id: 角色ID} #{id: 频道 ID} 消息文本”“@{id:72053518}@{id:3663316788343832578} #{id:3665944781964836864} 123” 表示@了成员 ID 为 72053518 和 3663316788343832578 的角色,提及量频道 ID 为 3665944781964836864 的频道,同时发送消息 “123”true
msg_typeint消息类型参考上述的消息类型true
heychat_ack_idstring用于确认消息是在频道发送重复建议维护一个全局的累加的值,60秒内不重复true
reply_idstring回复的用户的 ID,如果不是回复特定用户的消息则为空。一般建议用@代替false
room_idstring房间 IDtrue
channel_idstring频道 ID 不指定房间和频道ID 无法发送true
additionstring附加信息,这里为 “{"img_files_info":[]}”,表示没有图片文件信息。如果有图片等其他附加信息,可以在这里进行描述false
at_user_idstring的数组被 @的用户 ID@多个用户 "123,234"false
at_role_idstring的数组被 @的角色 ID@多个角色"123,345"false
mention_channel_idstring的数组提及的频道 ID提及多个频道"3663316788315193344,3663316788315193345"false
消息换行方式:使用 “\n\n” 可对Markdown消息进行有效换行,而仅使用一个 “\n” 则会导致换行操作失败。

1.2 发送带@成员的频道消息#

{
    "msg": "@{id:72053518}@{id:3663316788343832578} #{id:3665944781964836864}  123",
    "msg_type": 10,
    "heychat_ack_id": "0",
    "room_id": "3663316788315193344",
    "addition": "{\"img_files_info\":[]}",
    "at_user_id": "72053518",
    "at_role_id": "3663316788343832578",
    "mention_channel_id": "3665944781964836864",
    "channel_id": "3665944781964836864",
}
字段类型描述
msgstring对成员 ID 为 72053518 的用户进行了 @提及,同时也对角色 ID 为 3663316788343832578 的角色进行了 @提及,此外,还提及了 ID 为 3665944781964836864 的频道。
at_user_idstring被@的用户 ID,用逗号","隔开
at_role_idstring被@的角色 ID,用逗号","隔开
mention_channel_idstring提及的频道 ID,用逗号","隔开
效果图
带@成员的频道消息

1.3 发送带图片的且@成员的 markdown消息#

{
    "msg": "@{id:72053518} ![](https://chat.max-c.com/pic/1832982856236494848.png)\n\n大师级选手",
    "msg_type": 10,
    "heychat_ack_id": "1",
    "reply_id": "",
    "room_id": "3663316788315193344",
    "addition": "{\"img_files_info\":[{\"url\":\"https://chat.max-c.com/pic/1832982856236494848.png\",\"width\":200,\"height\":200}]}",
    "at_user_id": "72053518",
    "channel_id": "3665944781964836864",
}
字段类型描述
msgstring这里 @了用户 ID 为 72053518 的用户,并包含了一个图片链接和 “大师级选手” 的文本内容
additionstring消息的附加信息,包含一个图片文件的信息,包括图片链接、宽度和高度,此消息中包含了一个图片文件的信息,该图片的宽度为 200、高度为 200
效果图
有图片的且@成员的频道消息

1.4 发送图片消息#

{
    "heychat_ack_id": "1",
    "msg_type": 3,
    "img": "https://imgheybox.max-c.com/web/bbs/2024/09/09/fefcdd1566003acc102391dc21dd14a1.png",
    "channel_id": "3665967902142889984",
    "room_id": "3663316788315193344",
}
字段类型描述
msg_typeint消息类型,仅图片的消息类型为 3
imgstring上传到 CDN 的图片地址
效果图
图片消息的频道消息
修改于 2024-10-14 09:59:45
上一页
连接到黑盒语音服务
下一页
发送消息接口的返回值
Built with