获取员工会话
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
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
session_list
$ref(#/definitions/5788352)[]
必需
#/definitions/5788352
可选
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"
}
]
}
最后修改时间: 7 个月前