纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

    • CRM对象接口

    • CRM对象通用接口

    • 通讯录接口

      • 人员角色接口

      • 人员接口

        • 获取部门下成员简略信息
          • 获取部门下成员信息(详细)
        • 用户组接口

      • 其他接口

    • 免登集成方案

    • 客户端开发

    • 常见问题

    目录

    获取部门下成员简略信息

    # 描述

    获取部门下成员简略信息

    # 请求说明

    请求方式:POST + application/json

    请求路径:https://${填入所在云的域名}/cgi/user/simpleList?thirdTraceId=${随机字符串}

    请求头填写 :参考公共参数填写

    # 请求参数

    参数 类型 是否必填 说明
    departmentId Int 是 部门ID, 为非负整数,999999 代表全公司,该id可以获取全公司人员
    fetchChild Boolean 否 true:获取其所有子部门员工; false(默认):只获取当前部门员工

    # 请求示例

    {
      "departmentId": 1000,
      "fetchChild": false
    }
    

    # 返回参数

    参数 类型 说明
    userList List 成员信息列表
      openUserId string openUserId
      name string 名称
      nickName string 昵称
    traceId string 请求唯一ID
    errorDescription string 错误描述
    errorMessage string 错误信息
    errorCode Int 查看错误码

    # 返回示例

    {
      "userList": [
        {
          "openUserId": "FSUID_39E2Bxxxxxxx",
          "name": "小明",
          "nickName": "小明"
        },
        {
          "openUserId": "FSUID_B4D44xxxxxxx",
          "name": "小红",
          "nickName": "小红"
        }
      ],
      "traceId": "E-O.827xxxxxx",
      "errorCode": 0,
      "errorMessage": "success",
      "errorDescription": "成功"
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    获取用户对应的角色
    获取部门下成员信息(详细)

    ← 获取用户对应的角色 获取部门下成员信息(详细) →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式