# 发送消息

给指定用户或者会话发送消息，支持文本、富文本、卡片、图片、文件、语音消息。

注意事项:

频控说明
需要开启机器人能力
给群组发送消息，需要机器人在群中
文本消息长度最大不能超过5000
图片、富文本中的图片，需要先用图片v2接口上传图片获取链接
文件、语音消息，需要先用文件v2接口上传文件后获取文件链接
消息内容详细说明

# 请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/im/v2/messages
HTTP Method	POST
支持的应用类型	自建应用商店应用
权限要求开启任一权限即可	获取用户给机器人发送的信息、向用户发送单聊、群聊消息

# 请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer `access_token`" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

# 查询参数

名称	类型	描述
receive_id_type	string	消息接收者id类型user_id/open_id/union_id/chat_id 示例值： chat_id：以chat_id来识别群聊 user_id：以user_id来识别用户 open_id：以open_id来识别用户 union_id：以union_id来识别用户
user_id_type	string	作用于普通文本消息含有@的消息差异化控制@时用户id的识别不需要普通文本消息@则不传 @消息介绍 (opens new window)

# 请求体

名称	类型	必填	描述
receive_id	string	是	消息接收者id 示例值："150402"
content	string	是	消息内容，json结构序列化后的字符串。不同msg_type对应不同内容。消息内容详细说明
msg_type	string	是	消息类型包括：image、 compressive_card、text等;以请求示例为准
uuid	string	否	由开发者生成的唯一字符串序列，用于发送消息请求去重；持有相同uuid的请求1小时内至多成功执行一次示例值："a0d69e20-1dd1-458b-k525-dfeca4015204" 数据校验规则：最大长度：50 字符

# 请求体示例

# 普通消息

发给群聊的普通消息支持@用户，消息中如何使用@XX

{ 
    "receive_id": "150402",
    "content": "{\"text\":\" test content\"}",
    "msg_type": "text",
    "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

1
2
3
4
5
6

# 消息卡片(compressive_card)

新的卡片消息，持续迭代中资源介绍

{
  "receive_id": "11111111436",
  "content": "{    \"header\": {        \"text\": {            \"content\": \"多文本1\",            \"tag\": \"plain_text\"        },        \"color\": \"white\"    },    \"cardLink\": {        \"url\": \"https://hi.zhipin.com\",        \"pcUrl\": \"https://www.4399.com\",        \"androidUrl\": \"\",        \"iosUrl\": \"\"    },    \"globalConfig\": {        \"forward\": false,        \"shareCard\": true    },    \"modules\": [        {            \"tag\": \"split_line\"        },        {            \"fields\": [                {                    \"text\": {                        \"content\": \"多文本1\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                },                {                    \"text\": {                        \"content\": \"多文本2\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                },                {                    \"text\": {                        \"content\": \"多文本3\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                },                {                    \"text\": {                        \"content\": \"多文本4\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                }            ],            \"extra\": {                \"text\": {                    \"content\": \"按钮中展示的文本\",                    \"tag\": \"plain_text\"                },                \"multiUrl\": {                    \"url\": \"https://hi.zhipin.com\",                    \"pcUrl\": \"https://www.4399.com\",                    \"androidUrl\": \"\",                    \"iosUrl\": \"\"                },                \"callBacks\": [                    {                        \"key\": \"click1\",                        \"value\": \"1\"                    }                ],                \"confirm\": {                    \"title\": {                        \"content\": \"弹窗标题\",                        \"tag\": \"plain_text\"                    },                    \"text\": {                        \"content\": \"弹窗内容\",                        \"tag\": \"plain_text\"                    }                },                \"type\": \"primary\",                \"tag\": \"button\"            },            \"arrange\": \"bisected\",            \"tag\": \"div\"        },        {            \"actions\": [                {                    \"text\": {                        \"content\": \"按钮中展示的文本1\",                        \"tag\": \"plain_text\"                    },                    \"multiUrl\": {                        \"url\": \"https://hi.zhipin.com\",                        \"pcUrl\": \"https://www.4399.com\",                        \"androidUrl\": \"\",                        \"iosUrl\": \"\"                    },                    \"callBacks\": [                        {                            \"key\": \"click1\",                            \"value\": \"1\"                        }                    ],                    \"confirm\": {                        \"title\": {                            \"content\": \"弹窗标题\",                            \"tag\": \"plain_text\"                        },                        \"text\": {                            \"content\": \"弹窗内容\",                            \"tag\": \"plain_text\"                        }                    },                    \"needLayout\": true,                    \"type\": \"primary\",                    \"tag\": \"button\"                },                {                    \"text\": {                        \"content\": \"按钮中展示的文本2\",                        \"tag\": \"plain_text\"                    },                    \"multiUrl\": {                        \"url\": \"https://hi.zhipin.com\",                        \"pcUrl\": \"https://www.4399.com\",                        \"androidUrl\": \"\",                        \"iosUrl\": \"\"                    },                    \"callBacks\": [                        {                            \"key\": \"click1\",                            \"value\": \"1\"                        }                    ],                    \"confirm\": {                        \"title\": {                            \"content\": \"弹窗标题\",                            \"tag\": \"plain_text\"                        },                        \"text\": {                            \"content\": \"弹窗内容\",                            \"tag\": \"plain_text\"                        }                    },                    \"type\": \"primary\",                    \"tag\": \"button\"                },                {                    \"text\": {                        \"content\": \"按钮中展示的文本3\",                        \"tag\": \"plain_text\"                    },                    \"multiUrl\": {                        \"url\": \"https://hi.zhipin.com\",                        \"pcUrl\": \"https://www.4399.com\",                        \"androidUrl\": \"\",                        \"iosUrl\": \"\"                    },                    \"callBacks\": [                        {                            \"key\": \"click1\",                            \"value\": \"1\"                        }                    ],                    \"confirm\": {                        \"title\": {                            \"content\": \"弹窗标题\",                            \"tag\": \"plain_text\"                        },                        \"text\": {                            \"content\": \"弹窗内容\",                            \"tag\": \"plain_text\"                        }                    },                    \"type\": \"primary\",                    \"tag\": \"button\"                }            ],            \"arrange\": \"bisected\",            \"tag\": \"actions\"        }    ]}",
  "msg_type": "compressive_card",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

1
2
3
4
5
6

# 图文卡片消息

用图片v2接口上传图片，来获取图片链接

{
  "receive_id": "11111111436",
  "content": "{\"browser\":0,\"noHead\":0,\"originImage\":{\"height\":828,\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/Tcr7RJo4E7SzvrcXD5SoFS_zTrppKu1AkwBIXJQLrMhHi1JTRGYL.JPG\",\"width\":1242},\"text\":\"test message\"}",
  "msg_type": "image_card",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

1
2
3
4
5
6

# 图片消息

用图片v2接口上传图片，来获取图片链接

{
  "receive_id": "11111111436",
  "content": "{\"originImage\":{\"height\":2160,\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH7SJs0E7OztL1PZZX9LB7zPMFJGPQszlAvaYRYhqcq_zlUQ00W_NCjEv0UUc-2mw~~.PNG\",\"width\":1080},\"tinyImage\":{\"height\":300,\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH7SJs0E7OztL1PZZX9LB7zPMFJGPQszlAvaYRYhqcq_zlUQ00W_NCjEv0UUc-2mw~~_s139.jpg\",\"width\":150}}",
  "msg_type": "image",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

1
2
3
4
5
6

# 文件消息

用文件v2接口上传文件，来获取文件链接，大小等参数。

{
  "receive_id": "11111111435",
  "content": "{\"size\":10391599,\"name\":\"研发安全培训-202210.pdf\",\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH6QJkxE7Wz0r1MD-qWQHHOUK10doJBmQ9IZIQPhvgq5idyfGw__K6eRf8cb5E~.pdf\"}",
  "msg_type": "file",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

1
2
3
4
5
6

# 音频消息

用文件v2接口上传文件，来获取语音文件链接，大小等参数。

{
  "receive_id": "11111111435",
  "content": "{\"duration\":14,\"transText\":\"test\",\"size\":14412,\"transType\":2,\"url\":\"https://hi.zhipin.com/api/media/download/TsD7RJk2E7azkr1PYZX-Ehb6UMt0Ke0RmVQna-lgkshF4TxTWnIW3cDOfKgeAsPfkoEv.amr\"}",
  "msg_type": "audio",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

1
2
3
4
5
6

# 响应

# 响应体

注意：消息发送存在时延，仅有message_id是有效的，其他字段为null;需要查询消息详情可以稍后使用获取指定消息的内容

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	message	-
∟message_id	string	消息id

# 响应体示例

{
    "code": 0,
    "traceId": "_Ao59UOIBLPCeAAu",
    "success": true,
    "msg": "操作成功",
    "data": {
        "message_id": "14810370341sstt"
    }
}

1
2
3
4
5
6
7
8
9

← 批量更新消息更新消息 →