# 获取在线客服列表

调试诊断

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

接口英文名：getonlinekflist

本接口用于获取当前在线客服列表

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN&business_id=BUSINESS_ID

# 云调用

• 本接口不支持云调用。

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String Parameters

# 请求体 Request Payload

无

# 3. 返回参数

# 返回体 Response Payload

# Res.kf_online_list(Array) Object Payload

在线客服列表

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN&business_id=BUSINESS_ID

返回示例

{
  "kf_online_list" : [
      {
          "kf_account" : "test1@test" ,
          "status" : 1,
          "kf_id" : "1001",
          "kf_openid": "kfopenid1"
      },
      {
          "kf_account" : "",
          "status" : 1,
          "kf_id" : "1002",
          "kf_openid": "kfopenid2"
      }
  ]
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 7. 适用范围