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

查询坐席分组列表

返回该企业下所有启用的坐席分组信息。请求体中 staff 为 true 时同时返回每个分组内的坐席 ID 列表;默认不返回。仅返回 category 存在且有效的分组。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和
checksumAlgorithmint32否签名算法:0 - 默认(SHA1),1 - SHA256

请求体

名称类型必填描述示例值
staffboolean否是否返回分组成员坐席ID列表,默认 falsetrue

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messageobject[]坐席分组列表,仅返回 category 存在且有效的分组[{"id":20001,"name":"售后组","staffIdList":[10001,10002,10003]}]
└idint64分组ID(category_id)20001
└namestring分组名称售后组
└staffIdListint64[]分组成员坐席ID列表(仅 staff=true 时返回,默认返回空列表)[10001,10002,10003]

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON
14500服务内部异常
postEndpoint
/openapi/v2/staff/group/list
POST
/openapi/v2/staff/group/list
curl -X POST "https://qiyukf.com/openapi/v2/staff/group/list?appKey=string&time=0&checksum=string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "code": 200,
  "message": [
    {
      "id": 20001,
      "name": "售后组",
      "staffIdList": [
        10001,
        10002,
        10003
      ]
    }
  ]
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体不是合法 JSON"
}
{
  "code": 14500,
  "message": "服务内部异常"
}

这篇文档有帮助吗?