1.1 接口说明

第三方系统调用此接口添加新客户。

1.2 调用形式

https://ykf.uincall.com/openapi/customer/add?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=5526f0d1a30626b3bd2c9298fa2xxxxx

1.3 调用方式

POST

1.4 传入参数

非必填参数,调用接口时请传递参数名,参数值可为空

序号 名称 类型 是否必填 说明
1 agent_num String 归属座席编号
2 truename String 客户姓名 (最大值100)
3 nickname String 呢称信息 (最大值20)
4 level_title String 客户状态
5 mobile String 手机 (最大值20)
6 mobileDesc String 手机备注 (最大值20)
7 mail String 邮箱 (最大值100)
8 mailDesc String 邮箱备注 (最大值20)
9 wechat String 微信 (最大值20)
10 wechatDesc String 微信备注 (最大值20)
11 province String 省 (最大值20)
12 city String 市 (最大值20)
13 district String 区 (最大值20)
14 address String 地址 (最大值100)
15 summary String 备注 (最大值200)
16 source_title String 数据来源
17 tracker_id String 关联访客ID (最大值130)
18 attachments JSONObject 附件
19 website String 网站 (最大值100)
20 customer_fields JSONObject 自定义字段
1.自定义多行文本换行用\n
2.跟字典相关的字段传字典选项id,字典选项id通过7.1字典数据查询接口获取,查询租户已启用自定义字段(kind=4,下拉列表为关联字典查场景demo,参考6.12 查询客户自定义字段报文样例;
(1)、此种场景请确认value数组中各id值为字典正确顺序,若传入id与实际字典id不匹配或id顺序不匹配,则该自定义字段值如入库;例如{“name”: “下拉框-多级字典”,”value”: [“208e64bd96e9491ca8b92c0de6f7543b”,”f88baa61acf44829aa14b0f16444fb2c”,”d5ac5c75eab24f0a9740fc8a8c184277”]}

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 状态码:0成功,及其他非0错误码,详见错误码列表
2 errmsg String 状态说明
3 data Object 返回数据
3.1 customerId String 客户Id

1.6 使用样例

调用:

url:https://ykf.uincall.com/openapi/customer/add?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=5526f0d1a30626b3bd2c9298fa2xxxxx

    POST数据:
{
"agent_num": "1006",
"truename": "以逸待劳",
"nickname": "以逸待劳",
"level_title": "",
"mobile": "19000000000",
"mobileDesc": "",
"mail": "11@11.com",
"mailDesc": "",
"wechat": "789",
"wechatDesc": "",
"province": "434",
"city": "嘎嘎嘎",
"district": "342323",
"address": "123号街区",
"summary": "beizhu",
"source_title": "",
"tracker_id": "1212",
"attachments": {
    "files": []
},
"website": "我是网站",
"customer_fields": {
    "rows": [
        {
            "name": "自定义单行文本",
            "value": "自定义单行文本内容"
        },
        {
            "name": "自定义多行文本",
            "value": "我是多行文本1\n我是多行文本2\n我是多行文本3"
        },
        {
            "name": "单选-人口",
            "value": "三口之家"
        },
        {
            "name": "自定义多选",
            "value": [
                "套餐一",
                "套餐二",
                "套餐三"
            ]
        },
        {
            "name": "不关联字典下拉框",
            "value": "不关联字典选项1"
        },
        {
            "name": "下拉框-多级字典",
            "value": [
                "208e64bd96e9491ca8b92c0dxxxxxxxx",
                "f88baa61acf44829aa14b0f1xxxxxxxx",
                "d5ac5c75eab24f0a9740fc8axxxxxxxx"
            ]
        },
        {
            "name": "自定义日期",
            "value": "2023/12/2"
        },
        {
            "name": "自定义日期时间",
            "value": "2021-12-23 20:15:45"
        },
        {
            "name": "自定义数字",
            "value": 66
        }
    ]
}

}

响应:

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "customerId": "15c0a4ab14ff59583056a50362304xxx"
    }
}
文档更新时间: 2024-09-24 14:34   作者:admin