客户新增

POST

http://prod-cn.your-api-server.com/api/open/customer/customer-manage/v1/customer

最后修改时间：2023-11-06 03:21:48

责任人：未设置

请求参数

Query 参数

project

string

项目id

必需

示例值:

371344636432453

instance

string

实例

可选

Header 参数

Authorization

string

可选

默认值:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXJ2ZXIiOmZhbHNlLCJzdWIiOiIxNzQzMDg0NTg3MjY0ODE5MjAxIiwiZmxhZyI6NiwiY2xpZW50VHlwZSI6bnVsbCwidXNlcl9uYW1lIjoiMTM3NjIyMzIwMDciLCJzY29wZSI6WyJzZXZlciJdLCJuYW1lIjoiMTM3NjIyMzIwMDciLCJleHAiOjE3MjA1OTcyMzAsImp0aSI6ImE5NjIxN2NiLTBiZDUtNGE1YS1iNmMzLWY1YTVlMjY3ZDIyMSIsInRlbmFudCI6InQxNzQzMDg0NTg3Mjc3NDAyMTEzIiwiY2xpZW50X2lkIjoic3lzIn0.5UPL14t8CI7oySNuurTwkWaob9HstDEILr6bpWb16QU

Body 参数application/json

name

string <string>

客户名称

必需

客户名称Validate[max: 20; ]

phone

string <string>

客户电话

必需

电话
Validate[max: 15; ]

idType

integer <int32>

证件类型

可选

证件类型，0：代表空，1：身份证，2：护照，3：港澳通行证，4：其他

示例值:

idNumber

string <string>

证件号码

可选

证件号码
Validate[max: 45; ]

sex

integer <int32>

性别

可选

性别，0：代表未填，1：男，2：女

示例值:

age

integer <int32>

年龄

可选

年龄

示例值:

customerGradeId

number <int64>

客户级别

可选

客户级别ID

示例值:

customerTypeId

number <int64>

客户类型

可选

客户类型ID

示例值:

contractName

string <string>

紧急联系人

可选

紧急联系人
Validate[max: 50; ]

contractPhone

string <string>

紧急联系人电话

可选

紧急联系人电话
Validate[max: 15; ]

address

string <string>

客户地址

可选

地址
Validate[max: 50; ]

string <string>

邮箱地址

可选

邮箱
Validate[max: 50; ]

remark

string <string>

备注

可选

备注
Validate[max: 100; ]

bornDate

number <int64>

出生年月

可选

出生年月

示例值:

nativePlace

string <string>

籍贯

可选

籍贯
Validate[max: 20; ]

nation

string <string>

名族

可选

名族
Validate[max: 20; ]

marriage

integer <int32>

婚姻

可选

婚姻，0：代表未填空，1：未婚，2：已婚，3：离婚，4：丧偶

示例值:

education

integer <int32>

学历

可选

学历，0：代表未填空，1：小学，2：初中，3：中专/高中，4：专科，5：本科，6：硕士，7：博士

示例值:

profession

string <string>

职业

可选

职业
Validate[max: 20; ]

speciality

string <string>

特长

可选

特长
Validate[max: 20; ]

interest

string <string>

兴趣爱好

可选

兴趣爱好
Validate[max: 20; ]

character

string <string>

性格

可选

性格
Validate[max: 20; ]

postalCode

string <string>

邮政编码

可选

邮政编码
Validate[max: 20; ]

companyIds

array[number]

所属企业

可选

关联企业ids

示例值:

0,0

jobNum

string <string>

员工工号

可选

员工工号
Validate[max: 20; ]

facePhoto

string <string>

人脸识别

可选

人脸识别
Validate[max: 255; ]

managementFormsId

number <int64>

经营状态

可选

经营状态id

示例值:

示例

{
  "name": "张三",
  "phone": "152321523",
  "idType": 1,
  "idNumber": "145266654412554145",
  "sex": 1,
  "age": "12",
  "customerGradeId": "11519321959776512",
  "customerTypeId": "11141326891967362",
  "contractName": "李四",
  "contractPhone": "1525632541",
  "address": "达实大厦",
  "email": "123@qq.com",
  "remark": "备注说明",
  "bornDate": 1698973477978,
  "nativePlace": "广东省",
  "nation": "汉族",
  "marriage": 1,
  "education": 5,
  "profession": "无",
  "speciality": "无",
  "interest": "无",
  "character": "无",
  "postalCode": "123456",
  "companyIds": [
    "11642265607513746"
  ],
  "jobNum": "1234",
  "facePhoto": "business/t371677589594/customer-management/111055iilOMurpsWi6JVIlO.png",
  "managementFormsId": "1163548504984403"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/api/open/customer/customer-manage/v1/customer?project=371344636432453&project=&instance=' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXJ2ZXIiOmZhbHNlLCJzdWIiOiIxNzQzMDg0NTg3MjY0ODE5MjAxIiwiZmxhZyI6NiwiY2xpZW50VHlwZSI6bnVsbCwidXNlcl9uYW1lIjoiMTM3NjIyMzIwMDciLCJzY29wZSI6WyJzZXZlciJdLCJuYW1lIjoiMTM3NjIyMzIwMDciLCJleHAiOjE3MjA1OTcyMzAsImp0aSI6ImE5NjIxN2NiLTBiZDUtNGE1YS1iNmMzLWY1YTVlMjY3ZDIyMSIsInRlbmFudCI6InQxNzQzMDg0NTg3Mjc3NDAyMTEzIiwiY2xpZW50X2lkIjoic3lzIn0.5UPL14t8CI7oySNuurTwkWaob9HstDEILr6bpWb16QU' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "张三",
  "phone": "152321523",
  "idType": 1,
  "idNumber": "145266654412554145",
  "sex": 1,
  "age": "12",
  "customerGradeId": "11519321959776512",
  "customerTypeId": "11141326891967362",
  "contractName": "李四",
  "contractPhone": "1525632541",
  "address": "达实大厦",
  "email": "123@qq.com",
  "remark": "备注说明",
  "bornDate": 1698973477978,
  "nativePlace": "广东省",
  "nation": "汉族",
  "marriage": 1,
  "education": 5,
  "profession": "无",
  "speciality": "无",
  "interest": "无",
  "character": "无",
  "postalCode": "123456",
  "companyIds": [
    "11642265607513746"
  ],
  "jobNum": "1234",
  "facePhoto": "business/t371677589594/customer-management/111055iilOMurpsWi6JVIlO.png",
  "managementFormsId": "1163548504984403"
}'

返回响应

🟢200成功

application/json

Body

string

客户id

可选

示例

"1168914638644846591"

🟠400400响应结构

获取空间列表

分页查询客户信息