API接口文档 (小组级)-新
  1. 消息接口
API接口文档 (小组级)-新
  • api接入说明
  • 系统使用说明
  • 接口文档
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管账号列表
        • 获取联系人列表
        • 获取群列表
        • 获取群列表(不包含成员信息)
        • 发送系统通知
        • 获取自定义标签列表
        • 获取组内员工列表
      • 群聊接口
        • 加入群聊
        • 退出群聊事件回调
        • 加入群聊事件回调
        • 更改群名事件回调
        • 创建群聊
        • 通过联系人id获取联系人所在群聊
      • 会话接口
        • 开发建议
        • 会话超时跟进回调
        • 获取会话ai状态
        • 获取指定会话
        • 会话ai状态切换
        • 获取会话列表
        • 会话事件回调
        • 分配会话
        • 消息置顶
      • 加好友接口
        • 通过手机号加好友接口
        • api加好友任务成功回调
        • 好友通过后回调
        • 群聊加好友接口
      • 消息接口
        • 小组级发送消息回调
          POST
        • 获取原图
          POST
        • 发送消息
          POST
        • 小组级接收消息回调
          POST
        • 聊天历史
          GET
        • im员工id发消息
          POST
      • 群发接口
        • 创建群发
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 自建应用依赖接口
      • 客户信息接口
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 通过im群聊id加好友
      • 新增客户
      • 获取成员详情
      • 秒回数据同步
      • 获取群列表
      • 获取客户详情
      • 获取群信息
      • 绑定im官方ID
      • 通过externalUserId获取chatId
  1. 消息接口

小组级接收消息回调

POST
/message
功能描述:
本接口为小组级接收消息回调,系统后台会将接收到的托管账号消息、外部客户消息一起进行回调
回调地址:小组控制台->api接入->回调地址
个人发消息:消息回调中没有chatExternalUserId,ExternalUserId是联系人的id,botWeixin是托管账号。
企业成员发消息:消息回调中ExternalUserId是托管账号的id,chatExternalUserId是用户的id。(如果没有开通ExternalUserId的话,发消息回调里面就没有chatExternalUserId或者为空)
⚠重试机制:若回调请求超时,则会重试,最多5次,如果3分钟内有10个回调重试5次全部失败,则禁用回调地址30分钟。
⚠建议收到后回调后进行异步处理,防止处理超时导致我们重复推送。

请求参数

Body 参数application/json

示例
{
    "data": {
        "messageId": "a7e3d70d236fa003f7bfd08c4e92395b",
        "chatId": "681046253*****3b2fe4f1b",
        "avatar": "https://wx.qlogo.cn/mmhead/bVy2VQVTWzbt6h7DOt8RLLgW1O3WKurmfLQ8W7EQHIGvD2XDLyofYTaryeL9jQiadgQjb7SZPrxY/0",
        "roomTopic": "",
        "roomId": "",
        "contactName": "test_name",
        "contactId": "78813****9347451",
        "payload": {
            "imageUrl": "https://workmate.s3.cn-northwest-1.amazonaws.com.cn/link_msg/e3bc2eb2-308a-49aa-adaf-80409f58bab1/1f9e667e-f1fb-4813-b0de-2a0da0b7428f.jpg",
            "size": 3844,
            "width": 446,
            "height": 478,
            "artwork": {
                "url": "https://s3.cn-northwest-1.amazonaws.com.cn/xiaoju-new-resource-test/temp/chat-file/646d818baf71f175124fabde/66a77970c980f76b879ef868/1752130639802/a35d386d-3253-4a63-8a61-4b4d9a7307b6.jpg.jpg",
                "height": 643,
                "width": 600
            }
        },
        "type": 6,
        "timestamp": 1752130636721,
        "token": "669dc78a7****b23e04351d6",
        "contactType": 1,
        "coworker": false,
        "botId": "66a77970c****6b879ef868",
        "botWxid": "16888****6578438",
        "botWeixin": "zhangsan",
        "isSelf": false,
        "externalUserId": "wmrRhyBgAAvwB*****AoGkAYsUo6XzCQ",
        "roomWecomChatId": null,
        "mentionSelf": false
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://zan-api.xiaoshunai.com/message' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "messageId": "a7e3d70d236fa003f7bfd08c4e92395b",
        "chatId": "681046253*****3b2fe4f1b",
        "avatar": "https://wx.qlogo.cn/mmhead/bVy2VQVTWzbt6h7DOt8RLLgW1O3WKurmfLQ8W7EQHIGvD2XDLyofYTaryeL9jQiadgQjb7SZPrxY/0",
        "roomTopic": "",
        "roomId": "",
        "contactName": "test_name",
        "contactId": "78813****9347451",
        "payload": {
            "imageUrl": "https://workmate.s3.cn-northwest-1.amazonaws.com.cn/link_msg/e3bc2eb2-308a-49aa-adaf-80409f58bab1/1f9e667e-f1fb-4813-b0de-2a0da0b7428f.jpg",
            "size": 3844,
            "width": 446,
            "height": 478,
            "artwork": {
                "url": "https://s3.cn-northwest-1.amazonaws.com.cn/xiaoju-new-resource-test/temp/chat-file/646d818baf71f175124fabde/66a77970c980f76b879ef868/1752130639802/a35d386d-3253-4a63-8a61-4b4d9a7307b6.jpg.jpg",
                "height": 643,
                "width": 600
            }
        },
        "type": 6,
        "timestamp": 1752130636721,
        "token": "669dc78a7****b23e04351d6",
        "contactType": 1,
        "coworker": false,
        "botId": "66a77970c****6b879ef868",
        "botWxid": "16888****6578438",
        "botWeixin": "zhangsan",
        "isSelf": false,
        "externalUserId": "wmrRhyBgAAvwB*****AoGkAYsUo6XzCQ",
        "roomWecomChatId": null,
        "mentionSelf": false
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{}
修改于 2026-01-22 09:50:18
上一页
发送消息
下一页
聊天历史
Built with