员工管理客服组管理
查询坐席分组成员
返回指定分组下的所有在岗坐席。请求体中 role 不传或不含该字段时不按角色过滤(即返回所有角色的在岗坐席);传入 role 时仅返回指定角色的坐席。仅返回有效关联,不包含已删除或停用的坐席分组关联。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| groupId | int64 | 是 | 分组ID(必填) | 20001 |
| role | int32 | 否 | 角色过滤;不传或不含此字段时不按角色过滤 | 2 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | object[] | 分组成员坐席列表,按 role 过滤后的在岗坐席 | [{"id":10001,"username":"agent01@example.com","realname":"张三","nickname":"客服小张","role":2,"phone":"13800138000","email":"agent01@example.com","status":1,"createtime":1720085400000}] |
| └id | int64 | 坐席 ID | 10001 |
| └username | string | 坐席登录名(通常为邮箱或手机号) | agent01@example.com |
| └realname | string | 真实姓名 | 张三 |
| └nickname | string | 昵称 | 客服小张 |
| └role | int32 | 角色枚举值(如 2-普通坐席) | 2 |
| └roleId | int64 | 角色 ID;未返回时为 0 | 0 |
| └phone | string | 手机号 | 13800138000 |
| └telephone | string | 座机号 | 010-12345678 |
| string | 邮箱 | agent01@example.com | |
| └status | int32 | 坐席状态枚举值(如 1-正常,2-停用) | 1 |
| └createtime | int64 | 创建时间(毫秒时间戳) | 1720085400000 |
| └updateTime | int64 | 最后更新时间(毫秒时间戳;未返回时为 0) | 0 |
| └maxServiceCount | int32 | 最大同时服务访客数,0 表示不限 | 5 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | groupId 缺失;请求体不是合法 JSON |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/v2/staff/group/memberscurl -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": "服务内部异常"
}这篇文档有帮助吗?