ZDOO API (v1) 更多

客户模块

2021-07-28 09:19:06
王于听
2354
最后编辑：刘若谷 于 2021-08-09 17:29:01
分享链接

一、获取客户列表

请求地址：GET   /api.php/v1/crm/customers

请求头HEADER： 

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

参数列表：

字段
 必填 默认值                  描述                 
mode 否 all

all:所有客户

assignedTo：指派给我的客户

contactedby：由我联系的客户

past：亟需联系的客户

today：今天联系的客户

tomorrow：明天联系的客户

thisweek：本周内联系的客户

thismonth：本月内联系的客户

public：公共客户池

orderBy 否
 id_desc

按照 "_" 字符前面的字段进行排序

desc为降序

asc 为升序

showAll
 否 yes

yes:返回所有数据和字段

no: 仅返回部分数据和字段

timeFormat

否 null

系统默认返回的日期格式:

YYYY-MM-DD HH:ii:ss

传入参数utc后返回的日期格式:

YYYY-MM-DDTHH:ii:ssZ
请求示例： 

curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/customers/' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json'

返回结果(200)： 

{
    "data": {
        "status": "success",
        "data": {Objects}
     }
}

字段
 类型 描述

title

string 页面标题
customers object 客户列表
users object 相关的用户名

areas

object 区域信息

industries

object 行业信息
pager object 分页信息
mode string

筛选条 件


all:所有客户

assignedTo：指派给我的客户

contactedby：由我联系的客户

past：亟需联系的客户

today：今天联系的客户

tomorrow：明天联系的客户

thisweek：本周内联系的客户

thismonth：本月内联系的客户

public：公共客户池


orderBy string

按照 "_" 字符前面的字段进行排序

desc为降序

asc 为升序


二、获取客户详情

请求地址：GET  /api.php/v1/crm/customers/:id

请求头HEADER： 

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

参数列表：

字段
 必填 默认值                  描述                
showAll
 否 yes

yes:返回所有数据和字段

no: 仅返回部分数据和字段

timeFormat

否 null

系统默认返回的日期格式:

YYYY-MM-DD HH:ii:ss

传入参数utc后返回的日期格式:  

YYYY-MM-DDTHH:ii:ssZ

请求示例： 

curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/customers/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json'

返回结果(200)： 

{
    "data": {
        "status": "success",
        "data": {Objects}
     }
}

字段
 类型 描述

title

string 页面标题
customer object 客户信息
issues object 履历信息
orders object 所属订单信息
conrtracts object 所属合同信息
contacts object 所属联系人信息
addresses object 所属地址信息
products object 所属产品信息
users object

用户信息

areaList object

区域信息

industryList

object

行业信息

productList array 产品信息

productCategories

object 产品类目

returnList

array 回款信息

currencySign

object 货币信息
files object 附件信息

appOperate

array 移动端所属该订单的动作


三、创建客户信息

请求地址：POST  /api.php/v1/crm/customers

请求头HEADER： 

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

请求BODY：

字段 必填 类型 描述
name 是 string 所属客户
source 否
 string 客户来源
sourceNote 否 string 来源备注
type
 否
 string 类型
size
 否
 string 规模
industry
 否
 string 行业

area

否
 string 区域
status
 否 string 状态
level
 否
 string
 级别
address
 否
 array 地址
contact
 否
 string
 联系人名称
depositor
 否
 string
 对公账户
intension
 否
 string
 购买意向
mobile
 否
 string
 联系人手机
phone
 否 string
 联系人座机
weixin
 否 string 联系人微信
email
 否 string 联系人邮箱
qq
 否 string
 联系人QQ
continue
 否 bool 是否跳过重复 验证

参数列表：


字段
 必填 默认值                  描述                 
showAll
 否 yes

yes:返回所有数据和字段

no: 仅返回部分数据和字段

timeFormat

否 null

系统默认返回的日期格式:

YYYY-MM-DD HH:ii:ss

传入参数utc后返回的日期格式:  

YYYY-MM-DDTHH:ii:ssZ

请求示例： 

curl --location --request POST 'https://biz.demo.zdoo.com/api.php/v1/crm/customers' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw  '{"name": "客户名称", "status": "potential"}'

返回结果(200)： 

{
    "data": {
        "result": "success",
        "message": "保存成功",
        "locate": "/crm/api.php?m=customer&f=browse&t=",
        "customerID": "1"
    }
}

返回结果(400)： 

{
    "error": errorMessage
}

四、修改客户信息

请求地址：PUT  /api.php/v1/crm/customers/:id

请求头HEADER： 

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

请求BODY：

字段 必填 类型 描述
name 否 string 所属客户
source 否
 string 客户来源
sourceNote 否 string 来源备注
type
 否
 string 类型
size
 否
 string 规模
industry
 否
 string 行业

area

否
 string 区域
status
 否 string 状态
level
 否
 string
 级别
depositor
 否
 string
 对公账户
intension
 否
 string
 购买意向

参数列表：



字段
 必填 默认值                  描述                 
showAll
 否 yes

yes:返回所有数据和字段

no: 仅返回部分数据和字段

timeFormat

否 null

系统默认返回的日期格式:

YYYY-MM-DD HH:ii:ss

传入参数utc后返回的日期格式:  

YYYY-MM-DDTHH:ii:ssZ

请求示例： 

curl --location --request PUT 'https://biz.demo.zdoo.com/api.php/v1/crm/customers/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \ 
--data-raw  '{"name": "修改后的客户名称"}'

返回结果(200)： 

{
    "data": {
        "result": "success",
        "message": "保存成功",
        "locate": "/crm/api.php?m=customer&f=view&t=&customerID=1"
    }
}
返回结果(400):
{
    "error": errorMessage
}
发表评论
拾 乘 捌 =
评论通过审核后显示。