open-api
首页
open-api
  • 快速开始
  • 授权登录
  • 客户
    • 客户
    • 客户列表GET
    • 跟进动态查询接口GET
    • 提交跟进动态POST
    • 客户分组新增/编辑POST
    • 删除客户分组POST
    • 客户阶段新增/编辑POST
    • 删除客户阶段POST
    • 客户标签新增/编辑POST
    • 删除客户标签POST
    • 客户枚举:客户类型,客户标签,时区,规模,星级,采购意向,采购额度,职级GET
    • 客户数据字典GET
    • 客户(含联系人)新增/编辑POST
    • 删除客户(仅支持公海客户)POST
    • 客户详情GET
    • 查询客户的阶段、分组、状态、地区、主营产品、来源GET
  • 销售订单
  • 采购订单
  • 产品
  • 回款登记
  • 回款单
  • 付款单
  • 费用单
  • 报价单
  • 供应商
  • 商机
  • 用户
  • 销售出库单
  • 库存
  • 线索
  • 资金
  • 采购入库单
  • 采购退货单
  • 统计分析
  • 示例接口(勿用)
  • 阿里账号信息GET
  • 阿里资金账户信息GET
亮色模式
  1. 客户

客户(含联系人)新增/编辑

POST/v1/company/pushCompanyAndCustomers
异常码 异常消息 异常解决方案
404 Not Found Resource 检查传入company_id是否有误
404 No Privilege 检查传入user_id是否是私海客户的跟进人

请求参数

Header 参数
Authorization
string 
必需
示例值:
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMWMxMzU5NmRlMGJjYzM1MzRlYTIxMWEyMTE0MTdjODcxZjMzZGVjNjVmMzE1MDcxM2EwMTE5N2I0NGJlODY2NDM0YWFmYjczZmI0ZWIwYiIsImp0aSI6ImU4MjllNmU5N2FjOWE0ZmQxYjdmOTQ4ZmMwOTE0ZTZkMjkxZWU4Zjg5NjczYzk0NDEyMWE5NjVhNTAxZDdkMmM5NTVmZTBiMzdlMjUyM2Y4IiwiaWF0IjoxNjg2ODAyNDI1LjMwMzk3MiwibmJmIjoxNjg2ODAyNDI1LjMwMzk3MywiZXhwIjoxNjg2ODMxMjI1LjI5MzgwOSwic3ViIjoiIiwic2NvcGVzIjpbInByb2R1Y3QiLCJjb21wYW55IiwiaW52b2ljZXMiLCJsZWFkIiwib3Bwb3J0dW5pdHkiLCJ1c2VyIiwic3VwcGxpZXIiLCJ3YXJlaG91c2UiLCJyZXBvcnQiXX0.jllCo8AVbZuMumrSAHkiL7a3QBhagiHWn_CjLbGhz60WOhGQytZ5xsWZ04z34vgT1bW5LJvnpWQ90c4Tyk4smzXAL6KfabQUTl8_RAnrKpNXdxPQOuQWjqxHzNdtf8VR0TjSNw0yHVmL5MN_XoCQvl_a2PfW7MbcoUJJld7yrxMbFQhl5-ct0QfavvBNifJ-jIp_O7w9PjJ8V7FoV-OmogFhC-YwBxPZBOePVT-OoAmgLtdbWXh-PasrXvd7lusB8o7tUcDyaBpkfgOwP8L6k7oNn-OjOnR6iXQzRRvlXxIfs6v3CiV75WVBINs5lgyCQ8ZOTJbnXYBgCOW5iLDfZw
Body 参数application/json
company_id
integer 
公司客户ID
可选

编辑时需要设置
值来自于/v1/company/list接口

user_id
integer 
跟进人
可选

不填则默认为创建人
值来自于/v1/user/list接口

batch_user_ids
array[integer]
批量新增跟进人
可选

eg: [11, 22]
值来自于/v1/user/list接口

remove_user_id
array[integer]
删除跟进人
可选

eg: [33, 44]
值来自于/v1/user/list接口

is_public
integer 
客户类型
可选

私海客户is_public=0;公海客户is_public=1;默认is_public=0

serial_id
string 
客户编号
可选

可选字段,不设置默认生成

name
string 
公司名称
必需
short_name
string 
公司简称
可选
country
string 
国家/地区
可选

非必填,ISO两位码

province
string 
省
可选

对接需要询问对接协助开发获取省枚举

city
string 
市
可选

对接需要询问对接协助开发获取市枚举

tel_area_code
string 
座机区号
可选
tel
string 
座机号码
可选
fax
string 
传真
可选
group_id
integer 
客户分组
可选

可选字段,从分组v1/company/fields/selector?field=group_id选择

pool_id
integer 
客户公海分组
可选

必填,不确定可设置为0,代表未分组,从v1/company/fields/selector?field=pool_id选择

origin_list
array[string]
客户来源ID列表
可选

可选字段,从v1/company/fields/selector?field=origin选择

trail_status
integer 
客户阶段
可选

可选字段,从v1/company/fields/selector?field=trail_status选择

biz_type
integer 
客户类型 值来自于/v1/company/companyEnums 接口
可选

可选字段
值来自/v1/company/companyEnums接口

cus_tag
array[integer]
客户标签 值来自于/v1/company/companyEnums 接口
可选

非必填
值来自/v1/company/companyEnums接口

address
string 
客户地址
可选

可选字段

remark
string 
备注
可选

可选字段

homepage
string 
公司主页网址
可选

可选字段

star
integer 
客户星级
可选

可选字段,1-5之间

intention_level
integer 
采购意向
可选

0未知,1低,2中,3高

annual_procurement
integer 
年采购额
可选

0: 无采购额
1: 0~1千美元
2: 1千~5千美元
3: 5千~1万美元
4: 1万~3万美元
5: 3万~5万美元
6: 5万~10万美元
7: 10万~30万美元
8: 30万~50万美元
9: 50万~100万美元
10: 100万~500万美元
11: 500万美元以上

timezone
integer 
时区 值来自于/v1/company/companyEnums 接口
可选

非必填

scale_id
integer 
规模 值来自于/v1/company/companyEnums 接口
可选

1:少于59人,2:60-149人,3:150-499人,4:500-999人,5:1000-4999人,6: 5000人以上

image_list
array[object (图片对象) {6}] 
公司logo
可选

非必填,example: ['xx1', 'xx2']

file_id
integer 
图片文件ID
可选
file_name
string 
文件名称
可选
bucket
string 
可选
file_key
string 
可选
file_path
string 
可选
file_preview_url
string 
可选
next_follow_up_time
string 
下次跟进时间
可选

非必填

category_ids
array [array] 
主营产品
可选

非必填,example: [[1, 2, 3], [4, 5, 6]]

integer 
可选
product_group_ids
array[integer]
产品分组
可选

非必填,example: [1, 2]

customers
array [object {19}] 
客户联系人列表
必需
customer_id
integer 
客户联系人ID
可选

编辑时需要设置

name
string 
昵称
可选
email
string 
联系人邮箱
可选
tel
string 
电话号码
可选
tel_area_code
string 
电话号码区号
可选
post_grade
integer 
职级
可选
post
string 
职位
可选
qq
string 
QQ账号
可选
linkedin
string 
LinkedIn账号
可选
skype
string 
Skype账号
可选
whatsapp
string 
WhatsApp账号
可选
facebook
string 
Facebook账号
可选
wechat
string 
微信账号
可选
twitter
string 
Twitter账号
可选
birth
string 
生日
可选
gender
integer 
性别
可选

1男,2女

remark
string 
联系人备注
可选
main_customer_flag
integer 
是否主要联系人
可选

0=不是,1=是主要联系人

image_list
array[object (图片对象) {6}] 
头像列表
可选

example: ['xx1', 'xx2']

示例
{
    "company_id": 0,//新建时不需要传递,或者传0
    "user_id": 11858713,//跟进人ID
    "batch_user_ids": [
        0
    ],//批量增加跟进人ID
    "remove_user_id": [
        0
    ],//移除跟进人ID
    "is_public": 0,
    "serial_id": "O1234",//客户编号
    "name": "小满科技0310",//客户名称
    "short_name": "客户简称",//客户简称
    "country": "CN",
    "province": "陕西省",
    "city": "西安市",
    "tel_area_code": "86",//区号
    "tel": "1233435",
    "fax": "2345445",//传真
    "group_id": 0,//客户分组ID
    "pool_id": 0,//公海分组ID
    "origin_list": [14],//来源ID列表
    "trail_status": 0,//客户阶段ID
    "biz_type": 2,//客户类型 来自客户枚举接口
    "cus_tag": [
        0
    ],//客户标签 来自客户枚举接口
    "address": "地址",//详细地址
    "remark": "备注",//客户备注
    "homepage": "asdfasdft.com",
    "star": 4,//客户星级 来自客户枚举接口
    "intention_level": 1,//采购意向 来自客户枚举接口
    "annual_procurement": 0,//年采购额 来自客户枚举接口
    "timezone": 5,//时区 来自客户枚举接口
    "scale_id": 2,//规模 来自客户枚举接口
    "image_list": [
    ],
    "next_follow_up_time": "2025-03-03 00:00:00",//下次跟进时间
    "category_ids": [
        [
            3
        ]
    ],//主营产品ID
    "product_group_ids": [
        5005524937
    ],//产品分组ID
    "customers": [
        {
            "customer_id": 0,///新建时不需要传递,或者传0
            "name": "联系人昵称0310",//联系人名称
            "email": "lianxirennicheng303@163.com",//联系人邮箱
            "tel": "12323242345",
            "tel_area_code": "86",
            "post_grade": 2,//职级
            "post": "职位",//职位
            "qq": "234354346",
            "linkedin": "345346457",
            "skype": "436456657",
            "whatsapp": "23463457567",
            "facebook": "sadfery34546",
            "wechat": "wer647",
            "twitter": "striwwe56ng",
            "birth": "2025-03-13",
            "gender": 1,//性别 男1 女
            "remark": "联系人备注",//联系人备注
            "main_customer_flag": 0,//是否是主联系人 1:是 0:否
            "image_list": [
            ]
        }
    ]
}

示例代码

返回响应

成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer 
必需
message
string 
必需
now
string 
必需
data
object 
必需
company_id
integer 
客户ID
必需
customers
array [object {3}] 
必需
示例
{
  "code": 200,
  "message": "success",
  "now": "2025-03-05 17:20:53",
  "data": {
    "company_id": 5203222129,
    "customers": [
      {
        "customer_id": 5203222125,
        "name": "李四",
        "email": "lisi@163.com"
      }
    ]
  }
}
最后修改时间: 3 个月前