获取自定义字段列表

最后更新:2024/09/04

企业可通过此接口,根据模块类型,拉取自定义字段列表

请求方式: GET(HTTPS)

请求地址: https://open.wshoto.com/openapi/customfield/info/list

参数说明:

参数 类型 必填 说明
access_token string 调用接口凭证
module_key string 模块类型:
clue:线索、order:订单、company:企业、customer:客户、returned:回款、opportunity:商机、selfgoods:自定义商品/服务、qrcode:活码、follow:跟进、product:产品、collect_form:收集表
template_id long 模版id:多模板的模块适用。module_key为product:产品时,需传入产品类型id参数。为collect_form:收集表时,需传入模版id参数。

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": [
    {
      "field_id": 1506169541301231617,
      "field_key": "name",
      "field_name": "昵称",
      "type": 14,
      "required_flag": 1,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169541380923394,
      "field_key": "source",
      "field_name": "客户来源",
      "type": 14,
      "required_flag": 1,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169541561278466,
      "field_key": "remarkName",
      "field_name": "备注名",
      "type": 1,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169539975831553,
      "field_key": "label",
      "field_name": "标签",
      "type": 15,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169537798987777,
      "field_key": "description",
      "field_name": "描述",
      "type": 2,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169540110049282,
      "field_key": "accessCustomerChannel",
      "field_name": "获客渠道",
      "type": 6,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": [
        {
          "id": 1506169540307181570,
          "name": "广告投放",
          "children": []
        },
        {
          "id": 1506169540428816386,
          "name": "市场活动",
          "children": []
        },
        {
          "id": 1506169540592394241,
          "name": "官网",
          "children": []
        },
        {
          "id": 1506169540693057537,
          "name": "销售自拓",
          "children": []
        },
        {
          "id": 1506169540827275265,
          "name": "转介绍",
          "children": []
        },
        {
          "id": 1506169540961492994,
          "name": "展会",
          "children": []
        },
        {
          "id": 1506169541028601857,
          "name": "投招标",
          "children": []
        }
      ]
    },
    {
      "field_id": 1506169538193252353,
      "field_key": "companyName",
      "field_name": "企业名称",
      "type": 14,
      "required_flag": 1,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169538323275778,
      "field_key": "corpShortName",
      "field_name": "企业简称",
      "type": 14,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169536897212417,
      "field_key": "mobilePhone",
      "field_name": "手机号码",
      "type": 11,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169537153064962,
      "field_key": "email",
      "field_name": "邮箱",
      "type": 13,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": []
    },
    {
      "field_id": 1506169537547329537,
      "field_key": "area",
      "field_name": "地区",
      "type": 17,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 0,
      "params": []
    },
    {
      "field_id": 1506169537643798530,
      "field_key": "address",
      "field_name": "详细地址",
      "type": 1,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": []
    },
    {
      "field_id": 1506169537283088385,
      "field_key": "gender",
      "field_name": "性别",
      "type": 16,
      "required_flag": 1,
      "readonly_flag": 1,
      "support_delete": 0,
      "params": [
        {
          "id": 1504001780823179265,
          "name": "男",
          "children": []
        },
        {
          "id": 1504001780974174209,
          "name": "女",
          "children": []
        }
      ]
    },
    {
      "field_id": 1506169537425694722,
      "field_key": "birthday",
      "field_name": "生日",
      "type": 7,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": []
    },
    {
      "field_id": 1506169553598930951,
      "field_key": "mf_customer_52",
      "field_name": "自定义字段54838",
      "type": 4,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": [
        {
          "id": 1506184749108981761,
          "name": "选项1",
          "children": []
        },
        {
          "id": 1506184749129953282,
          "name": "选项2",
          "children": []
        }
      ]
    },
    {
      "field_id": 1506169553598930952,
      "field_key": "mf_customer_53",
      "field_name": "自定义字段08788",
      "type": 5,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": [
        {
          "id": 1506184749390000130,
          "name": "选项1",
          "children": []
        },
        {
          "id": 1506184749406777346,
          "name": "选项2",
          "children": []
        }
      ]
    },
    {
      "field_id": 1506169553598930954,
      "field_key": "mf_customer_55",
      "field_name": "自定义字段50499",
      "type": 4,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": [
        {
          "id": 1506184749968814082,
          "name": "选项1",
          "children": []
        },
        {
          "id": 1506184749985591298,
          "name": "选项2",
          "children": []
        }
      ]
    },
    {
      "field_id": 1506169553544404993,
      "field_key": "mf_customer_1",
      "field_name": "测试企业",
      "type": 1,
      "required_flag": 0,
      "readonly_flag": 1,
      "support_delete": 1,
      "params": []
    },
    {
      "field_id": 1506169553607319558,
      "field_key": "mf_customer_56",
      "field_name": "自定义字段11874",
      "type": 6,
      "required_flag": 0,
      "readonly_flag": 0,
      "support_delete": 1,
      "params": [
        {
          "id": 1513807711874088961,
          "name": "分类1",
          "children": [
            {
              "id": 1513807711874088962,
              "name": "分类1",
              "children": []
            },
            {
              "id": 1513807711874088963,
              "name": "分类2",
              "children": []
            },
            {
              "id": 1513807711874088964,
              "name": "分类3",
              "children": [
                {
                  "id": 1513807711874088965,
                  "name": "分类1",
                  "children": []
                },
                {
                  "id": 1513807711874088966,
                  "name": "分类2",
                  "children": []
                },
                {
                  "id": 1513807711874088967,
                  "name": "分类3",
                  "children": []
                }
              ]
            }
          ]
        },
        {
          "id": 1513807711874088968,
          "name": "分类2",
          "children": []
        }
      ]
    }
  ]
}

返回说明:

参数 类型 说明
code int 出错返回码,为0表示成功,非0表示调用失败
msg string 返回码描述
data ListFieldByModuleKeyResponse[] 自定义字段信息
  field_id long 自定义字段id
  field_key string 自定义字段Key
  field_name string 自定义字段Name
  type int 自定义字段类型 0:系统默认;1:单行文本;2:多行文本;3:数字;4:单选;5:多选;6:级联;7:日期;8:日期时间;9:时间;10:附件;11:手机号码;12:座机/手机号码;13:邮箱;14:关联;15:标签;16:单选radio
  required_flag int 是否必填 0.否 1.是
  readonly_flag int 是否允许编辑 0.是 1.否
  support_delete int 是否允许删除 0.否 1.是
  params Param[] params参数,级联;多选等自定义字段有此参数
    id long 参数字段的id
    name string 参数字段的名称
    children Param[] 含有子集

results matching ""

    No results matching ""