1. 三、人员与组织
帮我吧API接口文档v1
  • 接口地图
  • 一、快速入门
    • 帮我吧数据接口 - 开发向导
    • 1.1 获取 Token
      POST
  • 二、核心业务实体
    • 2.1 客户与联系人
      • 联系人管理
        • 获取联系人列表
        • 搜索联系人
        • 批量获取联系人
        • 获取单个联系人
        • 创建联系人
        • 更新联系人
        • 删除单个联系人
        • 批量删除联系人
      • 客户分组
        • 获取分组列表
        • 获取分组详情
        • 批量分组详情
        • 创建分组
        • 修改分组
        • 获取分组用户
      • 联系人字段
        • 获取联系人字段列表
      • 公司管理
        • 获取公司列表
        • 搜索公司
        • 批量获取公司
        • 获取单个公司
        • 获取公司服务记录
        • 创建公司
        • 更新公司
        • 删除单个公司
        • 批量删除公司
      • 公司字段
        • 获取公司字段列表
        • 获取公司联系人
      • 远程 ID 管理
        • 获取远程ID信息
        • 修改远程ID备注
        • 远程ID绑定联系人
        • 解绑远程 ID
    • 2.2 工单
      • 工单管理
        • 获取工单列表
        • 获取工单详情
        • 批量工单详情
        • 搜索工单
        • 创建工单
        • 修改工单
        • 批量修改工单
        • 工单拆单
      • 工单回复
        • 获取工单回复列表
      • 工单附件
        • 上传工单附件
      • 工单字段
        • 自定义字段外部扩展
        • 获取工单自定义字段
        • 获取工单所有字段
        • 覆盖字段选项
        • 更新字段选项
        • 删除字段选项
      • 工单模板
        • 获取模板列表
        • 批量工单模板
        • 获取模板详情
        • 获取模板字段
      • 工单查询器
        • 获取查询器列表
        • 获取查询器详情
        • 获取查询器的工单列表
        • 获取查询器的工单总数
        • 批量获取查询器工单数量
      • 工单签名
        • 查看、提交工单免登录动态签名规则
    • 2.3 服务记录
      • IM 服务记录
        • 获取 IM 聊天记录
        • 获取 IM 会话列表
        • 获取 IM 会话详情
        • 获取服务总结(IM)
      • CC 服务记录
        • 获取呼叫中心记录列表
        • 获取呼叫中心记录详情
        • 获取指定客服的通话记录列表
        • 获取服务总结(CC)
        • 录音解冻
      • 远程协助记录
        • 获取远程记录列表
        • 获取坐席远程记录
        • 获取远程记录的聊天记录
        • 获取服务总结(远程协助)
      • 服务总结
        • 获取业务模板列表
        • 获取业务模板详情
        • 获取业务记录列表
        • 获取业务记录详情
        • 修改业务记录
    • 2.4 知识库
      • 知识库分类
        • 获取知识库分类列表
        • 新增知识库分类
        • 修改知识库分类
        • 删除知识库分类
      • 知识库条目
        • 获取知识库列表
        • 获取知识库详情
        • 获取多条知识库
        • 创建知识库
        • 修改知识库
        • 上传知识库附件
  • 三、人员与组织
    • 3.1 客服管理
      • 获取角色列表
      • 客服可用模块
      • 坐席模块授权
      • 取消坐席授权
      • 获取客服列表
      • 获取客服详情
      • 搜索客服
      • 获取多个客服信息
      • 创建客服
      • 修改客服信息
      • 删除客服信息
      • 恢复删除的客服
      • 客服授权
      • 查看客服状态
      • 修改客服状态
      • 获取客服签到列表
      • 创建客服签到
      • 获取客服排班列表
      • 新增客服排班
      • 更新客服排班
      • 删除客服排班
    • 3.2 客服组管理
      • 获取客服组列表
      • 获取客服组详情
      • 获取客服组内客服
      • 创建客服组
      • 修改客服组
      • 删除客服组
  • 四、系统配置
    • 4.1 表单管理
      • 获取表单列表
      • 获取表单详情
      • 创建表单
      • 修改表单
      • 删除表单
    • 4.2 表单字段
      • 查询指定表单的字段列表
      • 表单字段选项增加、更新
    • 4.3 资产表
      • 获取指定资产表的所有数据
      • 给指定资产表添加一行数据
      • 给指定资产表添加多行数据
      • 根据唯一值更新指定资产表一行数据
      • 更新指定资产表一行数据
      • 删除一行数据
      • 搜索资产表中的资产数据
    • 4.4 自定义字段配置
      • 列表
        • 获取字段列表-工单
        • 获取字段列表-企业
        • 获取字段列表-联系人
        • 获取字段列表-客服
        • 获取字段列表-服务总结
        • 获取字段列表-表单/资产表
      • 创建
        • 创建-单行文本 (type=2)
        • 创建-多行文本 (type=3)
        • 创建-正整数 (type=4)
        • 创建-小数 (type=5)
        • 创建-复选框 (type=6)
        • 创建-正则表达式 (type=7)
        • 创建-日期 (type=8)
        • 创建-文件上传 (type=12)
        • 创建-下拉列表 (type=1)
        • 创建-下拉列表-带外部映射ID
        • 创建-高级复选框 (type=14)
        • 创建-级联 (type=18)
        • 创建-评分 (type=13)
        • 创建-文本电话 (type=17)
        • 创建-地理位置 (type=19)
        • 创建-表格文本 (type=21)
        • 创建-签名 (type=23)
        • 创建-支付 (type=24)
        • 创建-计算字段 (type=25)
        • 创建-日期时间 (type=26)
      • 更新
        • 更新字段-基本信息
        • 更新字段-选项列表 (type=1/14)
        • 更新字段-级联 (type=18)
        • 更新字段-文本 (type=2/3)
        • 更新字段-文件上传 (type=12)
        • 更新字段-计算字段 (type=25)
      • 删除
        • 删除字段
        • 删除字段-表单/资产表
      • 查询联系人字段列表
      • 查询公司字段列表
      • 查询工单自定义字段列表
      • 查询工单字段列表(包含系统字段)
      • 下拉字段选项全量覆盖
      • 新增、修改字段选项内容
      • 删除字段选项内容
    • 4.5 客服分组管理
      • 获取客服分组列表
      • 获取客服分组详情
      • 创建客服分组
      • 修改客服分组
      • 删除客服分组
    • 4.6 工单查询器管理
      • 获取查询器列表
      • 获取查询器详情
      • 获取查询器的工单列表
      • 获取查询器的工单总数
      • 批量获取查询器工单数量
    • 4.7 工单模板管理
      • 获取模板列表
      • 批量工单模板
      • 获取模板详情
      • 获取模板字段
    • 4.8 客户分组管理
      • 获取分组列表
      • 获取分组详情
      • 批量分组详情
      • 创建分组
      • 修改分组
      • 获取分组用户
    • 4.9 短信接口
      • 获取模板列表
      • 发送短信
    • 4.10 服务商设置
      • 获取服务商账号到期时间
    • 4.11 外部扩展集成
      • 扩展系统配置文档
      • 扩展页接口文档
      • 适用客户
  • 五、呼叫中心
    • 5.1 获取客服话机状态
      • 获取客服话机状态
    • 5.2 接听模式切换
      • 获取接听模式
      • 切换接听模式
    • 5.3 SDK网页集成(CC)
      • 适用场景
      • 快速集成
      • 高级对接
  • 六、在线客服
    • 6.1 SDK网页集成(IM)
      • 适用场景
      • 快速集成
      • 高级对接
  • 七、公共接口
    • 7.1 获取 Token
      • 获取 OAuth2 Token
    • 7.2 标签接口
      • 获取标签列表
  • 八、远程工具
    • 8.1 SDK客户端集成
      • 适用场景
      • 集成方式
  • 九、AI助手
    • 9.1 MCP接入指南
    • 9.2 授权接入指南
  1. 三、人员与组织

3.2 客服组管理

客服分组支持层级结构(父子分组)和组织架构归属。#

客服分组管理 (supportgroups)#

客服分组支持层级结构(父子分组)和组织架构归属。

数据结构#

字段类型说明
sgIdint分组 ID
sgNamestring分组名称(同企业内唯一)
parentIdint父级分组 ID,0 表示顶级分组
orgIdint组织架构 ID,0 表示未归属组织
tagsarray标签列表
managersarray主管列表,元素为 {sId, name};已进回收站的客服不输出

获取分组列表#

请求
请求参数
参数类型必填说明
pageint否页码,默认 1
per_pageint否每页数量,默认 100,最大 100
orgIdint否按组织过滤,大于 0 时生效
响应示例
{
  "supportgroups": [
    {
      "sgId": "1",
      "sgName": "根组织",
      "parentId": "0",
      "orgId": "30001",
      "tags": [],
      "managers": [
        {"sId": "123", "name": "张三"}
      ]
    }
  ],
  "count": "4",
  "previous_page": null,
  "next_page": null
}
说明: 返回扁平列表,客户端按 parentId 自行组装树形结构。

获取单个分组#

请求
响应示例
{
  "supportgroup": {
    "sgId": "4",
    "sgName": "上海组",
    "parentId": "0",
    "orgId": "30001",
    "tags": [],
    "managers": [
      {"sId": "123", "name": "张三"}
    ]
  }
}

创建分组#

请求
请求参数
参数类型必填说明
sgNamestring是分组名称,最长 120 字符,同企业内唯一
parentIdint否父级分组 ID,默认 0;须为同企业存在的分组
orgIdint否组织架构 ID,默认 0;只读组织下不允许创建
tagsarray否标签列表
managerarray否主管客服 sId 数组;须为本企业在职客服(回收站中的客服校验不通过)
请求示例
{
  "supportgroup": {
    "sgName": "上海组-浦东分部",
    "parentId": 4,
    "orgId": 30001,
    "manager": [123, 456]
  }
}
响应示例
{
  "supportgroup": {
    "sgId": "120007",
    "sgName": "上海组-浦东分部",
    "parentId": "0",
    "orgId": "30001",
    "tags": [],
    "managers": [
      {"sId": "123", "name": "张三"},
      {"sId": "456", "name": "李四"}
    ]
  }
}

修改分组#

请求
请求参数
参数类型必填说明
sgNamestring否分组名称
parentIdint否父级分组 ID,不能是分组自身
orgIdint否组织架构 ID,只读组织下不允许修改
tagsarray否标签列表
managerarray否主管客服 sId 数组,校验规则同创建
响应示例:同创建,返回修改后的数据。
错误说明: 所有字段均无有效变更时返回 110042 There is no valid update value。

删除分组#

请求
响应示例
{
  "supports": {
    "sgId": "120006",
    "sgName": "apitest-noorg",
    "url": "http://xxx/api/v1/supportgroups/120006.json"
  }
}
说明: 删除分组会同时解除组内客服与该分组的关联。

错误码(分组相关)#

错误码说明
110059sgName 必填
110061parentId 必须为非负整数
110062parentId 对应的分组不存在
110063orgId 必须为非负整数
110064只读组织下不允许创建/修改分组
110065parentId 不能是分组自身
110066orgId 查询参数必须为非负整数
110067manager 含不合法的客服 ID(不存在或已进回收站)

修改于 2026-10-18 12:38:09
上一页
删除客服排班
下一页
获取客服组列表
Built with