# 获取在线客服列表
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getonlinekflist
本接口用于获取当前在线客服列表
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：1、6、19、100-101
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| kf_online_list | objarray | 在线客服列表 |
# Res.kf_online_list(Array) Object Payload
在线客服列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| kf_account | string | 完整客服账号，格式为：账号前缀@公众号微信号 |
| status | number | 客服在线状态，目前为：0-不在线，1-web 在线 |
| kf_id | number | 客服编号 |
| accepted_case | number | 客服当前正在接待的会话数 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist
返回示例
{
"kf_online_list": [{
"kf_account": ""
}]
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 0 | ok或者in a normal state | ok是指从不正常变成正常 in a normal state是指本来就正常 |
| 65400 | please enable new custom service or wait for a while if you have enabled | API不可用，即没有开通/升级到新版客服功能 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况：
| 小程序 | 公众号 | 服务号 | 小游戏 |
|---|---|---|---|
| ✔ | 仅认证 | 仅认证 | ✔ |
- ✔：该账号可调用此接口
- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；