探马OpenAPI

个人客户导入

POST

/api/v3/import-customer

注意

客户手机号和客户姓名必传

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

qwUserId

string

员工企微userId

必需

fields

array [object {2}]

客户字段列表

必需

注意：新增客户时必须传手机号和客户姓名字段

alias

string

字段别名

必需

别名设置请参考'客户字段映射'接口

values

array[string]

字段值

必需

只有多选字段或手机号可以提供多于一个值，其他类型字段只应传一个值；不论是否单、多选字段，需要传值，而不是传值id，平台内部进行转换，如果传入的值不是可选项中的值，非法；如果级联字段按层级传入字段选项id值（查询客户字段），如["一级id","二级id","三级id"]

示例

{
    "mode": 1,
    "globalConsistency": 1,
    "qwUserId": "1234567",
    "fields": [
        {
            "alias": "gender",
            "values": ["女"]
        }, {
            "alias": "yycuid",
            "values": ["18111111115"]
        }, {
            "alias": "phone",
            "values": ["18111111125"]
        }, {
            "alias": "name",
            "values": ["api-import-customer-2"]
        }, {
            "alias": "corp_name",
            "values": ["test"]
        },
        {
            "alias": "级联字段",
            "values": ["1","2","3"]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/import-customer' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mode": 1,
    "globalConsistency": 1,
    "qwUserId": "1234567",
    "fields": [
        {
            "alias": "gender",
            "values": ["女"]
        }, {
            "alias": "yycuid",
            "values": ["18111111115"]
        }, {
            "alias": "phone",
            "values": ["18111111125"]
        }, {
            "alias": "name",
            "values": ["api-import-customer-2"]
        }, {
            "alias": "corp_name",
            "values": ["test"]
        },
        {
            "alias": "级联字段",
            "values": ["1","2","3"]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

0成功

message

string

结果说明

必需

data

number

探马内部的客户id

必需

示例

成功示例异常示例

{
    "code": 0,
    "message": "success",
    "data": 423782826326832
}

修改于 2023-04-20 06:34:22

个人待分配客户导入

企业线索导入