联系人模块

2021-07-28 09:19:06
王于听
684
最后编辑:刘若谷 于 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
微信
email string 邮箱
qq string QQ
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
微信
email string 邮箱
qq string QQ
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
}
发表评论
评论通过审核后显示。