微伴助手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/session/list
获取指定员工的聊天会话列表。会话默认按照最近更新时间从新到旧排序。
由于最近更新时间可能产生变化导致重新排序,全量抓取时可以改为采用 id 从小到大方式进行排列。
错误码说明
20402会话类型错误,请输入"ext_user","room"或"other_staff"
调用此接口需购买会话席位。

请求参数

Query 参数
access_token
必需
示例值:
708a904a8fb4592ea83c5b0accd30600
staff_id
企业微信员工id
必需
示例值:
ZengDeWei
order_by
string 
可选
列表排序方式。可选值为 'last_updated_desc' (默认,按照最近更新时间递减)和 'id_asc' (按照主键递增)
示例值:
last_updated_desc
type
string 
可选
会话类型。若填写,只返回特定类型的会话。若不填写,只返回('ext_user', 'other_staff')类型的会话。可选值为 'ext_user'(外部联系人),'room'(群聊),'other_staff' (其他同事)
limit
string 
可选
列表返回长度。默认值为30,最大值为100
示例值:
30
offset
string 
可选
列表偏移。用于迭代获取所有数据,默认值为0
示例值:
0

示例代码

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/session/list?access_token=708a904a8fb4592ea83c5b0accd30600&access_token=&staff_id=ZengDeWei&order_by=last_updated_desc&type&limit=30&offset=0'

返回响应

🟢200成功
application/json
Body
session_list
array[object (ChatSession) {13}] 
必需
id
string 
会话id(非主键,在同staff_id维度下唯一,但全局不唯一)
必需
created_at
integer 
数据创建时间(微伴系统内时间)
必需
staff_id
string 
员工 id,对应企业微信 userid
必需
target_id
string 
聊天对象id,根据对象类型不同会指代不同的id
必需
name
string 
对象名称,某些情况下微伴可能无法获取到id,此时用对象id代替
必需
avatar
string 
对象头像,某些情况下不存在
必需
agree_msgaudit
boolean 
对方是否同意消息存档
必需
agree_time
integer 
对方同意消息存档的时间
必需
last_msg_thumb
string 
最近消息的摘要
必需
last_msg_time
integer 
最近消息发送时间
必需
session_type
string 
对象类型,可能值为 "ext_user"(外部联系人),"room"(群聊),"other_staff"(其他员工)
必需
type
integer 
外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
必需
unionid
string 
仅当联系人类型是微信用户,且企业绑定了微信开发者ID有此字段
必需
total
integer 
总数
必需
示例
{
  "errcode": 0,
  "errmsg": "ok",
  "total": 1,
  "session_list": [
    {
      "id": "xxxxxxxx",
      "created_at": 1579434300,
      "staff_id": "zhangsan",
      "target_id": "wo8xjUCAAAtHYL_MZJby_7lRz0QE1kWw",
      "name": "李四",
      "avatar": "http://wework.qpic.cn/wwhead/duc2TvpEgSSWiaVLaJnssaYfX71u0Rya0GdmcJWhR6qBgbjkqiaSIKkicTy1wVhr9tQoTMP4rCxFLM/0",
      "agree_msgaudit": true,
      "agree_time": 1579434160,
      "last_msg_thumb": "你好",
      "last_msg_time": 1591940337,
      "session_type": "ext_user",
      "type": 2,
      "unionid": "xxx"
    }
  ]
}
🟢200正常返回
上一页
获取会话消息2(按照消息时间逆序)
下一页
获取拉新排行榜列表
Built with