微伴助手OpenAPI
  1. 聊天记录管理
微伴助手OpenAPI
  • OpenAPI基本介绍
  • 错误码参考表
  • 访问频率和并发限制
  • 消息订阅
    • 订阅消息加解密指南
    • 回调应用配置指南
    • 工单变更消息
      • 工单变更消息回调
      • 创建工单回调
      • 流转工单回调
      • 关闭工单回调
      • 重新打开工单回调
      • 评论工单回调
  • 获取访问凭据
    • 获取访问凭据
      POST
  • 员工管理
    • 获取员工列表
      GET
    • 获取员工详情
      GET
    • 发送员工通知
      POST
  • 自定义订单管理
    • 订单信息删除
      GET
    • 获取订单信息列表
      GET
    • 批量同步店铺信息
      POST
    • 批量同步商品信息
      POST
    • 批量同步订单信息v2
      POST
    • 批量删除商品信息
      POST
    • 删除店铺信息
      GET
    • 批量删除订单信息
      POST
    • 获取店铺信息详情
      POST
    • 获取店铺信息列表
      GET
    • 获取商品信息详情
      POST
    • 获取商品信息列表
      GET
  • 客户管理
    • 获取客户列表
    • 根据更新时间获取客户列表
    • 获取客户详情
    • 获取流失提醒客户列表
    • 导入客户信息
    • 添加客户评分
    • 添加自定义字段
    • 批量预设客户属性
    • 批量修改自定义字段的值
    • 创建批量加好友任务(批量创建添加客户任务)
    • 批量unionid&openid换external_user_id
    • external_user_id换unionid
    • unionid&openid换客户id
    • 获取客户自定义字段值列表
    • 批量获取客户详情
    • 获取批量加好友待添加列表
  • 客户积分管理
    • 批量增减客户积分
    • 批量获取客户积分
    • 获取单个客户积分明细记录
    • 获取全部客户积分明细记录
  • 客户标签管理
    • 获取标签列表
    • 批量更新客户企业标签
    • 给客户添加企业标签
    • 删除客户的企业标签
    • 给客户添加微伴个人标签
    • 删除客户的微伴个人标签
    • 获取预打标签信息
    • 批量预打企业标签
    • 根据手机号删除预打标签任务
    • 根据unionid删除预打标签任务
    • 获取指定用户预打标签任务详情
    • 获取预打标签任务列表
    • 添加预打标签任务
  • 客户画像管理
    • 获取客户事件列表
    • 创建自定义客户事件
    • 获取自定义客户事件类型列表
    • 获取自定义客户事件类型详情
    • 添加自定义客户事件类型
    • 删除自定义客户事件类型
    • 更新自定义客户事件类型
    • 获取客户阶段状态
  • 标签库管理
    • 获取标签列表V2
    • 获取指定标签信息
    • 新增企业标签组
    • 新增企业标签
    • 删除企业标签
    • 更新企业标签
    • 同步企业微信标签
  • 群聊管理
    • 获取群聊列表
    • 获取群聊成员列表
    • 获取客户所在群聊
    • 查看客户是否在群聊中
    • 获取群聊详情
  • 工单管理
    • 工单模块OpenAPI开发必读
    • 获取工单列表
    • 获取工单详情
    • 获取工单流内处理人
    • 获取工单模板列表
    • 获取工单模板详情
    • 新建工单
    • 修改工单
    • 流转工单
    • 评论工单
    • 关闭工单
  • 销售过程管理
    • 获取商机列表
    • 获取商机详情
    • 修改商机阶段
    • 获取线索公海列表
    • 批量导入线索
    • 修改线索
    • 获取线索列表
    • 员工单条/批量领取线索
    • 获取线索客户列表
  • 聊天记录管理
    • 获取会话消息
      GET
    • 获取会话消息2(按照消息时间逆序)
      GET
    • 获取员工会话
      GET
  • 拉新排行榜
    • 获取拉新排行榜列表
  • 群裂变
    • 获取群裂变活动列表
    • 获取群裂变任务详情
    • 获取群裂变客户详情列表
  • 群打卡
    • 获取群打卡活动列表
    • 获取群打卡任务详情
  • 企微任务宝
    • 获取企微任务宝活动列表
    • 获取企微任务宝任务详情
    • 获取企微任务宝对应的客户数据列表
    • 获取客户对应的企微任务宝数据列表
  • 拉新排行榜
    • 获取拉新排行榜活动列表
  • 自定义表单
    • 获取自定义表单列表
    • 自定义表单用户与表单关系列表
    • 自定义表单提交数据详情列表
    • 获取自定义表单分组列表
  • 客户转化
    • 批量新增手机线索转化
  • 员工个人群发记录管理
    • 获取员工个人群发记录列表
    • 获取员工个人群发记录结果列表
  • 渠道码管理
    • 获取渠道码列表
    • 获取渠道码加人数据
  • 素材库管理
    • 获取素材库列表
    • 获取素材库标签列表
    • 新增素材
    • 更新素材
    • 删除素材
    • 新建素材分组
    • 修改素材分组
    • 添加素材库标签
    • 删除素材库标签
    • 删除素材分组
    • 素材分组列表
  • 互动雷达管理
    • 获取雷达列表
    • 获取雷达详情
    • 添加雷达
    • 修改雷达
    • 删除雷达
    • 上传file
    • 获取雷达分组列表
    • 获取雷达客户访问记录
  • 自定义侧边栏身份校验
    • 侧边栏模块化-自定义卡片功能说明
    • 自定义侧边栏Code校验
  • 有赞订单管理
    • 获取有赞订单
    • 获取有赞订单列表
  • 小鹅通订单管理
    • 获取小鹅通TOKEN
  • 项目管理
    • 项目列表
  • 门店信息
    • 批量导入门店
    • 批量更新门店
    • 门店列表
  • 人群包
    • 人群包列表获取
    • 创建人群包
    • 更新人群包
    • 创建的人群包中添加数据
    • 获取人群包数据详情
  • 客户群发
    • 客户群发创建
    • 群发任务列表
    • 群群发详情获取
    • 员工群发结果
    • 客户群群发创建
    • 员工-群群发结果
    • 获取群发错误unionid/extid
  • 企微朋友圈
    • 企微朋友圈创建
    • 企微朋友圈任务列表
    • 企微朋友圈任务发表详情
  • 个人SOP
    • 个人SOP列表
    • 个人SOP详情-规则列表
    • 个人SOP详情-执行记录
  • 部门管理
    • 获取部门列表
  • 群标签管理
    • 获取群聊标签分组及其子列表
    • 群聊批量打标签
  • 话术库
    • 企业话术分组列表
    • 企业话术列表
  • 企微数据专区
    • 获取会话消息(企微数据专区)
  1. 聊天记录管理

获取会话消息

GET
/open-api/chat/message/list
调用前需进入微伴后台API页面 - 阅读并同意API使用条款 获取指定会话中的消息记录。
考虑到聊天记录随时可能新增新的聊天消息,因此聊天的翻页采用 last_id 参数。提供此参数时,将会获取 指定消息以前 的消息。
由于数据条数总量可能很多,暂不提供总量字段,请在抓取时判断返回列表长度。如果列表长度不足设置的 limit 值(默认30),则说明没有更多数据。调用此接口需购买会话席位。
各个消息类型 content 的定义如下
注:下列定义均来自企业微信文档,微伴只对其进行存储
class TextMsgData(TypedDict):
    """ 文字消息体 """
    content: str  # 消息内容


class ImageMsgData(TypedDict):
    """ 图片消息体 """
    sdkfileid: str  # 媒体资源的id信息
    md5sum: str  # 图片资源的md5值
    filesize: str  # 图片资源的文件大小


class RevokeMsgData(TypedDict):
    """ 撤回消息体 """
    pre_msgid: str  # 标识撤回的原消息的msgid


class AgreeMsgData(TypedDict):
    """ 同意消息体 """
    userid: str  # 同意协议者的userid,外部企业默认为openid
    agree_time: int  # 同意协议的时间,utc时间,ms单位


class VoiceMsgData(TypedDict):
    """ 语音消息体 """
    voice_size: int  # 语音消息大小
    play_length: int  # 播放长度
    sdkfileid: str  # 媒体资源的id信息
    md5sum: str  # 图片资源的md5值


class VideoMsgData(TypedDict):
    """ 视频消息体 """
    sdkfileid: str  # 媒体资源的id信息
    md5sum: str  # 图片资源的md5值
    filesize: str  # 图片资源的文件大小
    play_length: int  # 视频播放长度


class CardMsgData(TypedDict):
    """ 名片消息体 """
    corpname: str  # 名片所有者所在的公司名称
    Userid: str  # 名片所有者的id,同一公司是userid,不同公司是openid


class LocationMsgData(TypedDict):
    """ 位置消息体 """
    longitude: float  # 精度,单位double
    latitude: float  # 维度,单位double
    address: str  # 地址信息
    title: str  # 位置信息的title
    zoom: int  # 缩放比例


class EmotionMsgData(TypedDict):
    """ 表情消息体 """
    type: int  # 表情类型,png或者gif.1表示gif 2表示png
    width: int  # 表情图片宽度
    height: int  # 表情图片高度
    sdkfileid: str  # 媒体资源的id信息
    md5sum: str  # 图片资源的md5值
    imagesize: int  # 资源的文件大小。Uint32类型


class FileMsgData(TypedDict):
    """ 文件消息体 """
    sdkfileid: str  # 媒体资源的id信息
    md5sum: str  # 图片资源的md5值
    filename: str  # 文件名称
    fileext: str  # 文件类型后缀
    filesize: int  # 文件大小


class LinkMsgData(TypedDict):
    """ 链接消息体 """
    title: str  # 消息标题
    description: str  # 消息描述
    link_url: str  # 链接url地址
    image_url: str  # 链接图片url


class WeappMsgData(TypedDict):
    """ 小程序消息体 """
    title: str  # 消息标题
    description: str  # 消息描述
    username: str  # 用户名称
    Displayname: str  # 小程序名称


class ChatrecordItem(TypedDict):
    """ 聊天记录单条内容 """
    type: str  # 消息记录类型,和 ChagMsg.mstype 类似
    msgtime: int  # 消息时间,utc时间,单位是秒
    content: str  # 消息内容。Json串,内容为对应类型的json
    from_chatroom: bool  # 是否来自群会话


class ChatrecordMsgData(TypedDict):
    """ 聊天记录消息体 """
    title: str  # 聊天记录标题
    item: List[ChatrecordItem]  # 消息记录内的消息内容,批量数据


class RedpacketMsgData(TypedDict):
    """ 红包消息体 """
    type: int  # 类型 1:一对一红包, 2:群聊拼手气红包,3:群聊专属红包
    wish: str  # 留言
    totalcnt: int  # 总个数
    totalamount: int  # 总金额,单位分


class TodoMsgData(TypedDict):
    """ 待办消息体 """
    title: str # 代办的来源文本
    content: str # 代办的具体内容


class VoteMsgData(TypedDict):
    """ 投票消息体 """
    votetitle: str # 投票主题
    voteitem: str # 投票选项
    votetype: int # 投票类型.101发起投票、102参与投票
    voteid: str # 投票id,方便将参与投票消息与发起投票消息进行前后对照


class CollectMsgDataDetailItem(TypedDict):
    """ 填表消息填写项目 """
    id: int # 表项id
    ques: str # 表项名称
    type: str # 值类型,可能为 "Text"|"Number"|"Date"|"Time"


class CollectMsgData(TypedDict):
    """ 填表消息体 """
    room_name: str # 填表消息所在的群名称
    creator: str # 创建者在群中的名字
    create_time: str # 创建的时间
    title: str # 表名
    details: List[str] # 表内容。json数组,值为 CollectMsgDataDetailItem


class MeetingMsgData(TypedDict):
    """ 会议邀请消息体 """
    topic: str #会议主题
    starttime: int # 会议开始时间。Utc时间
    endtime: int # 会议结束时间。Utc时间
    address: str # 会议地址
    remarks: str # 会议备注
    meetingtype: int # 会议消息类型。101发起会议邀请消息、102处理会议邀请消息
    meetingid: int # 会议id。方便将发起、处理消息进行对照。
    status: int # 会议邀请处理状态。1 参加会议、2 拒绝会议、3 待定


class DocmsgMsgData(TypedDict):
    """ 会议邀请消息体 """
    title: str # 在线文档名称
    link_url: str # 在线文档链接
    doc_creator: str # 在线文档创建者。为企业员工id或外部联系人id


class MarkdownMsgData(TypedDict):
    """ Markdown格式消息体 """
    content: str #     markdown消息内容,目前为机器人发出的消息


class NewsMsgData(TypedDict):
    """ 图文消息体 """
    title: str # 图文消息标题
    description: str # 图文消息描述
    url: str # 图文消息点击跳转地址
    picurl: str # 图文消息配图的url


class CalendarMsgData(TypedDict):
    """ 日程消息体 """
    title: str # 日程主题
    creatorname: str # 日程组织者
    attendeename: str # 日程参与人
    starttime: int # 日程开始时间。Utc时间,单位秒
    endtime: int # 日程结束时间。Utc时间,单位秒
    place: str # 日程地点
    remarks: str # 日程备注

请求参数

Query 参数
staff_id
string 
必需
示例值:
WuYaJun
session_id
string 
必需
limit
integer 
可选
默认范围30-100
示例值:
30
last_id
integer 
可选
返回值message_list中最后一个item的id
access_token
string 
调用接口凭证
必需
默认值:
{{access_token}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://open.weibanzhushou.com/open-api/chat/message/list?staff_id=WuYaJun&session_id=&limit=30&last_id=&access_token='

返回响应

🟢200成功
application/json
Body
message_list
array [object {16}] 
必需
id
integer 
消息id
必需
created_at
integer 
数据创建时间(微伴系统内时间)
必需
original_id
string 
企业微信原始消息id
必需
type
enum<string> 
消息类型,每种消息类型对应一种独特的内容格式
必需
枚举值:
"text""image""revoke""agree""voice""video""card""location""emotion""file""link""weapp""chatrecord""redpacket""todo""vote""collect""meeting""docmsg""markdown""news""calendar"
time
integer 
消息发送时间(来自企业微信)
必需
from_id
string 
发送者id,可能是员工id(staff_id)或是外部联系人id(external_user_id)
必需
to_id
string 
接收者id,可能是员工id(staff_id)或是外部联系人id(external_user_id)
必需
from_name
string 
发送者昵称,和 session 类似,部分情况下无法获取准确昵称,此时会用id拼接的昵称代替,如是群聊消息则返回空
必需
from_avatar
string 
发送者头像,部分情况下无法获取头像,会为空,如是群聊消息则返回空
必需
content
object 
消息内容。MsgData是一个泛指,根据消息类型(type)不同其数据结构会不同,具体见上文已知消息类型部分的描述
必需
direction
string 
消息方向(针对当前 session 的所有者来说),可能值为 "send"(发送)或 "receive"(接收)
必需
file_url
string  | null 
文件链接,可用于下载聊天文件,链接15分钟内有效
必需
room_id
string  | null 
所在群聊id,不是群聊数据为空, 只有群聊的时候才会返回此字段
必需
room_ext_id
string  | null 
所在群聊的ext_id,只有群聊才会返回此字段
必需
staff_id
string 
员工id,对应企业微信 userid
必需
text_content
string 
文字内容,此字段为了方便进行纯文本形式的内容展示,比如针对图片类型的消息此字段值为 "[图片消息]"
必需
total
integer 
总数
必需
示例
{
  "errcode": 0,
  "errmsg": "ok",
  "total": 2,
  "message_list": [
    {
      "id": 1,
      "created_at": 1579434300,
      "original_id": "1429143826468815703_1579434160",
      "type": "text",
      "time": 1579434160,
      "from_id": "zhangsan",
      "to_id": "wo8xjUCAAAtHYL_MZJby_7lRz0QE1kWw"
      "from_name": "张三",
      "from_avatar": "http://wework.qpic.cn/wwhead/duc2TvpEgSSWiaVLaJnssaYfX71u0Rya0GdmcJWhR6qBgbjkqiaSIKkicTy1wVhr9tQoTMP4rCxFLM/0",
      "content": {"content": "啦啦"},
      "direction": "send",
      "file_url": null,
      "room_id": null,
      "staff_id": "zhangsan",
      "text_content": "啦啦"
    },
    {
      "id": 2,
      "created_at": 1579434300,
      "original_id": "1429143826468815703_1579434160",
      "type": "text",
      "time": 1579434160,
      "from_id": "lisi",
      "to_id": "zhangsan",
      "from_name": "李四",
      "from_avatar": "http://wework.qpic.cn/bizmail/R8eDSoIIqQoNeu65ylicWQ3bhE2F2j6h0CBWjfII8bicI2aXnDKMfB8A/0",
      "content": {"content": "呵呵"},
      "direction": "receive",
      "file_url": null,
      "room_id": null,
      "staff_id": "zhangsan",
      "text_content": "呵呵"
    }
  ]
}
🟢200正常返回
上一页
获取线索客户列表
下一页
获取会话消息2(按照消息时间逆序)
Built with