七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
员工管理客服组管理

查询客服组列表(基础信息)

查询企业下全部客服组,成功结果放在 data 字段。

请求参数

名称类型必填描述示例值
appKeystring是七鱼 OpenAPI appKey。demoAppKey
timeint64是请求时间戳,秒级。1710000000
checksumstring是按 appSecret、请求体 MD5 和 time 计算的校验值。abcdef123456
checksumAlgorithmint32否校验算法,未传时使用 0。0

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功。200
messagestring响应消息。success
dataobject[]业务数据。
└idint64客服组 ID。
└namestring客服组名称。
└parentint64父客服组 ID。
└pinyinstring客服组名称拼音。
└rankint32排序值。
└serviceCntint32当前服务人数。
└maxServiceCntint32最大服务人数。
└pinyin2string下拉搜索使用的拼音。
└staffCountint32客服数量。
└updateStaffNamestring最后更新的客服名称。
└updateTimeint64最后更新时间。
└staffNamesstring客服名称摘要。
└numberint32电话转接号码。
└statusint32客服组状态。
└pathstring客服组路径。
└groupLevelstring客服组层级。
└childrenobject[]子客服组列表。
└idint64客服组 ID。
└namestring客服组名称。
└parentint64父客服组 ID。
└pinyinstring客服组名称拼音。
└rankint32排序值。
└serviceCntint32当前服务人数。
└maxServiceCntint32最大服务人数。
└pinyin2string下拉搜索使用的拼音。
└staffCountint32客服数量。
└updateStaffNamestring最后更新的客服名称。
└updateTimeint64最后更新时间。
└staffNamesstring客服名称摘要。
└numberint32电话转接号码。
└statusint32客服组状态。
└pathstring客服组路径。
└groupLevelstring客服组层级。
└childrenobject[]子客服组列表。

错误码

状态码描述
400请求参数格式错误或缺少必要字段。
500服务端处理异常。
14001业务错误码,HTTP 状态码仍为 200:appKey 不存在或无效,或无法通过 appKey 查询企业。
14002业务错误码,HTTP 状态码仍为 200:checksum 签名校验失败,或内部调用 appKey 不匹配。
14003业务错误码,HTTP 状态码仍为 200:time 与服务器时间相差超过 10 分钟,或时间参数为空。
14004业务错误码,HTTP 状态码仍为 200:请求体 JSON 非法。
14500业务错误码,HTTP 状态码仍为 200:服务端处理异常,或查询客服组列表下游服务返回失败。
14702业务错误码,HTTP 状态码仍为 200:企业下无可用客服组,或客服组配置不存在。
postEndpoint
/openapi/kefuGroup/v2/list
POST
/openapi/kefuGroup/v2/list
curl -X POST "https://qiyukf.com/openapi/kefuGroup/v2/list?appKey=demoAppKey&time=1710000000&checksum=abcdef123456" \  -H "Content-Type: application/json" \  -d '{}'

{
  "code": 200,
  "message": "success"
}

空
空
{
  "code": 14001,
  "message": "appKey 不存在或无效,或无法通过 appKey 查询企业。"
}
{
  "code": 14002,
  "message": "checksum 签名校验失败,或内部调用 appKey 不匹配。"
}
{
  "code": 14003,
  "message": "time 与服务器时间相差超过 10 分钟,或时间参数为空。"
}
{
  "code": 14004,
  "message": "请求体 JSON 非法。"
}
{
  "code": 14500,
  "message": "服务端处理异常,或查询客服组列表下游服务返回失败。"
}
{
  "code": 14702,
  "message": "企业下无可用客服组,或客服组配置不存在。"
}

这篇文档有帮助吗?