发送消息接口的参数
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 | 纯图片的消息类型 | 在发送图片的时候使用 |
4 | markdown类型的消息 | 建议优先使用markdown的消息类型 |
10 | 带有@成员的markdown类型的消息 | 是消息4的扩展 |
1.1 发送消息字段解析
字段名 | 类型 | 描述 | 例子 | 是否必须 |
---|---|---|---|---|
msg | string | 代表实际发送的消息内容。格式为 “@{id: 成员 ID}@{id: 角色ID} #{id: 频道 ID} 消息文本” | “@{id:72053518}@{id:3663316788343832578} #{id:3665944781964836864} 123” 表示@了成员 ID 为 72053518 和 3663316788343832578 的角色,提及量频道 ID 为 3665944781964836864 的频道,同时发送消息 “123” | true |
msg_type | int | 消息类型 | 参考上述的消息类型 | true |
heychat_ack_id | string | 用于确认消息是在频道发送重复 | 建议维护一个全局的累加的值,60秒内不重复 | true |
reply_id | string | 回复的用户的 ID,如果不是回复特定用户的消息则为空。 | 一般建议用@代替 | false |
room_id | string | 房间 ID | true | |
channel_id | string | 频道 ID 不指定房间和频道ID 无法发送 | true | |
addition | string | 附加信息,这里为 “{"img_files_info":[]}”,表示没有图片文件信息。如果有图片等其他附加信息,可以在这里进行描述 | false | |
at_user_id | string的数组 | 被 @的用户 ID | @多个用户 "123,234" | false |
at_role_id | string的数组 | 被 @的角色 ID | @多个角色"123,345" | false |
mention_channel_id | string的数组 | 提及的频道 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",
}
```
|字段|类型|描述|
|----|----|----|
|msg|string|对成员 ID 为 72053518 的用户进行了 @提及,同时也对角色 ID 为 3663316788343832578 的角色进行了 @提及,此外,还提及了 ID 为 3665944781964836864 的频道。|
|at_user_id|string|被@的用户 ID,用逗号","隔开|
|at_role_id|string|被@的角色 ID,用逗号","隔开|
|mention_channel_id|string|提及的频道 ID,用逗号","隔开|
效果图
![带@成员的频道消息](https://imgheybox.max-c.com/oa/2024/09/09/aa55025d4aaa6e6839e936b8ca28f452.png)
## 1.3 发送带图片的且@成员的 markdown消息
{
"msg": "@{id:72053518} \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",
}
|字段|类型|描述|
|----|----|----|
|msg|string|这里 @了用户 ID 为 72053518 的用户,并包含了一个图片链接和 “大师级选手” 的文本内容|
|addition|string|消息的附加信息,包含一个图片文件的信息,包括图片链接、宽度和高度,此消息中包含了一个图片文件的信息,该图片的宽度为 200、高度为 200|
效果图
![有图片的且@成员的频道消息](https://imgheybox.max-c.com/oa/2024/09/09/2be06f1f543e9f20410391606cff4afb.png)
## 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_type | int | 消息类型,仅图片的消息类型为 3 |
img | string | 上传到 CDN 的图片地址 |
效果图
[updatedIn] 2 个月前
1、消息类型
1.1 发送消息字段解析
1.2 发送带@成员的频道消息