# 获取在线客服列表

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getonlinekflist

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

## 1. 调用方式

### HTTPS 调用

```bash
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](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  },
  {
    "参数名": "business_id",
    "类型": "string",
    "必填": "否",
    "说明": "客服子商户的business_id，对于普通小程序客服不需要填business_id"
  }
]
```

### 请求体 `Request Payload`

无

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "kf_online_list",
    "类型": "objarray",
    "说明": "在线客服列表"
  }
]
```

">

### Res.kf_online_list(Array) `Object Payload`

在线客服列表

```json
[
  {
    "参数名": "kf_account",
    "类型": "string",
    "说明": "完整客服账号，格式为：账号前缀@公众号微信号"
  },
  {
    "参数名": "status",
    "类型": "number",
    "说明": "客服在线状态，目前为：0-不在线，1-web 在线"
  },
  {
    "参数名": "kf_id",
    "类型": "number",
    "说明": "客服编号"
  },
  {
    "参数名": "accepted_case",
    "类型": "number",
    "说明": "客服当前正在接待的会话数"
  },
  {
    "参数名": "kf_openid",
    "类型": "string",
    "说明": "客服openid"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

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

返回示例

```json
{
  "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. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "0",
    "错误描述": "成功"
  },
  {
    "错误码": "40003",
    "错误描述": "非法的openid"
  },
  {
    "错误码": "40005",
    "错误描述": "不支持的媒体类型"
  },
  {
    "错误码": "40009",
    "错误描述": "媒体文件长度不合法"
  },
  {
    "错误码": "65400",
    "错误描述": "API不可用，即没有开通/升级到新版客服功能"
  },
  {
    "错误码": "65401",
    "错误描述": "无效客服账号"
  },
  {
    "错误码": "65402",
    "错误描述": "客服账号尚未绑定微信号，不能投入使用"
  },
  {
    "错误码": "65403",
    "错误描述": "客服昵称不合法"
  },
  {
    "错误码": "65404",
    "错误描述": "客服账号不合法"
  },
  {
    "错误码": "65405",
    "错误描述": "账号数目已达到上限，不能继续添加"
  },
  {
    "错误码": "65406",
    "错误描述": "已经存在的客服账号"
  },
  {
    "错误码": "65407",
    "错误描述": "邀请对象已经是该小程序客服"
  },
  {
    "错误码": "65408",
    "错误描述": "本小程序已经有一个邀请给该微信"
  },
  {
    "错误码": "65409",
    "错误描述": "无效的微信号"
  },
  {
    "错误码": "65410",
    "错误描述": "邀请对象绑定小程序客服数达到上限"
  },
  {
    "错误码": "65411",
    "错误描述": "该账号已经有一个等待确认的邀请，不能重复邀请"
  },
  {
    "错误码": "65412",
    "错误描述": "该账号已经绑定微信号，不能进行邀请"
  },
  {
    "错误码": "65413",
    "错误描述": "不存在对应用户的会话信息"
  },
  {
    "错误码": "65414",
    "错误描述": "客户正在被其他客服接待"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "公众号": "仅认证",
    "服务号": "仅认证",
    "小游戏": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。