1.1 接口说明

第三方系统调用此接口查询客户自定义字段,为6.3新增客户信息、6.5编辑客户信息 等操作使用。

1.2 调用形式

https://ykf.uincall.com/openapi/customer/custom_field/query?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=9a9c642d9fe9483592c3bcfc839xxxxx

1.3 调用方式

GET

1.4 传入参数

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 状态码:0成功,及其他非0错误码,详见错误码列表
2 errmsg String 状态说明
3 data Object对象 结果集
3.1 id String 自定义字段id
3.2 display String 显示名称(WEB端,设置自定义字段使用),用于6.3新增客户信息、6.5编辑客户信息
3.3 kind Int 自定义字段类型:
0-自定义单行文本
1-自定义多行文本
2-自定义单选
3-自定义多选
4-下拉列表
两种场景:关联字典、不关联字典;
5-自定义日期
6-自定义日期时间
7-自定义数字
3.4 dictId String 关联字典ID(kind = 4,下拉列表类型使用)
3.5 items Json 关联字典后的字典结构选项json,参考7.1 查询字典数据 items字典结构体;
3.6 options Json 选项,json数据类型,kind=2 / 3 / 4 时使用场景。如:
“options”: {“items”: [{“val”: “套餐一”,”id”: 1627029099569},{“val”: “套餐二”,”id”: 1627029112113},{“val”: “套餐三”, “id”: 1627029113985}]}
说明:
1、val值用于6.3新增客户信息、6.5编辑客户信息 自定义字段kind类型为2 或 3、4(下拉列表->不关联字典场景)时value字段赋值使用;
3.7 is_dict boolean 是否关联字典,false / true

1.6 使用样例

调用:

url:https://ykf.uincall.com/openapi/customer/custom_field/query?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=9a9c642d9fe9483592c3bcfc839xxxxx

GET请求类型,无请求体;

响应:

{
    "errcode": 0,
    "errmsg": "success",
    "data": [
        {
            "id": "0371e66695b1aa501ad86ad536d63598",
            "display": "自定义单行文本",
            "kind": 0,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "",
                        "id": 1698808115756
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "141784f68c692f5e403b3f13e898b883",
            "display": "自定义多行文本",
            "kind": 1,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "",
                        "id": 1627029048449
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "658c205ddb4b2c512918276588330ad9",
            "display": "单选-人口",
            "kind": 2,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "三口之家",
                        "id": 1696647738988
                    },
                    {
                        "val": "四口之家",
                        "id": 1696647924062
                    },
                    {
                        "val": "二口之家",
                        "id": 1696647930612
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "4c3a4b44c82c186a26f95f99e3072d01",
            "display": "自定义多选",
            "kind": 3,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "套餐一",
                        "id": 1627029099569
                    },
                    {
                        "val": "套餐二",
                        "id": 1627029112113
                    },
                    {
                        "val": "套餐三",
                        "id": 1627029113985
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "26d713fb3bf4ad4edd5f476e2b84e6cf",
            "display": "不关联字典下拉框",
            "kind": 4,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "不关联字典选项1",
                        "id": 1637891606819
                    },
                    {
                        "val": "不关联字典选项2",
                        "id": 1637891629403
                    },
                    {
                        "val": "不关联字典选项3",
                        "id": 1637893309170
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "1cb8c2d7dfd3c5c72c127f2e684a43ec",
            "display": "下拉框-多级字典",
            "kind": 4,
            "dictId": "208e92c8395a4e229c21e48e535d083a",
            "items": [
                {
                    "id": "6a64ce5e76584558bbf5949298da1ff4",
                    "item": "无法启动",
                    "level": "0",
                    "seq": 0,
                    "childs": [],
                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                    "parent_id": "",
                    "createTime": null
                },
                {
                    "id": "208e64bd96e9491ca8b92c0de6f7543b",
                    "item": "不出风",
                    "level": "0",
                    "seq": 1,
                    "childs": [
                        {
                            "id": "f88baa61acf44829aa14b0f16444fb2c",
                            "item": "2.2 电路板损坏",
                            "level": "1",
                            "seq": 0,
                            "childs": [
                                {
                                    "id": "d5ac5c75eab24f0a9740fc8a8c184277",
                                    "item": "2.2.1 电路板 电阻元件损坏",
                                    "level": "2",
                                    "seq": 0,
                                    "childs": [],
                                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                                    "parent_id": "f88baa61acf44829aa14b0f16444fb2c,
                                    "createTime": null
                                }
                            ],
                            "dict_id": "208e92c8395a4e229c21e48e535d083a",
                            "parent_id": "208e64bd96e9491ca8b92c0de6f7543b",
                            "createTime": null
                        }
                    ],
                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                    "parent_id": "",
                    "createTime": null
                },
                {
                    "id": "871ef40b2cfd47c4b1507842c3c9a299",
                    "item": "不制热",
                    "level": "0",
                    "seq": 2,
                    "childs": [],
                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                    "parent_id": "",
                    "createTime": null
                },
                {
                    "id": "49301b96f88a4214948e832e6129bde4",
                    "item": "不通电",
                    "level": "0",
                    "seq": 3,
                    "childs": [
                        {
                            "id": "9428757ee65d4eaf8c528b6a3a70c2b7",
                            "item": "电源线坏",
                            "level": "1",
                            "seq": 0,
                            "childs": [
                                {
                                    "id": "053f4ca1867b46d6998b40af72cb38d2",
                                    "item": "001",
                                    "level": "2",
                                    "seq": 0,
                                    "childs": [],
                                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                                    "parent_id": "9428757ee65d4eaf8c528b6a3a70c2b7,
                                    "createTime": null
                                },
                                {
                                    "id": "0e15204fc9274f84a1c83d4808e5f478",
                                    "item": "002",
                                    "level": "2",
                                    "seq": 1,
                                    "childs": [],
                                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                                    "parent_id": "9428757ee65d4eaf8c528b6a3a70c2b7,
                                    "createTime": null
                                }
                            ],
                            "dict_id": "208e92c8395a4e229c21e48e535d083a",
                            "parent_id": "49301b96f88a4214948e832e6129bde4",
                            "createTime": null
                        },
                        {
                            "id": "6d5bf82d2de44431933ccb78ea317933",
                            "item": "开关损坏",
                            "level": "1",
                            "seq": 1,
                            "childs": [],
                            "dict_id": "208e92c8395a4e229c21e48e535d083a",
                            "parent_id": "49301b96f88a4214948e832e6129bde4",
                            "createTime": null
                        }
                    ],
                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                    "parent_id": "",
                    "createTime": null
                },
                {
                    "id": "0b2eaa2de25e44e48e25cd24484b52c9",
                    "item": "异味",
                    "level": "0",
                    "seq": 4,
                    "childs": [],
                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                    "parent_id": "",
                    "createTime": null
                },
                {
                    "id": "b16c3469a93040bb939afb7219287d9c",
                    "item": "故障代码",
                    "level": "0",
                    "seq": 5,
                    "childs": [],
                    "dict_id": "208e92c8395a4e229c21e48e535d083a",
                    "parent_id": "",
                    "createTime": null
                }
            ],
            "options": {
                "items": [
                    {
                        "val": "",
                        "id": 1697614316385
                    }
                ]
            },
            "is_dict": true
        },
        {
            "id": "b10266037411a738b7aaad863a30180f",
            "display": "自定义日期",
            "kind": 5,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "",
                        "id": 1627029138282
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "fa008850192b20eaed91c5385fe155ed",
            "display": "自定义日期时间",
            "kind": 6,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "",
                        "id": 1627029147370
                    }
                ]
            },
            "is_dict": false
        },
        {
            "id": "2188500cd17a2416ba01a9be088e91ca",
            "display": "自定义数字",
            "kind": 7,
            "dictId": "",
            "items": [],
            "options": {
                "items": [
                    {
                        "val": "",
                        "id": 1627349281002
                    }
                ]
            },
            "is_dict": false
        }
    ]
}
文档更新时间: 2023-11-14 14:03   作者:admin