# 获取客服会话列表

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getkfsessionlist

本接口用于获取指定客服的当前会话列表

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KF_ACCOUNT

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:1、6、100-101

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token
kf_accountstringtest1@test完整客服账号

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
sessionlistobjarray会话列表

# Res.sessionlist(Array) Object Payload

会话列表

参数名类型说明
createtimetimestamp会话接入时间
openidstring用户openid

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT

返回示例

{
  "sessionlist": [
    {
      "createtime": 123456789,
      "openid": "OPENID"
    }
  ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
0ok或者in a normal stateok是指从不正常变成正常 in a normal state是指本来就正常
65401invalid custom service account无效客服账号
65402the custom service account need to bind a wechat user客服账号尚未绑定微信号,不能投入使用

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;