[关闭]
@AliceXT 2018-02-12T23:28:48.000000Z 字数 25778 阅读 888

阅可得CRM接口说明文档

Fmnii

网站根目录http://crm.recordcrm.cn/

通用接口地址：http://crm.recordcrm.cn/api.php/

通用失败返回样例：

{"status":0,"info":"THIS_API_OR_METHOD_IS_NOT_OPEN","url":""}

说明：可能你请求的地址和方法（post,get,put,delete）不对

分页说明

增加的参数 说明
listrows 每页多少行
p 页数
返回列表中 说明
count 查询条件的总数

登录 post user/token

参数 说明
username 用户名
password 密码
jpush_uid 极光推送Jpush 设备编号registrationID，非必填，关联推动信息

请求样例

username=XXX&password=XXX&jpush_uid=xxx

成功返回样例

{
"status": 1,
"token": "8c0e191624b9d89f8e0058c0a127e98f8046",
"expire_time": 1508202481,
"user": {
    "user_id": "1",
    "name": "jackie",
    "sex": "1",
    "img": "./Uploads/201709/29/59cdbe05b6e90.jpg",
    "email": "jackie.yang@fmnii.com",
    "telephone": "13412304332",
    "address": "",
    "category_name": "管理员",
    "category_id": "1",
    "role_id": "1",
    "position_id": "1",
    "role_name": "CEO",
    "parent_id": "0",
    "department_id": "1",
    "description": "测试",
    "department_name": "总经办",
    "company_id": "1"
},
"info": "登录成功"
}

参数说明
下文重复参数不予赘述

参数名 说明
status 请求状态，说明请求是否成功：1为成功，0为失败
token 今后请求数据都必须带上token作为参数
expire_time token过期时间
info 返回的状态信息说明
user 参照user_list 数组列表参数说明表

失败返回样例
样例1：

{"status":0,"info":"请求方法不对！"}

样例2：

 {"status":0,"info":"用户名或密码错误！"}

我的

站内信数量 messages/tips

返回参数 说明
data.message 站内信数量

站内信 messages

列表 get messages

查看站内信 get messages/:id

删除站内信 get messages/delete/:id

关于阅可得 get about

参数 说明
contact_us 联系方式的文档
company_description 公司介绍文档
private 用户隐私保护协议文档

工作动态 get dynamics

退出登录 get user/logout?token=XXX

忘记密码 post user/lostpw

参数 说明 必填
name 用户名 是
email 邮件地址 是

请求样例

name=Alice

成功返回样例

{"status":1,"info":"邮件发送成功，请24小时之内到邮箱查看，请留意垃圾邮件！"}

失败返回样例

{"status":0,"info":"用户名不存在"}

组织架构获取用户列表 get users

成功返回样例

{
"user_list": [
    {
        "user_id": "1",
        "name": "jackie",
        "sex": "1",
        "img": ".\/Uploads\/201706\/14\/5940a00d093a0.jpg",
        "email": "jackie.yang@fmnii.com",
        "telephone": "13412304332",
        "address": "",
        "category_name": "管理员",
        "category_id": "1",
        "role_id": "1",
        "position_id": "1",
        "role_name": "CEO",
        "parent_id": "0",
        "department_id": "1",
        "description": "",
        "department_name": "总经办",
        "company_id": "1"
    },
],
"categoryList": [
    {
        "category_id": "1",
        "name": "管理员",
        "description": ""
    },
    {
        "category_id": "2",
        "name": "员工",
        "description": ""
    }
],
"status": 1,
"parameter": {
    "token": "024a62e074b7022147d1569de213a4298046",
    "p": "1"
}
}
参数名 说明
parameter 发送的参数信息
parameter.p 页码，每页15行
user_list 用户列表
category_list 用户分类列表

user_list 数组列表参数说明：

参数名 说明
user_id 用户ID
name 用户名
sex 性别，1为男，2为女，0为未知
img 头像图片地址，图片相对于网站根目录地址
email 邮件地址
telephone 手机号码
address 地址
category_name 身份名称
category_id 身份分类ID
role_id 角色ID,基本上和用户ID的值一样，但用户识别的时候最好用role_id的值
position_id 岗位ID
role_name 岗位名称
parent_id 上级user_id
department_id 部门ID
description 岗位描述
department_name 部门名称
company_id 公司编号

categoryList 数组参数说明

参数名 说明
category_id 用户身份ID
name 身份名称
description 身份描述

我的资料 get users/info

字段内容和查看用户一致

用户资料 查看用户 get users/:id

以上:id表示user_id的值,下面类似的的参数就是对应的ID字段的值
请求样例

GET on http://record.test/api.php/users/1?token=7933571be1fd33e9c8f311ec009b43ac8046

返回样例

{
"categoryList": [
    {
        "category_id": "1",
        "name": "管理员",
        "description": ""
    },
    {
        "category_id": "2",
        "name": "员工",
        "description": ""
    },
    {
        "category_id": "3",
        "name": "公司",
        "description": "公司管理员"
    }
],
"user": {
    "user_id": "1",
    "role_id": "1",
    "position_id": "1",
    "user_name": "jackie",
    "status": "1",
    "weixinid": "oT4Bi1FmBZOf5fifh5mGJZE3OgR4",
    "category_id": "1",
    "sex": "1",
    "address": "",
    "email": "jackie.yang@fmnii.com",
    "img": ".\/Uploads\/201706\/14\/5940a00d093a0.jpg",
    "telephone": "13412304332",
    "role_name": "CEO",
    "parent_id": "0",
    "department_id": "1",
    "description": "",
    "department_name": "总经办",
    "company_id": "1",
    "log": false,
    "log_count": 0,
    "file": false,
    "file_count": 0
},
"status": 1,
"parameter": {
    "id": "1"
}
}
参数 说明
user 参考user_list 数组列表参数说明
categoryList 参考category_list数组列表参数说明

编辑用户 post users/:id

参数列表

参数 说明 字段类型 必填
user_id 用户ID 整型 是
name 用户名 字符串
sex 性别，1为男，2为女，0为未知 整型
img 头像图片地址，图片相对于网站根目录地址
email 邮件地址 邮箱格式
telephone 手机号码
address 地址
category_name 身份名称
category_id 身份分类ID 有1.管理员2.员工3.公司
position_id 岗位ID
parent_id 上级user_id

新增用户 post users/add

参数列表

参数 说明 字段类型 必填
name 用户名 字符串 是
email 邮件地址 邮箱格式 选填
password 密码 明文 选填
category_id 身份分类ID 有1.管理员2.员工3.公司 是
position_id 岗位ID 是
creator_role_id 创建人角色ID 是

获得部门列表 get departments

关键参数 position_list 默认岗位列表 department_list 部门列表

"position_list": [
    {
        "position_id": "1",
        "parent_id": "0",
        "name": "CEO",
        "department_id": "1",
        "description": "测试"
    },
    {
        "position_id": "8",
        "parent_id": "1",
        "name": "COO",
        "department_id": "1",
        "description": ""
    }
],
"department_list": [
    {
        "department_id": "1",
        "name": "总经办",
        "description": ""
    },
    {
        "department_id": "10",
        "name": "--技术部",
        "description": ""
    },
    {
        "department_id": "11",
        "name": "--纽约办",
        "description": ""
    },
    {
        "department_id": "2",
        "name": "品牌部",
        "description": "负责鞋业品牌"
    },
    {
        "department_id": "3",
        "name": "市场部",
        "description": ""
    },
    {
        "department_id": "4",
        "name": "业务三部",
        "description": ""
    },
    {
        "department_id": "5",
        "name": "财务部",
        "description": ""
    },
    {
        "department_id": "6",
        "name": "数据部",
        "description": ""
    },
    {
        "department_id": "8",
        "name": "莆田办",
        "description": ""
    },
    {
        "department_id": "12",
        "name": "总经办",
        "description": ""
    },
    {
        "department_id": "17",
        "name": "--测试部门",
        "description": ""
    },
    {
        "department_id": "13",
        "name": "总经办",
        "description": ""
    },
    {
        "department_id": "14",
        "name": "总经办",
        "description": ""
    },
    {
        "department_id": "15",
        "name": "--东莞事业部",
        "description": ""
    },
    {
        "department_id": "16",
        "name": "--越南事业部",
        "description": ""
    }
],

获得岗位列表 get positions/:id

关键参数 data对应id部门的岗位列表

"data": [
    {
        "position_id": "1",
        "parent_id": "0",
        "name": "CEO",
        "department_id": "1",
        "description": "测试"
    },
    {
        "position_id": "8",
        "parent_id": "1",
        "name": "COO",
        "department_id": "1",
        "description": ""
    }
],

仪表盘

日程 get index/calendar --目前出BUG没有数据

公告 get index/announcement

返回样例

{
"widget": [
    {
        "widget": "Salesfunnel",
        "level": null,
        "title": "未命名组件",
        "id": 1
    },
    {
        "widget": "Customerorigin",
        "level": null,
        "title": "mmmm",
        "id": 2
    }
],
"announcement_list": [
    {
        "announcement_id": "2",
        "order_id": "0",
        "role_id": "1",
        "title": "10/7.10/8 工作安排",
        "content": "10.7因为有客人来访，正常上班。10.8日休息。",
        "create_time": "1507293432",
        "update_time": "1507293432",
        "color": "",
        "department": "(1),(2),(3),(4),(5),(6),(8),(10),(11)",
        "status": "1",
        "isshow": "0"
    }
],
"calendar_data": "[]",
"flow": {
    "leave_count": "1",
    "clain_count": "0",
    "my_leave": "1",
    "my_clain": "0"
},
"status": 1,
"parameter": []
}

参数说明

参数 说明
announcement_list 公告数组

announcement_list公告列表说明

参数 说明
announcement_id 公告ID
order_id 排序号
role_id 创建角色ID
title 公告标题
department 括号中的值为部门ID
status 是否生效

逾期统计 get index/todayovertime

返回样例

{
"leads": {
    "today_contact": {
        "count": "152",
        "url": "/api.php/leads/index/by/today"
    },
    "overtime": {
        "count": "565",
        "url": "/api.php/leads/index/field/nextstep_time/condition/lt/search/1507564800"
    }
},
"business": {
    "today_contact": {
        "count": "54",
        "url": "/api.php/business/index/by/today"
    },
    "overtime": {
        "count": "37",
        "url": "/api.php/business/index/field/nextstep_time/condition/lt/search/1507564800"
    }
},
"task": {
    "today_contact": {
        "count": "0"
    },
    "today_content": {
        "url": "/api.php/task/index/by/today"
    },
    "overtime": {
        "count": "5",
        "url": "/api.php/task/index/field/due_date/condition/lt/search/1507564800"
    }
},
"status": 1,
"parameter": []
}

参数说明

参数 说明
leads、business,task 代表线索（潜客），案例，任务
today_contact 今日联系
overtime 已逾期
count 具体统计的数值
url 链接地址
leads->today_contact->count 组合起来就是线索的今日需联系数目

按钮点击跳转页面参数示例

事件：点击线索逾期按钮
请求接口 get leads
请求参数

参数 值
field 潜客和案例nextstep_time,任务逾期时值为due_date
condition lt
search 当日凌晨的时间Unix时间戳

案例逾期的接口：get business
任务逾期的接口：get tasks

发送参数 说明
search 搜索的值

发送样例

http://record.test/api.php/search?token=7df79f23fe171ab4a9478d7bcdd60fee8046&search=测试

返回样例

{
"search": "测试",
"business": {
    "name_list": [
        {
            "status_id": "101",
            "name": "<span style='color: red'>测试</span>案例号",
            "nextstep_time": "1502435580",
            "customer_id": "27",
            "business_sn": "31156",
            "business_id": "30",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "delete_role_id": "1",
            "create_time": "1502435778",
            "is_deleted": "1",
            "delete_time": "1502435797",
            "update_time": "1502435778",
            "update_role_id": "1",
            "description": "",
            "status_name": "开发磋商（财务立案追踪）",
            "contacts_name": null
        },
        {
            "status_id": "101",
            "name": "<span style='color: red'>测试</span>新增案例通知",
            "nextstep_time": "1503989760",
            "customer_id": "27",
            "business_sn": "466366",
            "business_id": "36",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "delete_role_id": "1",
            "create_time": "1503644458",
            "is_deleted": "1",
            "delete_time": "1503644765",
            "update_time": "1503644458",
            "update_role_id": "1",
            "description": "三封通知格式怎么样呢？",
            "status_name": "开发磋商（财务立案追踪）",
            "contacts_name": null
        },
        {
            "status_id": "101",
            "name": "<span style='color: red'>测试</span>U函数",
            "nextstep_time": "1503732420",
            "customer_id": "25",
            "business_sn": "996017",
            "business_id": "43",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "delete_role_id": "1",
            "create_time": "1503646330",
            "is_deleted": "1",
            "delete_time": "1503653511",
            "update_time": "1503646330",
            "update_role_id": "1",
            "description": "测试U函数 function U($url='',$vars='',$suffix=true,$redirect=false,$domain=false)",
            "status_name": "开发磋商（财务立案追踪）",
            "contacts_name": null
        },
        {
            "status_id": "101",
            "name": "<span style='color: red'>测试</span>自动案例日志",
            "nextstep_time": "1505664000",
            "customer_id": "32",
            "business_sn": "684555",
            "business_id": "56",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "delete_role_id": "0",
            "create_time": "1505698855",
            "is_deleted": "0",
            "delete_time": "0",
            "update_time": "1507511353",
            "update_role_id": "1",
            "description": "测试你好23333333224444",
            "status_name": "开发磋商（财务立案追踪）",
            "contacts_name": null
        },
        {
            "status_id": "101",
            "name": "Jackie的<span style='color: red'>测试</span>案例",
            "nextstep_time": "1507694796",
            "customer_id": "37",
            "business_sn": "435165",
            "business_id": "65",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "delete_role_id": "0",
            "create_time": "1506755717",
            "is_deleted": "0",
            "delete_time": "0",
            "update_time": "1507435596",
            "update_role_id": "1",
            "description": "测试案例",
            "status_name": "开发磋商（财务立案追踪）",
            "contacts_name": null
        },
        {
            "status_id": "101",
            "name": "<span style='color: red'>测试</span>23333333333333333",
            "nextstep_time": "1507046400",
            "customer_id": "38",
            "business_sn": "450271",
            "business_id": "66",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "delete_role_id": "1",
            "create_time": "1506759119",
            "is_deleted": "1",
            "delete_time": "1506760036",
            "update_time": "1506759500",
            "update_role_id": "1",
            "description": "23333",
            "status_name": "开发磋商（财务立案追踪）",
            "contacts_name": null
        }
    ],
    "count": 6
},
"leads": {
    "name_list": [
        {
            "leads_id": "57",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "name": "<span style='color: red'>测试</span>",
            "position": "",
            "contacts_name": "测试",
            "saltname": "",
            "mobile": "13712340432",
            "email": "jackie@fmnii.com",
            "create_time": "1504590106",
            "update_time": "1504590106",
            "is_deleted": "1",
            "delete_role_id": "1",
            "delete_time": "1504592298",
            "is_transformed": "0",
            "transform_role_id": "0",
            "contacts_id": "0",
            "customer_id": "0",
            "business_id": "0",
            "nextstep": "",
            "nextstep_time": "1504158060",
            "have_time": "1504590106",
            "address": "广东省\n东莞市",
            "source": "测试"
        },
        {
            "leads_id": "797",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "name": "<span style='color: red'>测试</span>",
            "position": "",
            "contacts_name": "方雪婷",
            "saltname": "",
            "mobile": "0769-88802326",
            "email": "alice.fang@fmnii.com",
            "create_time": "1506157031",
            "update_time": "1506157031",
            "is_deleted": "0",
            "delete_role_id": "0",
            "delete_time": "0",
            "is_transformed": "0",
            "transform_role_id": "0",
            "contacts_id": "0",
            "customer_id": "0",
            "business_id": "0",
            "nextstep": "",
            "nextstep_time": "1506675480",
            "have_time": "1506157031",
            "address": "广东省\n东莞市\n舒服舒服",
            "source": ""
        },
        {
            "leads_id": "975",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "name": "Jackie<span style='color: red'>测试</span>案例",
            "position": "",
            "contacts_name": "jackie",
            "saltname": "",
            "mobile": "13412304332",
            "email": "jackie.yang@fmnii.com",
            "create_time": "1506756394",
            "update_time": "1506756797",
            "is_deleted": "0",
            "delete_role_id": "0",
            "delete_time": "0",
            "is_transformed": "1",
            "transform_role_id": "1",
            "contacts_id": "0",
            "customer_id": "41",
            "business_id": "0",
            "nextstep": "",
            "nextstep_time": "1507046400",
            "have_time": "1506756394",
            "address": "湖南省\n湘潭市\n市辖区",
            "source": "自行开发"
        },
        {
            "leads_id": "976",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "name": "<span style='color: red'>测试</span>2333333",
            "position": "",
            "contacts_name": "哈哈",
            "saltname": "",
            "mobile": "15879985993",
            "email": "3434343@qq.com",
            "create_time": "1506759215",
            "update_time": "1506759281",
            "is_deleted": "0",
            "delete_role_id": "0",
            "delete_time": "0",
            "is_transformed": "1",
            "transform_role_id": "1",
            "contacts_id": "45",
            "customer_id": "42",
            "business_id": "0",
            "nextstep": "",
            "nextstep_time": "1507305600",
            "have_time": "1506759215",
            "address": "广东省\n广州市\n天河区\n2333",
            "source": "自行开发"
        },
        {
            "leads_id": "980",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "name": "<span style='color: red'>测试</span>",
            "position": "",
            "contacts_name": "111",
            "saltname": "",
            "mobile": "13825010619",
            "email": "wuhong@hexinkuraray.com",
            "create_time": "1506847647",
            "update_time": "1507511402",
            "is_deleted": "0",
            "delete_role_id": "0",
            "delete_time": "0",
            "is_transformed": "0",
            "transform_role_id": "0",
            "contacts_id": "0",
            "customer_id": "0",
            "business_id": "0",
            "nextstep": "",
            "nextstep_time": "1508947200",
            "have_time": "1506847647",
            "address": "\n\n\n",
            "source": "自行开发"
        }
    ],
    "count": 5
},
"customer": {
    "name_list": [
        {
            "customer_id": "30",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "contacts_id": "0",
            "name": "品牌客户<span style='color: red'>测试</span>",
            "origin": "",
            "address": "广东省\n东莞市",
            "zip_code": "",
            "industry": "",
            "annual_revenue": "",
            "ownership": "",
            "rating": "",
            "create_time": "1502501412",
            "update_time": "1502501412",
            "is_deleted": "1",
            "is_locked": "0",
            "delete_role_id": "1",
            "delete_time": "1502501442",
            "customer_type": "品牌"
        },
        {
            "customer_id": "42",
            "owner_role_id": "1",
            "creator_role_id": "1",
            "contacts_id": "45",
            "name": "<span style='color: red'>测试</span>2333333",
            "origin": "自行开发",
            "address": "广东省\n广州市\n天河区\n2333",
            "zip_code": "",
            "industry": "",
            "annual_revenue": "",
            "ownership": "",
            "rating": "",
            "create_time": "1506759281",
            "update_time": "1506759281",
            "is_deleted": "1",
            "is_locked": "0",
            "delete_role_id": "1",
            "delete_time": "1507299885",
            "customer_type": "鞋业-真皮"
        }
    ],
    "count": 2
},
"product": {
    "name_list": [
        {
            "product_id": "10",
            "category_id": "6",
            "name": "<span style='color: red'>测试</span>产品",
            "creator_role_id": "15",
            "suggested_price": "10000.00",
            "development_team": "测试部",
            "development_time": "-28800",
            "link": "",
            "create_time": "1507105739",
            "update_time": "1507105776",
            "spec": ""
        }
    ],
    "count": 1
},
"task": {
    "name_list": null,
    "count": 0
},
"status": 1,
"parameter": {
    "search": "测试"
}
}

参数说明

参数 说明
business、leads、task、customer,product 具体每个列表的搜索结果都要查看对应模块的列表解释
name_list 根据名字（主题）搜索的结果列表
count 统计的数目

需要通知的人

参数 说明
about_roles 需要通知的人,返回样例（1,2,3）
weixin_alert 值为1时微信通知
email_alert 值为1时邮件通知
message_alert 值为1时站内信通知

选择负责人 get users/listDialog

这是单选的
传回role_id参数的值，整形

选择需要通知的人 get users/listDialog

这是多选的
传回role_id参数的值，格式:1,2,

地址选择 get place

该接口无需token

选择客户列表 get customers/listDialog

传回的值属于参数：customer_id

选择案例列表 get business/listDialog

传回的值属于参数：business_id

选择产品列表 get products/listDialog

回传的值属于参数：product_id

选择联系人列表 get contacts/listDialog

发送参数 说明 必须
customer_id 客户ID,使用客户列表 是

回传参数：contacts_id

CRM

搜索条件参数说明

参数 说明
search 搜索的内容
condition gt大于,lt小于,contains包含
field 字段名，name,nextstep_time,mobile等都可以作为搜索字段名
by 通过什么筛选，值有me我负责的,create我创建的,sub下属的,subcreate下属创建的，today今天，week本周，month本月
desc_order 通过什么倒序排序，值为update_time更新时间，create_time创建时间,任务列表排序due_date
asc_order 通过什么正序排序，值为update_time更新时间，create_time创建时间,任务列表排序due_date

更新（日志） logs

新增更新 post logs

参数 说明 必须
r 关联模型名称，参数的值参照 是
module 模型名称，参数的值参照 是
id 对应模型ID,比如leads模型的ID是leads_id的值 是
content 更新内容 是
nextstep_time 下次联系时间
role_id 发送消息的人的角色ID 是
需要通知的人的参数
参数r的值在不同情况下的值
情况(模型) 参数module的值 参数r的值
线索 leads r_leads_log
案例 business r_business_log
用户 user r_log_user
产品 product r_log_product
任务 task r_log_task

列表位置

此处输入图片的描述
位置一二三对应三个参数

线索(更名为潜客) leads

查看线索列表 get leads

参数参照搜索条件参数说明

参数 说明
public 值为1时说明筛选范围为线索池
位置 列表参数
一 name
二 owner.user_name
三 update_time

线索详情 get leads/:id

此处输入图片的描述

"leads": {
    "nextstep_time": "1507651200",
    "contacts_name": "陈建宏",
    "mobile": "18925436583",
    "email": "",
    "address": "广东省\n东莞市\n万江区莫屋社区新村新丰路A3号 ",
    "name": "东莞市神光激光科技有限公司",
    "source": "温州展会",
    "leads_id": "372",
    "creator_role_id": "3",
    "owner_role_id": "3",
    "create_time": "1505274849",
    "update_time": "1505274849",
    "contacts_id": "0",
    "customer_id": "0",
    "is_deleted": "0",
    "description": "供应商来自：2017/8/25-27，第二十二届中国（温州）国际皮革、鞋材、鞋机展览会。",
    "owner": {
        "user_id": "3",
        "role_id": "3",
        "position_id": "3",
        "user_name": "Minnie",
        "status": "1",
        "weixinid": "",
        "category_id": "2",
        "sex": "2",
        "address": "",
        "email": "minnie.zhu@fmnii.com",
        "img": "./Uploads/201706/14/5940a11d666c3.jpg",
        "telephone": "13925513320",
        "dashboard": "",
        "role_name": "业务员",
        "parent_id": "1",
        "department_id": "3",
        "description": "",
        "department_name": "市场部",
        "company_id": "1"
    },
    "creator": {
        "user_id": "3",
        "role_id": "3",
        "position_id": "3",
        "user_name": "Minnie",
        "status": "1",
        "weixinid": "",
        "category_id": "2",
        "sex": "2",
        "address": "",
        "email": "minnie.zhu@fmnii.com",
        "img": "./Uploads/201706/14/5940a11d666c3.jpg",
        "telephone": "13925513320",
        "dashboard": "",
        "role_name": "业务员",
        "parent_id": "1",
        "department_id": "3",
        "description": "",
        "department_name": "市场部",
        "company_id": "1"
    },
    "log": [
        {
            "log_id": "216",
            "role_id": "1",
            "category_id": "1",
            "create_date": "1507705861",
            "update_date": "1507705861",
            "subject": "",
            "content": "说了很多话",
            "comment_id": "0",
            "about_roles": "1,",
            "about_roles_name": "jackie,",
            "owner": {
                "user_id": "1",
                "role_id": "1",
                "position_id": "1",
                "user_name": "jackie",
                "status": "1",
                "weixinid": "oT4Bi1FmBZOf5fifh5mGJZE3OgR4",
                "category_id": "1",
                "sex": "1",
                "address": "11",
                "email": "jackie.yang@fmnii.com",
                "img": "./Uploads/201709/29/59cdeaf6d2d28.jpg",
                "telephone": "13412304332",
                "dashboard": "a:2:{s:9:\"dashboard\";a:2:{i:1;a:4:{s:6:\"widget\";s:11:\"Salesfunnel\";s:5:\"level\";N;s:5:\"title\";s:15:\"未命名组件\";s:2:\"id\";i:1;}i:2;a:4:{s:6:\"widget\";s:14:\"Customerorigin\";s:5:\"level\";N;s:5:\"title\";s:4:\"mmmm\";s:2:\"id\";i:2;}}s:4:\"sort\";a:2:{i:0;i:1;i:1;i:2;}}",
                "role_name": "CEO",
                "parent_id": "0",
                "department_id": "1",
                "description": "",
                "department_name": "总经办",
                "company_id": "1"
            }
        }
    ],
    "log_count": 1,
    "file": false,
    "file_count": 0,
    "task": false,
    "task_count": 0,
    "event": false,
    "event_count": 0,
    "record": null,
    "record_count": 0
},

返回说明：

参数 说明
leads.log 关于leads_id的日志数组

编辑线索 post leads/:id

增加线索 post leads/add

请求参数

参数 说明 必填
leads_id 线索ID 编辑必填
creator_role_id 创建人角色ID 是
name 公司名 是
mobile 联系人手机
email 邮箱
owner_role_id 负责人角色ID 是
nextstep_time 下次联系时间
description 线索描述
source 线索来源，参照线索来源接口
contacts_name 联系人 是
address[state] 省
address[city] 城市
address[area] 镇区
address[street] 街道
需要通知的人 编辑潜客不需要通知任何人

线索来源 get leads/add

参数 说明
origin 来源列表

删除线索 get leads/delete/:id/:token

说明，此处的token在url上
请求样例

http://record.test/api.php/leads/374/f7740a7192d9c32baff274a8a4be6e2c8046

客户 customers

客户列表 get customers

发送参数

参数 说明
content 值为resource时筛选范围为客户池
参数参照搜索条件条件参数说明
位置 列表参数
一 name
二 owner.user_name
三 update_time

客户详情 get customers/:id

此处输入图片的描述

此处输入图片的描述

编辑客户 post customers/:id

参数 说明 必填
customer_id 客户编号ID 是
owner_role_id 负责人ID 是
name 客户名称 是
customer_type 客户类型ID 是
origin 客户来源
address[state] 省
address[city] 城市
address[area] 镇区
address[street] 街道
no_of_employees 员工数
description 描述
contracts_id 联系人ID，单选联系人用联系人列表
industry 客户行业
customer_type 客户类型

新增客户 post customers/add

参数 说明 必填 线索详情对应的字段,相同的用-表示
owner_role_id 负责人ID -
name 客户名称 是 name
customer_type 客户类型ID 是 无对应
origin 客户来源 source
con_name 联系人名称 是 contacts_name
con_telephone 联系人手机 是 mobile
address[state] 省 address \n 的一个值
address[city] 城市 address \n 的二个值
address[area] 镇区 address \n 的三个值
address[street] 街道 address \n 的四个值
con_email 联系人邮箱 email
con_post 职位 无对应
con_description 联系人描述 无对应
no_of_employees 员工数 无对应
description 描述 -
leads_id 线索ID号，表示要由线索转化为客户时使用 转化为客户时必须 -
creator_role_id 创建人角色ID 是 -

客户类型和客户信息来源 get customers/add

数组返回提交的值 等于 选中的值

关键参数 说明
origin 客户信息来源数组
customer_type 客户类型数组
no_of_employees 员工数量数组
order_customer_type 其他客户类型（暂无作用）

删除客户 get customers/delete/:id/:token

客户联系人 contacts

联系人列表 get contacts

筛选参数参考搜索搜索条件参数说明

联系人详情 get contacts/:id

此处输入图片的描述

删除联系人 get contacts/delete/:id

编辑联系人 post contacts/:id

增加联系人 post contacts/add

编辑和增加联系人参数说明

参数 说明 必填
contacts_id 联系人ID 编辑时必须
name 姓名 是
saltname 尊称
customer_id 所属客户ID 是
post 职位
telphone 手机号码
email 邮箱地址
address 联系地址
zip_code 邮编地址
description 描述
creator_role_id 创建人角色ID 是

客户关怀 cares

查看关怀列表 get cares

筛选参数参考搜索搜索条件参数说明

位置 列表参数
一 subject
二 customer.name
三 care_time

关怀详情 get cares/:id

参数 说明
customer.name 客户名
contacts.name 联系人名
owner.user_name 执行人名

删除关怀 get cares/delete/:id/:token

编辑关怀 post cares/:id

增加关怀 post cares/add

编辑和增加关怀参数说明

参数 说明 必填
customer_id 客户ID 是
care_id 关怀ID 编辑时必须
contacts_id 联系人ID 必须
subject 关怀主题 是
care_time 关怀时间，Unix 时间戳 是
owner_role_id 执行人ID 必填
type 关怀类型
content 关怀内容
description 备注
creator_role_id 创建人角色ID 是

关怀类型值

选项 值
无
电话 phone
邮件 email
短信 message
其他 other

案例 business

查看案例列表 get business

筛选参数参考搜索搜索条件参数说明

关键参数list

位置 列表参数
一 name
二 owner.user_name
三 update_time

案例详情 get business/:id

此处输入图片的描述

删除案例 get business/delete/:id

编辑案例 post business/:id

增加案例 post business/add

编辑和增加关怀参数说明

参数 说明 必填
business_id 案例ID 编辑时必须
owner_role_id 负责人ID 是
name 案例名 是
nextstep_time 下次联系时间 是
customer_id 下单客户ID 是
brand_customer 品牌客户ID
description 描述
creator_role_id 创建人角色ID 是
通知模块参数 参考

单据 Orders

查看单据 get orders

关键参数list

位置 列表参数
一 business.name
二 order_sn
三 create_time

单据详情 get orders/:id

此处输入图片的描述
相关案例行：business_name

删除单据 get orders/delete/:id/:token

编辑单据 post orders/:id

增加单据 post orders/add

编辑和增加单据参数说明

发送参数 说明 必填
create_role_id 创建人角色ID 是
owner_role_id 负责人ID 是
order_id 单据ID 编辑时必须
business_id 案例ID 是
customer 下单客户ID 是
brand_customer 品牌客户ID 是
address[state] 发货地址,省
address[city] 发货地址，市
address[area] 发货地址，地区
address[street] 发货地址，街道
contacts_name 收货联系人
delivery_date 发货日期
currency 币种，选项：人民币/美元/欧元/英镑
delivery_type 快递方式，选项：快递/陆运/空运
payment_agreement 收付款协议，选项：月结30天/月结45天/月结60天
tax 税率，小数点后3位浮点数
order_type 单据类型，值0表示开发样品单，1表示量产销售单 是
attribute[i][key] 附加属性i的键值
attribute[i][value] 附加属性i的值
products[i][product_id] 添加产品i的产品ID
products[i][is_free] 添加产品i是否免费，值为1是免费，0为不免费，默认不免费
products[i][amount] 添加产品i的销售产品数量
products[i][description] 添加产品i的备注
products[i][sales_price] 添加产品i的单价

备注：attribute,products数据的数据类型时json字符串格式

单据添加特殊属性 post orders/attribute/:id

发送参数 说明 必填
order_id 单据ID 添加单据时不用填，是
attribute_name 属性名称 是
attribute_value 属性的值 是

单据添加单据产品 post orders/product/:id

发送参数 说明 必填
order_id 单据ID 添加单据时不用填，是
product_id 产品ID 是
is_free 是否免费 是
sales_price 售价 是
amount 数量 是
description 备注
creator_role_id 创建人ID 是
r 值为rOrderProduct 是
module 值为order 是
model_id 模型ID,值为order_id的值 是
dialog_add 值为dialog_add 是

产品 products

查看产品 get products

此处输入图片的描述

位置 列表参数
一 name
二 category_name
三 update_time

产品详情 get products/:id

此处输入图片的描述

删除产品 get products/delete/:id/:token

编辑产品 post products/:id

增加产品 post products/add

发送参数 说明 必填
product_id 产品ID 编辑时必填
name 产品名称 是
spec 产品规格
category_id 产品类型ID 是
development_time 研发时间，Unix时间戳
development_team 研发团队 是
suggested_price 建议售价
main_pic[] 产品主图
sec_pic[] 产品副图
description 描述
creator_role_id 创建人角色ID 是
main_images_id 隐藏参数，旧主图的图片ID,images_id 编辑必填

产品类型列表 get products/add

参数 说明
categoryList 产品类型列表

任务 tasks

查看任务 get tasks

此处输入图片的描述
此处输入图片的描述

位置 列表参数
一 subject
二 owner.i.user_name
三 due_date

任务详情 get tasks/:id

此处输入图片的描述

删除任务 get tasks/delete/:id/:token

编辑任务 post tasks/:id

增加任务 post tasks/add

发送参数 说明 必填
task_id 任务ID 编辑时必填
subject 主题 是
owner_role_id_str 负责人，多选 是
creator_role_id 创建人角色ID 是
通知参数 参照需要通知的人
module 选择相关，值参照 选填
module_id 相关的选项的ID module的值不为空时必填
module_name 相关的名字，此处需要选择和module参数相同的对应列表的值 module的值不为空时必填
due_date 截止日期
status 状态，单选（未启动、延迟、进行中、完成）
priority 优先级，单选（高、低、普通）
description 描述
选择相关选项与值
选项 说明
其他相关 默认客户
contacts 联系人
customer 客户
business 案例
product 产品

分析

目标与完成度 targets

关键数据 lists
此处输入图片的描述

查看列表 get targets

新增目标 post targets/add
发送参数 说明
target_type 目标类型,单选（个人目标、集体目标）
owner_role_id 执行人
owner_department_id 执行部门
target_price 目标金额
target_month 执行月份
通知参数 参照需要通知的人

客户分析 get analytics

返回参数 说明
sales_price_rank 产品分析-销售额排行榜
total_amount_rank 产品分析-销售数量排行榜
product_vs_rank 产品分析-产品效率排行榜
customer_vs_rank 客户分析-客户效率排行榜
customer_order_rank 客户分析-客户订单排行榜
customerList 客户分析-打样分析，量产分析，效率分析

打样分析 get analytics/sample

重点参数develop_list
此处输入图片的描述

量产分析 get analytics/mass

重点参数mass_list
此处输入图片的描述

效率分析 get analytics/vslist

重点参数vsList
此处输入图片的描述

客户效率排行榜

此处输入图片的描述

客户订单排行榜 get analytics/rank

此处输入图片的描述

产品分析

产品效率排行榜
此处输入图片的描述
产品销售数量排行榜
此处输入图片的描述
产品销售金额排行榜
此处输入图片的描述

工作台

打卡 post clocks/add

发送参数 说明
position 百度地图的位置，格式样例：113.68618996837,22.939500535274
province 省份，中文
city 城市,中文

打卡日历 get clocks

返回样例

{
        "title": "23:29已打卡",
        "position": "113.76343399,23.04302382",
        "city": "东莞市",
        "province": "广东省",
        "start": {
            "e": "12",
            "n": "10"
        }
},
参数 说明
title 打卡标题
position 百度坐标
city 东莞市
province 广东省
start.n 月份
start.e 日期

审批 flows

查询审批 get flows

"list": [
    {
        "flow_id": "1",
        "flow_type": "1",
        "owner_role_id": "1",
        "about_roles": "8,",
        "flow_roles": "1,",
        "attribute": {
            "leave_type": "年假",
            "leave_reason": "测试请假",
            "time_range": "2017-09-19 到 2017-09-26"
        },
        "name": "年假2017-09-19 到 2017-09-26",
        "roles_status": "2",
        "status": "2",
        "create_time": "1506482224",
        "owner_role_name": "jackie1",
        "about_roles_name": "Alice",
        "flow_roles_name": "jackie1",
        "status_string": "jackie1-驳回\r\n"
    },
发送参数 说明
by 值为waiting表示待处理，值为done表示已处理，值为copy表示抄送我的，无值表示我提交的

审批详情 get flows/:id

"flow": {
    "flow_id": "1",
    "flow_type": "1",
    "owner_role_id": "1",
    "about_roles": "8,",
    "flow_roles": "1,",
    "attribute": "{\"leave_type\":\"\\u5e74\\u5047\",\"leave_reason\":\"\\u6d4b\\u8bd5\\u8bf7\\u5047\",\"time_range\":\"2017-09-19 \\u5230 2017-09-26\"}",
    "name": "",
    "roles_status": "2",
    "status": "2",
    "create_time": "1506482224",
    "owner_role_name": "jackie1",
    "about_roles_name": "Alice",
    "flow_roles_name": "jackie1"
},
"status": 1,
"parameter": {
    "id": "1"
}

通过审批 get flows/pass/:id

驳回审批 get flows/unpass/:id

增加审批 post flows/add

审批通用参数

参数 说明
flow_type 审批类型 1.请假 2.报销 3费用 4出差 5采购 6加班 8其他
flow_roles 审批人ID，多选，参照获取选项
img 图片类型
参照需要通知的人

请假需要的参数

参数 说明
leave_type 请假类型，
time_range 请假时间范围，如“2017-10-10 到 2017-10-26”
leave_reason 请假原因

报销需要的参数

参数 说明
clain_type 报销类型，单选，选项本地固定
fee_time 发生时间
free_time 费用类型
fee_money 费用金额
clain_reason 报销是由

分页请求说明

发送参数 说明 类型
listrows 每页多少行 int
p 第几页 int

文件 files

文件删除 get files/delete/:file_id

系统提醒接口

使用极光推送Jpush方法进行推送提醒，选择站内信推送默认选择APP消息推送，以下为极光推送返回的参数列中对我们有用的参数

参数 说明
extras 极光推送的用户参数
extras['type'] 传送的消息的类型,类型的值有flow审批，business案例，leads潜客，customer客户，task任务，user用户，finance财务,product产品，order单据,target业绩
extras['model_id'] 对应的ID
extras['unread'] 未读数据
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注