1.1. 推送数据类型-会话记录

企业可通过此结构解析被推送的会话记录

1.1.1. 推送方法及数据格式

POST application/json

1.1.2. 请求参数

参数名 必填 类型 说明
action 是 String 推送消息类型：WeCom_message
message 是 Message 推送消息体

Message(推送消息包装)

参数名 类型 说明
weComMessageLogList List 消息列表

特别说明（重要）

针对图片、视频、音频、文件等资源类型的链接，由于我方为异步下载，且由于文件大小问题，下载时间不确定，所以在推送时，均为临时无效图片。 此资源会在文件真正下载成功后，进行重推，内容与原消息记录一致，请被推送方用msg_id消息唯一标识进行对应记录的更新。

PushQaBaseChatDto(单条消息记录)

参数名 类型 说明
seq String 消息顺序号（无实际意义）
msgId String 消息唯一标识
msgType String 消息类型
content Object 消息内容，根据消息类型不同，会有不同的结构
from UserSource 消息发送人
receiverList List 消息接收人列表
room String 群ID，群聊时有值，单聊时为空
msgTime String 消息时间 yyyy-MM-dd HH24:mm:ss
chatType String SINGLE-IN 内部单聊,SINGLE-OUT 外部单聊,GROUP 群聊

UserSource(人员信息描述)

参数名 类型 说明
userId String 人员ID，内部员工为userId,外部客户为external_user_id
avatar String 人员头像
nickName String 人员昵称
type String 人员类型，CUSTOMER 客户，USER 员工
markName String 客户备注
addTime String 添加时间 yyyy-MM-dd HH24:mm:ss
tags Array 标签
- tagId String 标签id
- tagName String 标签名称

content(聊天类型描述)

文本类型（text）
参数名 类型 说明
msgType String 消息类型为text
content String 消息内容

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17554,
        "msgId": "120498959155105308_1637206080125_external",
        "msgType": "text",
        "content": "你好你好",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER",
          "markName":"客户备注",
          "tags":[
            {
              "tagId":"标签id",
              "tagName":"标签名称"
            }
          ],
          "addTime":"2022-03-28 14:36:23"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 11:27:59"
      }
    ]
  }
}
图片类型（image）
参数名 类型 说明
msgType String 消息类型为image
content String 图片地址

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17555,
        "msgId": "6451407629331038340_1637206085263_external",
        "msgType": "image",
        "content": "weWorkChatMediaFile/downloading.png",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 11:28:05"
      }
    ]
  }
}
语音消息类型（voice）
参数名 类型 说明
msgType String 消息类型为voice
content String 时长和语音文件地址，以竖线 | 进行分割

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17574,
        "msgId": "7212393074317398914_1637228778690_external",
        "msgType": "voice",
        "content": "3|weWorkChatMediaFile/downloading.png",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:46:18"
      }
    ]
  }
}
视频消息类型（video）
参数名 类型 说明
msgType String 消息类型为video
content String 时长和视频文件地址，以竖线 | 进行分割

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17578,
        "msgId": "17185650380852803833_1637228820154_external",
        "msgType": "video",
        "content": "11|weWorkChatMediaFile/downloading.png",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:46:59"
      }
    ]
  }
}
名片（card）
参数名 类型 说明
msgType String 消息类型为card
content Object 名片消息体
- corpName String 来源
- userId String 用户ID
- userName String 用户名称
- avatar String 用户头像

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17582,
        "msgId": "15632627358257767245_1637229743519_external",
        "msgType": "card",
        "content": "{\"corpName\":\"微信\",\"userId\":\"wm_3b_EAAAb2sb9GGwGKCNvovkgMq56g\"}",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 18:02:23"
      }
    ]
  }
}
位置（location）
参数名 类型 说明
msgType String 消息类型为location
content Object 位置消息体
- address String 地址信息
- title String 位置信息的title
- longitude double 经度
- latitude double 纬度
- zoom double 缩放比例

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17573,
        "msgId": "8240584258252993786_1637228768792_external",
        "msgType": "location",
        "content": "{\"address\":\"西城区西直门南大街2号4门\",\"title\":\"成铭大厦C座(西直门南大街2号2门)\",\"longitude\":116.357177734,\"latitude\":39.939273834,\"zoom\":15}",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:46:08"
      }
    ]
  }
}
表情（emotion）
参数名 类型 说明
msgType String 消息类型为emotion
content String 图片地址

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17575,
        "msgId": "18430777032884737253_1637228787409_external",
        "msgType": "emotion",
        "content": "weWorkChatMediaFile/downloading.png",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:46:27"
      }
    ]
  }
}
链接（link）
参数名 类型 说明
msgType String 消息类型为link
content Object 位置消息体
- title String 消息标题
- description String 消息描述
- link_url String 链接url地址
- image_url String 链接图片url

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17580,
        "msgId": "3173894740668489846_1637228877595_external",
        "msgType": "link",
        "content": "{\"title\":\"时政微视频丨办好中国的事情关键在党\",\"description\":\"我分享了【时政微视频丨办好中国的事情关键在党】, 快来看吧！ | https://content-static.cctvnews.cctv.com/snow-book/index.html?item_id=10066171523905778892&toc_style_id=feeds_default&share_to=wechat&track_id=223ce323-7c97-47b3-8549-fe616fcf8c80\",\"linkUrl\":\"https://content-static.cctvnews.cctv.com/snow-book/index.html?item_id=10066171523905778892&toc_style_id=feeds_default&share_to=wechat&track_id=223ce323-7c97-47b3-8549-fe616fcf8c80\",\"imageUrl\":\"https://wework.qpic.cn/wwpic/823187_uffPWZ53R-ylaBe_1637228877/0\"}",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:47:57"
      }
    ]
  }
}
小程序消息（weapp）
参数名 类型 说明
msgType String 消息类型为weapp
content Object 位置消息体
- title String 消息标题
- description String 消息描述
- username String 用户名称
- displayname String 小程序名称

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17579,
        "msgId": "6742475214542648820_1637228850754_external",
        "msgType": "weapp",
        "content": "{\"title\":\"北京健康宝\",\"description\":\"\",\"userName\":\"gh_e3b81975fe3c@app\",\"displayName\":\"北京健康宝\"}",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:47:30"
      }
    ]
  }
}
会话记录消息（chatrecord）
参数名 类型 说明
msgType String 消息类型为chatrecord
content Object 位置消息体
- title String 消息标题
- item String 消息记录内的消息内容，批量数据
- type String 每条聊天记录的具体消息类型：ChatRecordText/ ChatRecordFile/ ChatRecordImage/ ChatRecordVideo/ ChatRecordLink/ ChatRecordLocation/ ChatRecordMixed ….
- msgtime String 消息时间，utc时间，单位秒。
- content String 消息内容。Json串，内容为对应类型的json。String类型
- from_chatroom Boolean 是否来自群会话。

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17581,
        "msgId": "4597047700610324705_1637229495409_external",
        "msgType": "chatrecord",
        "content": "{\"title\":\"waters321的聊天记录\",\"item\":[{\"type\":\"text\",\"uuid\":\"zbjbngopda\",\"msgTime\":1637228728,\"content\":\"{\\\"content\\\":\\\"你好你好\\\"}\",\"fromChatRoom\":false},{\"type\":\"text\",\"uuid\":\"vi0sjrid26\",\"msgTime\":1637228761,\"content\":\"{\\\"content\\\":\\\"[名片]\\\"}\",\"fromChatRoom\":false},{\"type\":\"location\",\"uuid\":\"wk1a1nixzw\",\"msgTime\":1637228767,\"content\":\"{\\\"longitude\\\":116.357178000,\\\"latitude\\\":39.939274000,\\\"address\\\":\\\"西城区西直门南大街2号4门\\\",\\\"title\\\":\\\"成铭大厦C座(西直门南大街2号2门)\\\",\\\"zoom\\\":15}\",\"fromChatRoom\":false},{\"type\":\"text\",\"uuid\":\"2ccgwlty51\",\"msgTime\":1637228777,\"content\":\"{\\\"content\\\":\\\"[该消息类型暂不能展示]\\\"}\",\"fromChatRoom\":false},{\"type\":\"text\",\"uuid\":\"f62qdyaxi6\",\"msgTime\":1637228786,\"content\":\"{\\\"content\\\":\\\"[动画表情]\\\"}\",\"fromChatRoom\":false},{\"type\":\"text\",\"uuid\":\"xacafgs0hi\",\"msgTime\":1637228787,\"content\":\"{\\\"content\\\":\\\"[动画表情]\\\"}\",\"fromChatRoom\":false},{\"type\":\"image\",\"uuid\":\"cdihc4kfcp\",\"msgTime\":1637228817,\"content\":\"{\\\"md5sum\\\":\\\"4e6be839704fb730864f3f68808a2cbf\\\",\\\"content\\\":\\\"weWorkChatMediaFile/downloading.png\\\",\\\"filesize\\\":501902}\",\"fromChatRoom\":false},{\"type\":\"video\",\"uuid\":\"shl74jx5ue\",\"msgTime\":1637228819,\"content\":\"{\\\"md5sum\\\":\\\"8982b9444d62104e4ad20773a9fb033c\\\",\\\"content\\\":\\\"weWorkChatMediaFile/downloading.png\\\",\\\"fileSize\\\":775273,\\\"playLength\\\":11}\",\"fromChatRoom\":false},{\"type\":\"text\",\"uuid\":\"0y6iet3cbt\",\"msgTime\":1637228849,\"content\":\"{\\\"content\\\":\\\"[该消息类型暂不能展示]\\\"}\",\"fromChatRoom\":false},{\"type\":\"link\",\"uuid\":\"8j1kyep80r\",\"msgTime\":1637228876,\"content\":\"{\\\"title\\\":\\\"时政微视频丨办好中国的事情关键在党\\\",\\\"description\\\":\\\"我分享了【时政微视频丨办好中国的事情关键在党】, 快来看吧！ | https://content-static.cctvnews.cctv.com/snow-book/index.html?item_id=10066171523905778892&toc_style_id=feeds_default&share_to=wechat&track_id=223ce323-7c97-47b3-8549-fe616fcf8c80\\\",\\\"link_url\\\":\\\"https://content-static.cctvnews.cctv.com/snow-book/index.html?item_id=10066171523905778892&toc_style_id=feeds_default&share_to=wechat&track_id=223ce323-7c97-47b3-8549-fe616fcf8c80\\\",\\\"image_url\\\":\\\"https://wework.qpic.cn/wwpic/686411_PmO5msKsSUyeHAe_1637229495/0\\\"}\",\"fromChatRoom\":false}]}",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:58:15"
      }
    ]
  }
}
混合消息（mixed）
参数名 类型 说明
msgType String 消息类型为mixed
content List 消息体
- type String 消息标题
- content String 消息描述

注：mixed内包含一个item数组，其中每个元素由type与content组成，type和content均为String类型。JSON解析content后即可获取对应type类型的消息内容。

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17586,
        "msgId": "10121097642643092466_1637230479948",
        "msgType": "mixed",
        "content": "[{\"type\":\"image\",\"content\":\"weWorkChatMediaFile/downloading.png\",\"uuid\":\"5a9csvnpo0\"},{\"type\":\"text\",\"content\":\"\\n123123123123\",\"uuid\":\"t9mnsvnbvq\"}]",
        "from": {
          "userId": "ZhangMiao",
          "avatar": "https://wework.qpic.cn/wwhead/duc2TvpEgST9hicuyypLEKFmA6iaw9DUKut9ktzfaXibFkSvDBF5vCIt29thP2RQfzRThfXicUx3dTg/100",
          "nickName": "张淼(微丰测试)",
          "type": "USER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 18:14:39"
      }
    ]
  }
}
文件类型（file）
参数名 类型 说明
msgType String 消息类型为file
content String 文件名和文件链接地址，以竖线 | 进行分割

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17557,
        "msgId": "17458947575482929291_1637206097901_external",
        "msgType": "file",
        "content": "sms_send__246_1116.xlsx|weWorkChatMediaFile/downloading.png",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 11:28:17"
      }
    ]
  }
}
音频存档消息（meeting_voice_call）
参数名 类型 说明
msgType String 消息类型为meeting_voice_call
content Object 消息体
- voice String 文件地址
- length String 位置信息的title

示例

{
  "action": "WeCom_message",
  "message": {
    "weComMessageLogList": [
      {
        "seq": 17573,
        "msgId": "8240584258252993786_1637228768792_external",
        "msgType": "meeting_voice_call",
        "content": "{\"voice\":\"https://xxxx.xxx.xxx/xxxx.mp3\",\"length\":\"113\"}",
        "from": {
          "userId": "wm_3b_EAAA_fQc4dp-FS7iOx5qSUB90A",
          "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM4sicgFB9ibH33FlKnuMOMRVTqQJcIWjDYibwePYUtrmSldg/0",
          "nickName": "waters321",
          "type": "CUSTOMER"
        },
        "receiverList": [
          {
            "userId": "jianini01",
            "avatar": "http://p.qlogo.cn/bizmail/A8UkibFZ6HwE0lZmicFD3ia4I2txM436vibO8F5BoxfDprvZ1gBiakiaQiaUA/100",
            "nickName": "贾妮妮",
            "type": "USER"
          }
        ],
        "room": null,
        "msgTime": "2021-11-18 17:46:08"
      }
    ]
  }
}

1.1.3. 返回数据

HTTP状态码为200，responseBody不做要求。

results matching ""

    No results matching ""