企微协议 SAAS
  1. 消息
企微协议 SAAS
  • 必读文档(问问题前先看完这里)
  • 枚举类
  • 回调
  • 客户端
    • 升级实例
      POST
    • 恢复实例
      POST
    • 停止实例
      POST
    • 设置实例通知地址
      POST
    • 设置实例桥接ID
      POST
    • 设置实例代理
      POST
  • 登录
    • 获取登录二维码
    • 检查登录二维码
    • 推送手机确认登录通知
    • 登录验证码
    • 自动登录
    • 扫码登录[无需调用]
    • 保持登录[无需调用]
  • 用户
    • 获取当前帐号信息
    • 获取当前帐号公司信息
    • 登出
    • 获取二维码名片 (新)
    • 获取二维码名片
    • 获取绑定的微信信息
  • 消息
    • 发送文本消息
      POST
    • 发送群@消息
      POST
    • 发送语音消息
      POST
    • 发送位置消息
      POST
    • 发送图片消息
      POST
    • 发送文件消息
      POST
    • 发送视频消息
      POST
    • 发送大视频消息
      POST
    • 发送Gif消息
      POST
    • 发送Gif消息
      POST
    • 发送名片
      POST
    • 发送链接
      POST
    • 发送小程序
      POST
    • 发送视频号
      POST
    • 获取语音消息翻译id
      POST
    • 获取语音消息翻译结果
      POST
    • 确认企微内部消息已读
      POST
    • 撤回消息
      POST
    • 标记会话已读
      POST
    • 发送聊天合集(合并转发)
      POST
    • 发送视频号直播
      POST
    • 发送引用消息
      POST
    • 发送微信小店商品信息
      POST
  • 联系人
    • 同步联系人
    • 同步申请好友列表
    • 批量获取用户信息
    • 批量获取公司信息
    • 更新联系人
    • 搜索微信/企微用户
    • 添加搜索的微信用户
    • 添加搜索的企微用户
    • 添加名片为联系人
    • 通过二维码名片添加微信用户
    • 添加被对方的删除联系人
    • 同意联系人申请
    • 删除联系人
    • 通过二维码获取联系人
    • 操作黑名单
  • 群聊
    • 获取客户群列表(自己是群主)
    • 批量获取群详细信息
    • 批量获取群成员详细信息
    • 增量同步群信息
    • 创建外部群
    • 创建内部群
    • 创建空的外部群
    • 修改群名称
    • 邀请/添加群成员
    • 移除群成员
    • 修改群公告
    • 转让群主
    • 添加群管理员
    • 移除群管理员
    • 开启/关闭群邀请确认
    • 退出群
    • 解散群
    • 添加群联系人
    • 通过群邀请链接进群
    • 修改群内昵称
    • 修改群备注
    • 获取群二维码
    • 开启/关闭禁止互相添加为联系人、禁止修改群名接口
    • 设置群自动回复
  • 云存储
    • 更新CDN信息
    • C2C CDN上传
    • C2C CDN下载
    • Big CDN上传
    • Big CDN下载
    • 微信CDN下载
    • 极速群发图片上传
    • 上传视频预览图
  • 标签
    • 同步获取标签列表
    • 创建标签
    • 批量为成员添加标签
    • 删除标签
    • 修改标签
    • 为成员添加多个标签
  • 朋友圈
    • 获取发布的朋友圈记录
    • 设置朋友圈封面
    • 设置朋友圈签名
    • 发布朋友圈
    • 删除朋友圈
    • 点赞
    • 评论
    • 获取指定朋友圈详情
    • 删除评论
  • 同步
    • 推送同步消息
    • 同步联系人数据
    • 同步消息
  1. 消息

发送聊天合集(合并转发)

POST
/msg/send_forward_msg
Msg

发送聊天合集#

支持合集消息嵌套

1. msg_type 值#

    kTextMsg = 2                  # 文本消息
    kLocationMsg = 3              # 位置消息
    kLinkCardMsg = 4              # 链接消息
    kImageMsg = 5                 # 图片消息
    kVideoMsg = 7                 # 视频消息
    kFileMsg = 8                  # 文件消息
    kForwardMsg = 16              # 合集消息
{
    "guid": "cfec5383-a80d-3a11-b7e7-5f46a7b39a73",
    "conversation_id" : "S:788129xxx",
    "message_list": [
        {
            "msg_type": 2,
            "content": "文本消息",
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },   
        {
            "msg_type": 3,
            "longitude": 116.39,
            "latitude": 39.90,
            "address": "北京市东城区东长安街",
            "title": "天安门",
            "zoom": 15.0,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        }, 
        {
            "msg_type": 4,
            "title": "百度一下",
            "desc": "用科技让复杂的世界更简单!",
            "url": "https://www.baidu.com",
            "image_url": "https://img.jbzj.com/file_images/Illustrator/201702/2017020411591786.png",
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 5,
            "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fef4b042430666438386237652d633365622d346439632d623134362d61323233386531613734653902010002030bc970041025e2ceb37e281290fcac8d32e5353f4e0201020201000400",
            "size": 772458,
            "aes_key": "7e7c6dc5e523f6e66354a0619d12d423",
            "md5": "25e2ceb37e281290fcac8d32e5353f4e",
            "image_width": 600,
            "image_height": 800,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 7,
            "file_id": "30819402010204818c3081890201000204283cabaa02030f4df90204ace63cb702046597b5ef044c4e45574944315f32383363616261616163653633636237363539666630363630303032653830325f32303961366435332d336166642d346165352d613666332d646637626431333264613735020100020400a2a910041025794543d528125d6221e60bb5d903ca0201040201000400",
            "size": 10660107,
            "aes_key": "62643161646438636365356163313239",
            "md5": "25794543d528125d6221e60bb5d903ca",
            "file_name": "a.mp4",
            "video_duration": 14,
            "video_width": 800,
            "video_height": 450,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 8,
            "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fefc9042462353361363839622d666531622d343434652d393464642d62316237313763666137653302010002037ca7100410e313756042fcb1fc862ad942407acb040201050201000400",
            "size": 8169221,
            "aes_key": "0e8f16ace6f64ad49e9c2b9531bbabaf",
            "md5": "e313756042fcb1fc862ad942407acb04",
            "file_name": "Linux 内核源代码完全注释。第三版.pdf",
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 16,
            "message_list": [
                {
                    "msg_type": 2,
                    "content": "嵌套文本消息",
                    "sender_user_id":"xxx",
                    "sender_name": "xxx"
                }
            ]
        }
    ]
}

请求参数

Body 参数application/json
guid
string 
必需
conversation_id
string 
必需
message_list
array [object {24}] 
必需
msg_type
integer 
必需
content
string 
可选
sender_user_id
string 
必需
sendtime
integer 
必需
sender_name
string 
必需
longitude
number 
可选
latitude
number 
可选
address
string 
可选
title
string 
必需
zoom
integer 
可选
desc
string 
可选
url
string 
可选
image_url
string 
可选
file_id
string 
必需
size
integer 
必需
aes_key
string 
必需
md5
string 
必需
image_width
integer 
可选
image_height
integer 
可选
file_name
string 
必需
video_duration
integer 
可选
video_width
integer 
可选
video_height
integer 
可选
message_list
array [object {5}] 
可选
示例
{
  "guid": "cfec5383-a80d-3a11-b7e7-5f46a7b39a73",
  "conversation_id": "S:788129xxx",
  "message_list": [
    {
      "msg_type": 2,
      "content": "文本消息",
      "sender_user_id": "xxx",
      "sendtime": 1737360028,
      "sender_name": "xxx"
    },
    {
      "msg_type": 3,
      "longitude": 116.39,
      "latitude": 39.9,
      "address": "北京市东城区东长安街",
      "title": "天安门",
      "sendtime": 1737360028,
      "zoom": 15,
      "sender_user_id": "xxx",
      "sender_name": "xxx"
    },
    {
      "msg_type": 4,
      "title": "百度一下",
      "desc": "用科技让复杂的世界更简单!",
      "url": "https://www.baidu.com",
      "image_url": "https://img.jbzj.com/file_images/Illustrator/201702/2017020411591786.png",
      "sendtime": 1737360028,
      "sender_user_id": "xxx",
      "sender_name": "xxx"
    },
    {
      "msg_type": 5,
      "sendtime": 1737360028,
      "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fef4b042430666438386237652d633365622d346439632d623134362d61323233386531613734653902010002030bc970041025e2ceb37e281290fcac8d32e5353f4e0201020201000400",
      "size": 772458,
      "aes_key": "7e7c6dc5e523f6e66354a0619d12d423",
      "md5": "25e2ceb37e281290fcac8d32e5353f4e",
      "image_width": 600,
      "image_height": 800,
      "sender_user_id": "xxx",
      "sender_name": "xxx"
    },
    {
      "msg_type": 7,
      "sendtime": 1737360028,
      "file_id": "30819402010204818c3081890201000204283cabaa02030f4df90204ace63cb702046597b5ef044c4e45574944315f32383363616261616163653633636237363539666630363630303032653830325f32303961366435332d336166642d346165352d613666332d646637626431333264613735020100020400a2a910041025794543d528125d6221e60bb5d903ca0201040201000400",
      "size": 10660107,
      "aes_key": "62643161646438636365356163313239",
      "md5": "25794543d528125d6221e60bb5d903ca",
      "file_name": "a.mp4",
      "video_duration": 14,
      "video_width": 800,
      "video_height": 450,
      "sender_user_id": "xxx",
      "sender_name": "xxx"
    },
    {
      "msg_type": 8,
      "sendtime": 1737360028,
      "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fefc9042462353361363839622d666531622d343434652d393464642d62316237313763666137653302010002037ca7100410e313756042fcb1fc862ad942407acb040201050201000400",
      "size": 8169221,
      "aes_key": "0e8f16ace6f64ad49e9c2b9531bbabaf",
      "md5": "e313756042fcb1fc862ad942407acb04",
      "file_name": "Linux 内核源代码完全注释。第三版.pdf",
      "sender_user_id": "xxx",
      "sender_name": "xxx"
    },
    {
      "msg_type": 16,
      "sendtime": 1737360028,
      "message_list": [
        {
          "msg_type": 2,
          "sendtime": 1737360028,
          "content": "嵌套文本消息",
          "sender_user_id": "xxx",
          "sender_name": "xxx"
        }
      ]
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/msg/send_forward_msg' \
--header 'Content-Type: application/json' \
--data-raw '{
    "guid": "cfec5383-a80d-3a11-b7e7-5f46a7b39a73",
    "conversation_id" : "S:788129xxx",
    "message_list": [
        {
            "msg_type": 2,
            "content": "文本消息",
            "sender_user_id":"xxx",
            "sendtime": 1737360028,
            "sender_name": "xxx"
        },   
        {
            "msg_type": 3,
            "longitude": 116.39,
            "latitude": 39.90,
            "address": "北京市东城区东长安街",
            "title": "天安门",
            "sendtime": 1737360028,
            "zoom": 15.0,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        }, 
        {
            "msg_type": 4,
            "title": "百度一下",
            "desc": "用科技让复杂的世界更简单!",
            "url": "https://www.baidu.com",
            "image_url": "https://img.jbzj.com/file_images/Illustrator/201702/2017020411591786.png",
            "sendtime": 1737360028,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 5,
            "sendtime": 1737360028,
            "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fef4b042430666438386237652d633365622d346439632d623134362d61323233386531613734653902010002030bc970041025e2ceb37e281290fcac8d32e5353f4e0201020201000400",
            "size": 772458,
            "aes_key": "7e7c6dc5e523f6e66354a0619d12d423",
            "md5": "25e2ceb37e281290fcac8d32e5353f4e",
            "image_width": 600,
            "image_height": 800,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 7,
            "sendtime": 1737360028,
            "file_id": "30819402010204818c3081890201000204283cabaa02030f4df90204ace63cb702046597b5ef044c4e45574944315f32383363616261616163653633636237363539666630363630303032653830325f32303961366435332d336166642d346165352d613666332d646637626431333264613735020100020400a2a910041025794543d528125d6221e60bb5d903ca0201040201000400",
            "size": 10660107,
            "aes_key": "62643161646438636365356163313239",
            "md5": "25794543d528125d6221e60bb5d903ca",
            "file_name": "a.mp4",
            "video_duration": 14,
            "video_width": 800,
            "video_height": 450,
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 8,
            "sendtime": 1737360028,
            "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fefc9042462353361363839622d666531622d343434652d393464642d62316237313763666137653302010002037ca7100410e313756042fcb1fc862ad942407acb040201050201000400",
            "size": 8169221,
            "aes_key": "0e8f16ace6f64ad49e9c2b9531bbabaf",
            "md5": "e313756042fcb1fc862ad942407acb04",
            "file_name": "Linux 内核源代码完全注释。第三版.pdf",
            "sender_user_id":"xxx",
            "sender_name": "xxx"
        },
        {
            "msg_type": 16,
            "sendtime": 1737360028,
            "message_list": [
                {
                    "msg_type": 2,
                    "sendtime": 1737360028,
                    "content": "嵌套文本消息",
                    "sender_user_id":"xxx",
                    "sender_name": "xxx"
                }
            ]
        }
    ]
}'

返回响应

🟢200Successful Response
application/json
Body
string 
可选
示例
"string"
🟠422Validation Error
上一页
标记会话已读
下一页
发送视频号直播
Built with