名单模块
- 2021-07-28 16:56:57
- 刘若谷
- 4031
- 最后编辑：刘若谷 于 2021-08-11 15:53:32
- 分享链接
一、获取名单列表
请求地址：GET /api.php/v1/crm/leads
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | all |
all：公共名单 assignedTo：指派给我 next：下次联系 ignoredBy：由我忽略 |
|
status |
否 |
wait |
wait：待联系 normal：正常 ignore：已忽略 |
|
origin |
否 |
空字符串 | 名单来源关键字 |
| sort |
否 |
id_desc |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
| page |
否 |
1 |
页码 |
| limit |
否 |
20 |
每页展示行数 |
|
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/leads' \ --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 | 名单列表 |
|
users |
object | 用户信息 |
| pager | object | 分页信息 |
| mode | string |
筛选条 件
all:全部订单 |
| orderBy | string |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
二、获取名单详情
请求地址：GET /api.php/v1/crm/leads/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
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/leads/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"data": {
"status": "success",
"data": {Objects}
}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
|
company |
object | 公司信息 |
|
contact |
object | 名单信息 |
|
addresses |
object | 区域信息 |
|
preAndNext |
obje ct | 上次联系与下次联系信息 |
|
fileList |
obje
ct
|
文件列表 |
|
appOperate |
array | 移动端所属动作 |
三、创建名单信息
请求地址：POST /api.php/v1/crm/leads
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| realname | 是 | string | 真实姓名 |
| origin | 是 | string | 来源 |
|
company |
否 | string | 公司 |
|
mobile |
否 |
string | 手机 |
|
phone |
否 |
string |
座机 |
|
email |
否 |
string | 邮箱 |
|
qq |
否 |
string | |
|
birthday |
否 | string | 生日 |
|
skype |
否 |
string | skype |
|
weibo |
否 | string | 微博 |
|
weixin |
否 |
string | 微信 |
|
site |
否 |
string | 网站 |
|
desc |
否 | string | 简介 |
| continue | 否 | bool | 是否跳过名称 验证 |
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
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/leads' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"realname": "姓名", "origin": "来源", "phone": "13387786173"}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=leads&f=browse&t=",
"contactID": "1"
}
}
返回结果(400)：
{
"error": errorMessage
}
四、修改名单信息
请求地址：PUT /api.php/v1/crm/leads/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
字段
必填
类型
描述
realname
是
string
真实姓名
origin
是
string
来源
company
否
string
公司
mobile
否
string
手机
phone
否
string
座机
email
否
string
邮箱
qq
否
string
QQ
birthday
否
string
生日
skype
否
string
skype
weibo
否
string
微博
weixin
否
string
微信
site
否
string
网站
desc
否
string
简介
continue
否
bool
是否跳过名称
验证
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
|
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/leads/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"realname": "姓名", "origin": "来源", "phone": "13387786173"}'
返回结果(200)：
{
"data": {
"result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=provider&f=view&t=&leadsID=44" }
}
{
"error": errorMessage
}