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

    # 请求参数

    参数 类型 是否必填 说明
    corpAccessToken String 是 corpAccessToken(通过获取token接口 (opens new window)返回)
    corpId String 是 corpId(通过获取token接口 (opens new window)返回)
    currentOpenUserId String 是 currentOpenUserId(通过根据手机号查询员工接口 (opens new window)返回)
    triggerApprovalFlow Boolean 否 是否触发审批流(是否触发审批流(不传时默认为true, 表示触发),该参数对所有对象均有效)
    triggerWorkFlow Boolean 否 是否触发工作流(是否触发工作流(不传时默认为true, 表示触发),该参数对所有对象均有效)
    hasSpecifyTime Boolean 否 是否可传创建时间(不传时默认为false,表示忽略参数中的create_time创建时间字段)
    hasSpecifyCreatedBy Boolean 否 创建人(不传时默认为false,表示忽略参数中的created_by创建时间字段)
    includeDetailIds Boolean 否 是否包括主从对象(主从对象一起创建时,是否返回从对象id列表,true返回,false不返回,默认不返回)
    data Map 是 数据Map
      igonreMediaIdConvert Boolean 否 文件路径类型:文件路径为npath(以N_开头)时传true;否则传false,不传时默认为true
      object_data Map 是 对象数据
        dataObjectApiName String 是 对象apiName
        campaign_members_status String 是 参与状态
        name String 是 成员ID
        object_describe_api_name String 是 object_describe_api_name
        owner List[String] 是 负责人
        record_type String 是 业务类型
        campaign_members_type String 是 类型
        marketing_event_id String 是 市场活动名称
      details Map 否 从对象数据(key为apiName,value为数据Map)
        detail_api_name Map 是 从对象数据
      optionInfo Map 否 校验选项
        skipFuncValidate Boolean 否 跳过函数前验证
        useValidationRule Boolean 否 是否触发验证规则
        isDuplicateSearch Boolean 否 是否触发查重

    # 请求示例

    {
      "hasSpecifyTime": true,
      "includeDetailIds": true,
      "corpAccessToken": "{corpAccessToken}",
      "triggerWorkFlow": true,
      "currentOpenUserId": "{currentOpenUserId}",
      "corpId": "{corpId}",
      "data": {
        "object_data": {
          "campaign_members_status": "18",
          "owner": [
            "FSUID_xx1"
          ],
          "campaign_members_type": "18",
          "marketing_event_id": "603dabc14ae65400011aec90",
          "object_describe_api_name": "hello",
          "name": "",
          "dataObjectApiName": "CampaignMembersObj",
          "record_type": "603dabc14ae65400011aec90"
        },
        "optionInfo": {
          "skipFuncValidate": true,
          "isDuplicateSearch": true,
          "useValidationRule": true
        },
        "details": {
          "detail_api_name": {}
        },
        "igonreMediaIdConvert": false
      },
      "hasSpecifyCreatedBy": true,
      "triggerApprovalFlow": true
    }
    

    # 返回参数

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

    # 返回示例

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

    # 注意事项

    • 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
    根据手机号查询员工
    删除预设对象

    ← 根据手机号查询员工 删除预设对象 →

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