纷享销客开发者手册 纷享销客开发者手册
  • 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/crm/v2/special/roleGetRoleList?thirdTraceId=${随机字符串}

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

    # 请求参数

    参数 类型 是否必填 说明
    data Map 是 数据集
      AuthContext Map 是 应用信息
        appId String 是 应用id

    # 请求示例

    {
      "data": {
        "AuthContext": {
          "appId": "CRM"
        }
      }
    }
    

    # 返回参数

    参数 类型 说明
    traceId string 请求唯一ID
    errorDescription string 错误描述
    errorMessage string 错误信息
    errorCode Int 查看错误码
    data List 数据集

    # 返回示例

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0,
      "data": [
        {
          "groupName": "销售角色",
          "roleCode": "00000000000000001",
          "roleName": "销售人员",
          "roleType": 1,
          "appId": "CRM",
          "description": "销售人员预设销售相关功能权限",
          "delFlag": false
        },
        {
          "groupName": "财务角色",
          "roleCode": "00000000000002",
          "roleName": "退款财务",
          "roleType": 1,
          "appId": "CRM",
          "description": "退款财务相关权限",
          "delFlag": false
        }
      ]
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    通过角色获取对应的用户
    删除指定角色的人员

    ← 通过角色获取对应的用户 删除指定角色的人员 →

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