获取客服帐号列表

GET

/cgi-bin/kf/account/list

服务端API第三方应用开发企业内部开发

获取客服帐号列表，包括所有的客服帐号的客服ID、名称和头像。

当客服较多时，需要使用参数offset及limit 分页获取，注意offset是以0为起点，这里以图例简单说明：
page_size/page_index图示说明

当获取到的 account_list中的账号数量小于 指定的limit 的时候，表示已经没有更多的数据，此时应终止获取。

权限说明:

企业需要使用“微信客服”secret所获取的accesstoken来调用（accesstoken如何获取？）

第三方应用需具有“微信客服->获取基础信息”权限

代开发自建应用需具有“微信客服->获取基础信息”权限

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://qyapi.weixin.qq.com/cgi-bin/kf/account/list?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
	"offset": 0,
    "limit": 100
}'

响应示例

{
  "errcode": 0,
  "errmsg": "ok",
  "account_list": [
    {
      "open_kfid": "wkAJ2GCAAASSm4_FhToWMFea0xAFfd3Q",
      "name": "咨询客服",
      "avatar": "https://wework.qpic.cn/wwhead/duc2TvpEgSSjibPZlNR6chpx9W3dtd9Ogp8XEmSNKGa6uufMWn2239HUPuwIFoYYZ7Ph580FPvo8/0"
    }
  ]
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

offset

integer

必需

分页，偏移量, 默认为0

limit

integer

必需

分页，预期请求的数据量，默认为100，取值范围 1 ~ 100

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

错误码描述

可选

account_list

array [object {3}]

帐号信息列表

可选

name

string

客服名称

可选

avatar

string

客服头像URL

可选

open_kfid

string

客服帐号ID

可选

修改于 2022-12-01 09:04:18

修改客服帐号

获取客服帐号链接