# 给用户发送私聊消息

## 接口地址
[给用户发送私聊消息](https://s.apifox.cn/43256fe4-9a8c-4f22-949a-74a3f8b431f5/247164510e0.md)

## 发送限制
私聊功能仅支持向处于同一房间内的用户发送消息。在对方尚未回复的情况下，发送方最多可发送 3 条消息。
每日私聊人数无限制设置。,但是私聊频率限定为每分钟 9 条消息。
若机器人发送无意义或骚扰信息，将对该机器人执行封禁处理。
## 格式支持
私聊消息目前支持markdown格式(msg_type=4)和图片格式(msg_type=3)

## POST请求的Body请求参数
发送markdown格式参数
```
{
  "msg": "123",
  "msg_type": 4,
  "heychat_ack_id": "1",
  "addition": "{}",
  "to_user_id": 1234567
}
```
发送图片格式参数
```
{
  "heychat_ack_id": "2",
  "msg_type": 3,
  "img": "https://imgheybox.max-c.com/dev/bbs/2024/12/23/57f769af63491f5adf7d7c1374e403da.png",
  "to_user_id": 1234567
}
```

| 参数名 | 类型 | 必须 | 说明 |
| --- | --- | --- | --- |
| heychat_ack_id | string | true | 校验是否重复发送,建议为自增number|
| msg_type | string | true | 消息类型,目前支持markdown格式(msg_type=4)和图片格式(msg_type=3)|
| img | int64 | false|发送图片消息时为必须字段,上传到CDN的图片地址  |
| to_user_id | int64 | true |对方Heybox_ID,只能给加入同一房间内的用户发松|

## 返回结果参数

```
{
    "msg": "",
    "result": {
        "heychat_ack_id": "2",
        "msg_id": "1871016546788270080",
        "msg_seq": "1871016546788270080"
    },
    "status": "ok"
}
```

| 参数名 | 类型 |  说明 |
| --- | --- | --- |
| heychat_ack_id | string | 发送的校验参数,返回给发送者|
| msg_id | string |  发送成功的消息ID|
| msg_seq | int64 | 兼容字段,无需使用 |