纷享销客开发者手册 纷享销客开发者手册
  • 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对象通用接口

    • 通讯录接口

    • 其他接口

      • 任务待办接口

      • 考勤外勤接口

      • 协同审批接口

      • 企业互联接口

      • 消息接口

      • 素材管理接口

      • 网盘接口

      • 营销通接口

      • 文件服务

      • ERP接口

      • BI接口

      • 下线接口

        • 设置成员状态(批量)
        • 修改部门
        • 根据时间段分页查询修改的员工列表
        • 设置成员状态
        • 获取部门详情
        • 根据openUserId查询员工信息
        • 设置部门状态
        • 修改成员
        • 获取部门列表
        • 根据手机号查询员工
        • 创建预设对象
        • 删除预设对象
        • 查询预设对象详情
        • 作废预设对象
        • 查询预设对象列表
          • 修改预设对象
          • 恢复预设对象
          • 变更预设对象负责人
          • 创建Erp对象
          • 查询Erp对象列表
          • 查询Erp对象详情
          • 修改Erp对象
          • 恢复Erp对象
          • 作废Erp对象
          • 变更Erp对象负责人
          • 删除Erp对象
    • 免登集成方案

    • 客户端开发

    • 常见问题

    目录

    查询预设对象列表

    # 不建议继续使用下线接口!!!

    # 描述

    查询预设对象列表

    # 请求说明

    请求方式:POST + application/json

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

    # 请求参数

    参数 类型 是否必填 说明
    corpAccessToken String 是 corpAccessToken(通过获取token接口 (opens new window)返回)
    corpId String 是 corpId(通过获取token接口 (opens new window)返回)
    currentOpenUserId String 是 currentOpenUserId(通过根据手机号查询员工接口 (opens new window)返回)
    data Map 是 数据map
      dataObjectApiName String 是 对象的api_name
      find_explicit_total_num Boolean 否 是否返回总数(true->返回total,false->不返回total总数。默认true。设置为false可以加快接口响应速度)
      search_query_info Map 是 查询条件
        limit Int 是 分页条数(最大值为100)
        offset Int 是 偏移量(从0开始、数值必须为limit的整数倍)
        filters List 是 过滤条件列表
          field_name String 是 字段名
          field_values List[String] 是 字段值
          operator String 是 操作符,详细见下方[operator参数说明]
        orders List 是 查询条件
          fieldName String 是 字段名
          isAsc Boolean 是 是否升序(如果是true,按照升序排列,如果是false,则按照倒序排列)
        fieldProjection List[String] 是 返回字段列表,取值对象字段中的apiName

    # operator参数说明

    参数 参数含义 说明 参数 参数含义 说明
    EQ 等于 N 不等于 可以查出空值
    GT 大于 GTE 大于等于
    LT 小于 LTE 小于等于
    LIKE 包含 NLIKE 不包含
    IS 为空 ISN 不为空
    IN 属于 NIN 不属于
    BETWEEN 介于 NBETWEEN 不介于
    STARTWITH 开始于 ENDWITH 结束于
    HASANYOF 有重叠元素 NHASANYOF 没有重叠

    # 请求示例

    {
      "corpAccessToken": "{corpAccessToken}",
      "currentOpenUserId": "{currentOpenUserId}",
      "corpId": "{corpId}",
      "data": {
        "find_explicit_total_num": true,
        "search_query_info": {
          "offset": 0,
          "limit": 1,
          "orders": [
            {
              "fieldName": "create_time",
              "isAsc": true
            }
          ],
          "fieldProjection": [
            "name"
          ],
          "filters": [
            {
              "operator": "EQ",
              "field_name": "name",
              "field_values": [
                "603dabc14ae65400011aec90"
              ]
            }
          ]
        },
        "dataObjectApiName": "CampaignMembersObj"
      }
    }
    

    # 返回参数

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

    # 返回示例

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    作废预设对象
    修改预设对象

    ← 作废预设对象 修改预设对象 →

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