联系人模块
- 2021-07-28 09:19:06
- 王于听
- 2606
- 最后编辑：刘若谷 于 2021-08-09 17:30:14
- 分享链接
一、获取联系人列表
请求地址：GET /api.php/v1/crm/contacts
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | all |
all:所有联系人 contactedby：由我联系的联系人 past：亟需联系的联系人 today：今天联系的联系人 tomorrow：明天联系的联系人 thisweek：本周内联系的联系人 thismonth：本月内联系的联系人 |
| orderBy |
否 |
t1.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/contacts/' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| contacts | object | 联系人列表 |
| customers | object | 客户名称列表 |
| pager | object | 分页信息 |
| status | string | 联系人状态 |
| mode | string |
筛选条 件
all:所有联系人 contactedby：由我联系的联系人 past：亟需联系的联系人 today：今天联系的联系人 tomorrow：明天联系的联系人 thisweek：本周内联系的联系人 thismonth：本月内联系的联系人
|
| orderBy | string |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
二、获取联系人详情
请求地址：GET /api.php/v1/crm/contacts/: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/contacts/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| contact | object | 联系人信息 |
| products | object | 产品名称列表 |
| order | object | 关联订单信息 |
| customers | object | 所属客户信息 |
| contract | object | 关联合同信息 |
| users | object | 相关用户名 |
| currencyList | object |
货币类型 |
| currencySign | object | 货币符号 |
|
appOperate |
array | 移动端所属该订单的动作 |
三、创建联系人信息
请求地址：POST /api.php/v1/crm/contacts
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| realanme | 是 | string | 真实姓名 |
| customer | 是 | int | 所属客户 |
|
gender |
否 | string |
性别 |
| maker |
否 |
bool |
是否为决策人 |
|
title |
否 |
string |
职位 |
| birthday |
否 |
date |
生日 |
| mobile |
否 |
string | 手机 |
| phone | 否 |
string |
座机 |
| weixin | 否 |
string |
微信 |
| 否 | string | 邮箱 | |
| 否 | string | ||
| skype | 否 | string | Skype |
| desc | 否 | string | 简介 |
|
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/contacts' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"realname": "联系人名称", "customer": "1"}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=contact&f=browse&t=",
"contactID": "1"
}
}
返回结果(400)：
{
"error": errorMessage
}
四、修改联系人信息
请求地址：PUT /api.php/v1/crm/contacts/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| realanme | 是 | string | 真实姓名 |
| customer | 是 | int | 所属客户 |
|
gender |
否 | string |
性别 |
| maker |
否 |
bool |
是否为决策人 |
|
title |
否 |
string |
职位 |
| birthday |
否 |
date |
生日 |
| mobile |
否 |
string | 手机 |
| phone | 否 |
string |
座机 |
| weixin | 否 |
string |
微信 |
| 否 | string | 邮箱 | |
| 否 | string | ||
| skype | 否 | string | Skype |
| desc | 否 | 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/contacts/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"realname": "修改后的联系人名称"}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=contact&f=view&t=&contactID=1"
}
}
返回结果(400):{
"error": errorMessage
}
