20210819拓展接口

接口变更记录

变更内容	变更版本	变更人	备注
1、导入联系人的参数修改成 customerList，接口名称修改。 2、接口加密参数使用header头传递 3、增加用户信息更新接口 4、增加客户回收接口	v2	kubrick

一、token生成方式说明

token计算方式

token = md5( tenantId + timestamp + apiKey )

md5值使用32位小写，其中tenantId、apiKey由傲途提供，使用header头传输。

字段名	字段类型	是否必填	备注
tenantId	string	y	公司id
timestamp	string	y	当前时间戳
token	string	y	token加密串

二、接口

1、客户导入接口

• Url: http://xxxx.com/wscrm-api/openapi/customer/import

• Method: POST

• Content-type: application/json

• 请求参数

字段名	字段类型	是否必填	备注
customerList	list	y	客户数据

• customerList数据类型

字段名	字段类型	是否必填	备注
userId	int	y	被cui人的ID
name	string	y	jiekuan人的名称
nickName	string	y	cuishouyuan的名称
phone	string	n	被cui人手机号
taskType	int	y	分案类型 1=提醒;2=cuishou
rsData	list	n	亲属层级关联数据
description	string	n	cui记内容
paymentType	int	n	还kuan类型 0=未还kuan; 1=已还kuan 为空则默认未还kuan
paymentInfo	string	n	借kuan人信息url

• rs_data数据

字段名	字段类型	是否必填	备注
type	int	y	关系 1= 一联；2= 二联；
rsType	int	y	和联系人的关系
name	string	y	关联联系人名称
phone	string	y	关联联系人手机号

• rs_type 枚举值

值	解释
0	Orang tua
1	Anak
2	Kakak Adik
3	Saudara lainnya
4	Teman
5	Kolega/rekan kantor
6	Pasangan

• 返回参数

字段名	字段类型	备注
code	int	错误代码 200=成功
msg	string	错误原因等提示信息
data	list	返回结果

• 请求示例

{ 
    "customerList": [
        { 
            "userId":1324, 
            "name": "als",
            "nickName":"lilin", 
            "phone": "971568405326", 
            "taskType":1, 
            "rsData":[ 
                {"type":1,"name":"王xx","rsType":1,"phone":"923083984029"},
                {"type":2,"name":"王yy","rsType":2,"phone":"923083984029"},
                {"type":3,"name":"王zz","rsType":3,"phone":"923083984029"}
            ],
            "description":"截止到xx月xx日，最后归还日", 
            "paymentType":1,
            "paymentInfo":"http://www.baidu.com"
        },
        { 
            "userId": 1325,
            "name": "lal",
            "nickName": "zhouli", 
            "phone": "971568405326", 
            "taskType":2, 
            "rsData":[ 
                {"type":1,"name":"王xx","rsType":1,"phone":"923083984029"},
                {"type":2,"name":"王yy","rsType":2,"phone":"923083984029"}, 
                {"type":3,"name":"王zz","rsType":3,"phone":"923083984029"} 
            ], 
            "description": "截止到xx月xx日，最后归还日", 
            "paymentType":0,
            "paymentInfo":"http://www.baidu.com"
        }
    ]
}

• 返回示例

{
	"code": 200,
	"data": "",
	"msg": "success!"
}

2、客户回收接口

• URL: http://xxx.com/wscrm-api/openapi/customer/recycle

• Method: POST

• Content-type: application/json

• 请求参数

字段名	字段类型	是否必填	备注
customerList	list	y	客户信息

• customerList参数

字段名	字段类型	是否必填	备注
nickName	string	y	cuiyuan名称
whatsapp	string	y	jiekuan人 whatsapp 账号

• 请求示例

{
	"customerList": [
        {
            "nickName": "wang",
            "whatsapp": "6261626262626"
        },
        {
            "nickName": "li",
            "whatsapp": "62122726726262"
        }
    ],
}

• 返回参数

字段名	字段类型	备注
code	int	错误代码 200=成功
msg	string	错误原因等提示信息
data	list	返回结果

• 返回示例

{
	"code":200,
	"msg":"success!",
	"data": "",
}

3、用户信息更新接口

• URL: http://xxx.com/wscrm-api/openapi/user/update

• Method: POST

• Content-type: application/json

• 请求参数

字段名	字段类型	是否必填	备注
userList	list	y	用户列表

• userList

字段名	字段类型	是否必填	备注
userName	string	y	傲途坐席名称
nickName	string	y	ppd cuiyuan 名称
phone	string	y	手机号
deptId	string	n	部门id
deptName	string	n	部门名称

• 请求示例

{
	"userList": [
    {
        "userName":"张三", 
        "nickName":"小张", 
        "deptId":"1", 
        "deptName":"营业部", 
        "phone":"1822827272727" 
    },
    {
        "userName":"张三", 
        "nickName":"小张", 
        "deptId":"1", 
        "deptName":"营业部", 
        "phone":"1822827272727" 
    }]
}

• 返回参数

字段名	字段类型	备注
code	int	错误代码 200=成功
msg	string	错误原因等提示信息
data	list	返回结果(更新异常的cuiyuan 名称)

• 返回示例

{
	"code":200,
	"data":[
        "lisa",
        "lisi"
    ],
	"msg":"success!"
}