获取员工会话 - 微伴助手OpenAPI

获取指定员工的聊天会话列表。会话默认按照最近更新时间从新到旧排序。
由于最近更新时间可能产生变化导致重新排序，全量抓取时可以改为采用 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

示例值:

offset

string

可选

列表偏移。用于迭代获取所有数据，默认值为0

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

session_list

array[object (ChatSession) {13}]

必需

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

最近消息发送时间

必需

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正常返回