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

查询坐席分组成员

返回指定分组下的所有在岗坐席。请求体中 role 不传或不含该字段时不按角色过滤(即返回所有角色的在岗坐席);传入 role 时仅返回指定角色的坐席。仅返回有效关联,不包含已删除或停用的坐席分组关联。

请求参数

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

请求体

名称类型必填描述示例值
groupIdint64是分组ID(必填)20001
roleint32否角色过滤;不传或不含此字段时不按角色过滤2

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messageobject[]分组成员坐席列表,按 role 过滤后的在岗坐席[{"id":10001,"username":"agent01@example.com","realname":"张三","nickname":"客服小张","role":2,"phone":"13800138000","email":"agent01@example.com","status":1,"createtime":1720085400000}]
└idint64坐席 ID10001
└usernamestring坐席登录名(通常为邮箱或手机号)agent01@example.com
└realnamestring真实姓名张三
└nicknamestring昵称客服小张
└roleint32角色枚举值(如 2-普通坐席)2
└roleIdint64角色 ID;未返回时为 00
└phonestring手机号13800138000
└telephonestring座机号010-12345678
└emailstring邮箱agent01@example.com
└statusint32坐席状态枚举值(如 1-正常,2-停用)1
└createtimeint64创建时间(毫秒时间戳)1720085400000
└updateTimeint64最后更新时间(毫秒时间戳;未返回时为 0)0
└maxServiceCountint32最大同时服务访客数,0 表示不限5

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004groupId 缺失;请求体不是合法 JSON
14500服务内部异常
postEndpoint
/openapi/v2/staff/group/members
POST
/openapi/v2/staff/group/members
curl -X POST "https://qiyukf.com/openapi/v2/staff/group/members?appKey=string&time=0&checksum=string" \  -H "Content-Type: application/json" \  -d '{    "groupId": 20001  }'
{
  "code": 200,
  "message": [
    {
      "id": 10001,
      "username": "agent01@example.com",
      "realname": "张三",
      "nickname": "客服小张",
      "role": 2,
      "phone": "13800138000",
      "email": "agent01@example.com",
      "status": 1,
      "createtime": 1720085400000
    }
  ]
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "groupId 缺失;请求体不是合法 JSON"
}
{
  "code": 14500,
  "message": "服务内部异常"
}

这篇文档有帮助吗?