用户资料同步接口
注意:本接口的使用需要进行接口鉴权
用户资料同步接口文档共分为三部分:
第一部分:将您系统内的用户资料同步到客服系统
第二部分:将用户的资料信息变更推送给第三方系统
第三部分:查询联系计划和联系历史
第四部分:查询操作日志
1.获取用户数据库版本号、字段结构接口
-
HTTP请求方式:POST
-
请求url:
{HOST}/v20170418/customer/getTemplate/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
-
请求频次限制:20次/每分钟
请求体:
无
响应码:
代码 | 含义 |
200 | 请求成功 |
400 | 请求体参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回200事例:
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
返回值
字段 | 含义 |
code | 响应码 |
message | 响应信息 |
data | 返回数据,JSON格式 |
data
version | 数据库版本号作用:因为用户模板字段是用户可以自己配置的,所以数据库字段经常会发生变化,为了保证用户数据和用户配置的用户模板保持一致,所以对用户模板加一个版本号字段,所有对用户数据的增删改查操作都需要带上版本号,如果该版本号和用户模板中的版本号不一致,那么该操作失败。 |
template_type | 用户类型company:企业用户 personal:个人用户 |
status | 用户状态,默认四个 ,必填(单选,插入、修改数据时传Key值,例如status0)status0 : 普通用户status1: 银牌用户 status2: 金牌用户 status3 : VIP用户 |
source | 数据来源,单选 |
stable_fields | 用户默认字段,企业用户10个,个人用户13个举例: "name" : 字段id "value" : 字段名称 "required" : 是否必填,requied:必填 空:非必填 "example": 字段类型、传参举例 插入、修改数据时根据"name"值匹配字段 |
custom_fields | 自定义字段 数量不限插入、修改数据时根据"name"值匹配字段 |
企业用户stable_fields
属性name | 属性value | 备注 |
name | 公司名称 | 默认必填 |
title | 描述 | |
phone | 联系人电话 | Object数组类型[{"tel":"130xxxxxxxx","memo":"备注"}]tel: 手机号, memo: 备注 |
联系人邮箱 | Object数组类型[{"email":"example@163.com","memo":"备注"}]email: 邮箱, memo: 备注 |
|
weixin | 微信 | Object数组类型:[{"num":"example001","memo":"备注"}]num: 微信号, memo: 备注 |
province | 省 | 直辖市带"市"字,例如: "北京市"普通省份带"省"字,例如: "山东省" |
city | 市 | 带"市"字,例如:"北京市", "石家庄市" |
address | 公司地址 | |
note | 备注 | |
web | 公司网站 |
个人用户stable_fields
属性name | 属性value | 备注 |
name | 公司名称 | 默认必填 |
title | 描述 | |
phone | 联系人电话 | Object数组类型[{"tel":"130xxxxxxxx","memo":"备注"}]tel: 手机号, memo: 备注 |
联系人邮箱 | Object数组类型[{"email":"example@163.com","memo":"备注"}]email: 邮箱, memo: 备注 | |
weixin | 微信 | Object数组类型:[{"num":"example001","memo":"备注"}]num: 微信号, memo: 备注 |
province | 省 | 直辖市带"市"字,例如: "北京市"普通省份带"省"字,例如: "山东省" |
city | 市 | 带"市"字,例如:"北京市", "石家庄市" |
address | 公司地址 | |
note | 备注 | |
web | 公司网站 | |
sex | 性别 | "0":男"1":女 |
age | 年龄 | |
birth | 生日 | Date类型,"yyyy-MM-dd" |
用户自定义字段custom_fields,用户自定义字段有七种类型,分别是单行文本、多行文本、数字、日期、下拉框、复选框、单选框,每种类型的字段可以设置多个。
类型id | 类型名称 | 备注 |
single | 单行文本 | |
multi | 多行文本 | |
number | 数字 | 数据类型:String,格式:正整数,例如"23" |
date | 日期 | 数据类型:String,格式:Date "yyyy-MM-dd" |
dropdown | 下拉框 | 返回数据中带可选属性choices,例如:,"choices":{"0":"1次","1":"3次","2":"多次"} |
checkbox | 复选框 | 返回数据中带可选属性choices,例如:,"choices": {"0":"开朗","1":"大方","2":"顽固"} |
radio | 单选框 | 返回数据中带可选属性choices,例如:,"choices": "choices":{"0":"男","1":"女"} |
2.新增用户资料数据接口
-
HTTP请求方式:POST
-
请求url:
{HOST}/v20170418/customer/insert/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
-
请求频次限制:20次/每分钟
-
数据条数限制:每次最多插入500条用户数据
请求示例:
https://apis.7moor.com/v20170418/customer/insert/N00000000556
?sig=3E92F146297FCA751F63493877EC9719
请求体
字段 | 类型 | 备注 |
version | String,必填 | 版本号,必须用获取用户资料模板中返回的version值 |
customers | Object类型数组,必填 |
_id:小写的UUID,用户的唯一主键id,非必填(如不传或传值错误,则由我们系统自动生成)
status:用户状态 必填 source:数据来源 owner:归属坐席(电销业务场景下可通过传公海名称来给公海新增用户) 企业用户自定义字段传获取模板信息接口中返回的stable_fields中的字段 个人用户自定义字段传获取模板信息接口中返回的custom_fields中的字段 importSid:用户自定义访客id,关联在线客服会话用 |
请求体事例:
{
"version": "201610100019",
"customers": [
{
"status":"status0",
"source":"谷歌",
"name":"rest导入测试44444",
"title":"标题",
"phone":[
{
"tel":"124424412345678"
},
{
"tel":"154454410202030"
}
],
"email":[
{
"email":"23124@qq.com"
},
{
"email":"33440944@qq.com"
}
],
"weixin":[
{
"num":"23e4"
}
],
"province":"山东省",
"city":"德州市",
"address":"海淀区",
"note":"备注",
"importSid":"shaocKf44"
}
]
}
响应代码
代码 | 含义 |
200 | 请求成功 |
210 | 用户信息符合要求的保存成功,返回不符合要求的用户信息 |
400 | 请求参数错误 |
403 | 接口访问频次达到上限或者插入用户数据大于500条 |
500 | 服务器错误 |
返回200事例:
{
"code": 200,
"message": "success!",
"id": "dfd01d50-8854-11ea-acd0-d17357355b08"
}
返回210事例:
{
"code": 210,
"message": "has some error data",
"errorData": [
{
"status": "status1",
"source": "谷歌",
"name": "导入用户测试10",
"title": "标题",
"phone": [
{
"tel": "13512345678"
},
{
"tel": "13010202030"
}
],
"email": [
{
"email": "234@qq.com"
},
{
"email": "3444@qq.com"
}
],
"weixin": [
{
"num": "23e4"
},
{
"num": "234"
}
],
"province": "山东省",
"city": "德州市",
"address": "海淀区",
"note": "备注",
"web": "www.xxx.com",
"createTime": "2020-07-18 16:29:59",//创建时间
"lastUpdateTime": "2020-07-18 19:36:30",//最后更新时间
"batchNo": "20180718162916",//批次号
"owner": "8000",//归属坐席工号
"ownerName": "坐席8000",//归属坐席名称
"qq账号": "666666",
"备注": "23344",
"年龄": "123",
"建立时间": "2018-10-09",
"见面次数": "2",
"性格": [
"0",
"2"
],
"性别": "2",
"errMessage": "field 多选 error"
}
]
}
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
或者
{
"code": 403,
"message": "Insert data amount is too many, max insert amount is 100"
}
3.修改用户资料数据接口
-
HTTP请求方式:POST
-
请求url:
{HOST}/v20170418/customer/update/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
-
请求频次限制:20次/每分钟
请求示例:
http://apis.7moor.com/v20170418/customer/update/N00000000556
?sig=3E92F146297FCA751F63493877EC9719
请求体:
字段 | 类型 | 备注 |
customer | Object类型 必填 | _id: 主键 必填 version:版本号 必填 status:用户状态 必填 source:数据来源 owner:归属坐席 stable_fields:固定属性,企业用户和个人用户有差别,具体属性见获取用户资料接口返回值详解 custom_fields:用户自定义属性,具体属性见获取用户资料接口返回值详解 importSid:自定义访客id,用户关联会话用的;如果该用户已经关联了访客则不做更新,返回修改用户资料成功。 |
请求体事例:
{
"customer": {
"_id": "4cf77790-8eb5-11e6-9bef-37ee1675947e",
"version": "201610100019",
"status": "status1",
"source": "谷歌",
"name": "导入用户测试10",
"title": "标题",
"phone": [
{
"tel": "13512345678"
},
{
"tel": "13010202030"
}
],
"email": [
{
"email": "234@qq.com"
},
{
"email": "3444@qq.com"
}
],
"weixin": [
{
"num": "23e4"
},
{
"num": "234"
}
],
"province": "山东省",
"city": "德州市",
"address": "海淀区",
"note": "备注",
"web": "www.xxx.com",
"qq账号": "666666",
"备注": "23344",
"年龄": "123",
"建立时间": "2018-10-09",
"见面次数": "2",
"性格": [
"0",
"2"
],
"性别": "0"
}
}
响应代码:
代码 | 含义 |
200 | 请求成功 |
400 | 请求参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回200事例:
{
"code": 200,
"message": "success!",
"notUpdate": []
}
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
4.删除用户资料数据接口
支持批量删除用户数据
-
HTTP请求方式:POST
-
鉴权方式:接口鉴权
-
请求url:{HOST}/v20170418/customer/delete/{accountId}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
-
频次限制:10次/分钟
-
删除数据限制:每次最多删除500条用户数据
请求示例:
http://apis.7moor.com/v20170418/customer/delete/N00000000556
?sig=3E92F146297FCA751F63493877EC9719
请求体:
字段 | 类型 | 备注 |
ids | String类型数组,必填 | 用户资料数据主键 |
请求体事例:
{
"ids": [
"52163270-8eb5-11e6-9bef-37ee1675947e",
"4cf77790-8eb5-11e6-9bef-37ee1675947e"
]
}
响应代码:
代码 | 含义 |
200 | 请求成功 |
210 | 用户id正确的删除成功,返回错误的用户id |
400 | 请求体参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回200事例:
{
"code": 200,
"message": "success!"
}
返回210事例:
{
"code": 210,
"message": "has some error data",
"errotData": {
"ids": [
"3d1eb8d0-8856-11ea-b780-8d90f14b793"
]
}
}
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
或者
{
"code": 403,
"message": "Delete data amount is too many, max delete amount is 100"
}
5.查询用户资料数据接口
-
HTTP请求方式:POST
-
鉴权方式:接口鉴权
-
请求url:{HOST}/v20170418/customer/select/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
频次限制:20次/每分钟
-
查询数据限制:默认最多返回1000条数据。支持分页查询
请求url:
http://apis.7moor.com/v20170418/customer/select/N00000000556
?sig=3E92F146297FCA751F63493877EC9719
请求体
字段 | 类型 | 备注 |
version | String 必填 | 版本号 |
_id | String 非必填 | 用户主键 |
name | String 非必填 | 公司名称 |
phone | String 非必填 | 联系人电话 |
beginCreateTime | 类型String 格式Date "yyyy-MM-dd" 非必填 | 大于创建时间 |
endCreateTime | 类型String 格式Date "yyyy-MM-dd" 非必填 | 小于创建时间 |
beginLastUpdateTime | 类型String 格式Date "yyyy-MM-dd" 非必填 | 大于最后修改时间 |
endLastUpdateTime | 类型String 格式Date "yyyy-MM-dd" 非必填 | 小于最后修改时间 |
page | int 非必填 默认1 | 查询第几页数据 |
pageSize | int 非必填 默认1000 | 每页数量 |
请求体事例
{
"version": "201610100019",
"_id": "bfab4500-8f5a-11e6-8517-25d9c27afcd7",
"name":"导入用户测试10",
"phone":"13512345678",
"beginCreateTime": "2018-10-11",
"page": 1,
"pageSize": 2
}
响应代码:
代码 | 含义 |
200 | 请求成功 |
400 | 请求体参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回200事例:
{
"code": 200,
"message": "success!",
"data": {
"count": 1,
"customers": [
{
"_id": "c5ccc0e0-c0e8-11ee-81bc-d3aac8860fa8",
"status": "status0",
"name": "测试请忽略",
"title": "",
"phone": [
{
"tel": "13333333333",
"area": "河北秦皇岛"
}
],
"email": [],
"weixin": [],
"province": "四川省",
"city": "成都市",
"district": "锦江区",
"address": "",
"note": "",
"web": "",
"createTime": "2024-02-01 18:00:47",
"lastUpdateTime": "2024-03-18 10:22:33",
"assignTime": "2024-02-01 18:00:47",
"thirdPartyRelationId": "",
"category": "",
"creator": "",
"sysStatus": "待跟进",
"owner": "无归属",
"测试字符串122": "",
"baixintest": "",
"测试时间": "",
"日期": "",
"数据来源1": "",
"测试搜索": "",
"测试下拉框": "",
"会员级别": "",
"dname": "",
"年龄": "",
"产品": [],
"测试xu": "",
"姓名": "",
"性别": "",
"客户注册时间": "",
"客户qq": "",
"联系地址": "",
"电话2222": "",
"测试复选框": [],
"attachs": [] //附件
}
]
}
}
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
6.云客服新增用户资料接口
注意:推送用户资料接口(6、7、8)的contentType不是application/json,而是application/x-www-form-urlencoded
接口详解:
本接口是将在客服系统中创建的用户以一个 json array对象的方式推送给您系统,其中每一个json对象对应一个用户资料信息。
-
请求方式:POST
-
编码方式:UTF-8 , 使用URLDecoder.decode解码
json示例:
[
{
"_id":"c45ef0d0-571b-11e8-b9ea-4d6efe70975e",//用户资料主键ID
"owner": "8096", //拥有该用户资料的坐席
"createTime": "2017-09-14 22:57:34", //创建时间
"creator": "8096", //创建该用户资料的坐席
"lastUpdateTime": "2017-09-14 22:57:34", //上次修改时间
"accountId": "N00000003731", //账号ID
"eventType":"add", //新增
"多行文本": "多行文本文字", // 多行文本类型的自定义字段,值为字符串
"单行文本": "单行文本文字", //单行文本类型的自定义字段,值为字符串
"单选框": "单选框数值", //单选框类型的自定义字段,值为字符串
"复选框": ["复选框数值1","复选框数值2"], //复选框类型的自定义字段,值为数组
"下拉框": "下拉框数值",//下拉框类型的自定义字段,值为字符串
"日期": "2020-09-20",//日期类型的自定义字段,值为字符串
"数据来源": "市场",
"用户状态": "金牌用户",
"公司名称": "北京科技",
"描述": " 北京科技有限公司",
"联系人电话": [
{
"tel": "15223234456",
"memo": "刘先生"
}
],
"联系人邮箱": [
{
"email": "test@7moor.com",
"memo": "杨先生"
}
],
"微信": [
{
"num": "7moor",
"memo": "王先生"
}
],
"chatSessionInfo":{
"seoSource":"搜索来源",
"seoKeywords":"搜索关键字",
"ip":"IP地址",
"fromUrl":"咨询页面url值",
"fromUrlTitle":"咨询页面title"
}
"省": "海南省",
"市": "乐东黎族自治县",
"公司地址": "北京市林萃路",
"公司网站": "http://www,7moor.com",
"附件":[
"https://cc-common-cos.7moor.com/N00000022688/customer/2024-08-07/1722994354468/0.19217627907831777/2222h,png",
"https://cc-common-cos.7moor,com/N80000022688/custmer/2024-08-07/1722994354470/0,16760211772856884/img123.jpg"
]
}
]
示例参数解析:
其中多行文本、单行文本、单选框、复选框、下拉框、日期为自定义字段。公司名称、描述、联系人电话、联系人邮箱、微信、省、市、公司地址、公司网站为固定字段。
返回值:
用户在接受到用户资料后,返回200代表同步成功,400代表同步失败。
我们的事件推送默认支持失败重发,第三方接收消息的接口接收成功后需要返回给我们字符串200 。
如果我们推送后接口返回的值中不是字符串200,我们则认为第三方接口接收失败。进入重发流程,一条失败的消息,会在 10秒、30秒、60秒、600秒 后重发,直到第三方接口返回200。如果这4次重发都失败,我们将不会再重发。重发彻底失败的消息,我们会记录下来,第三方可以找我们索取。
7.云客服修改用户资料接口
-
请求方式:POST
-
编码方式:UTF-8 , 使用URLDecoder.decode解码
json示例:
[
{
"_id":"c45ef0d0-571b-11e8-b9ea-4d6efe70975e",//用户资料主键ID
"owner": "8096", //拥有该用户资料的坐席
"createTime": "2020-09-14 22:57:34", //创建时间
"creator": "8096", //创建该用户资料的坐席
"lastUpdateTime": "2020-09-14 22:57:34", //上次修改时间
"accountId": "N00000003731", //账号ID
"eventType":"update", //事件类型,当前为修改用户资料,即为update
"多行文本": "多行文本文字", // 多行文本类型的自定义字段,值为字符串
"单行文本": "单行文本文字", //单行文本类型的自定义字段,值为字符串
"单选框": "单选框数值", //单选框类型的自定义字段,值为字符串
"复选框": ["复选框数值1","复选框数值2"], //复选框类型的自定义字段,值为数组
"下拉框": "下拉框数值",//下拉框类型的自定义字段,值为字符串
"日期": "2020-09-20",//日期类型的自定义字段,值为字符串
"数据来源": "市场",
"用户状态": "金牌用户",
"公司名称": "北京科技",
"描述": " 北京科技有限公司",
"联系人电话": [
{
"tel": "15223234456",
"memo": "刘先生"
}
],
"联系人邮箱": [
{
"email": "test@7moor.com",
"memo": "杨先生"
}
],
"微信": [
{
"num": "7moor",
"memo": "王先生"
}
],
"chatSessionInfo":{
"seoSource":"搜索来源",
"seoKeywords":"搜索关键字",
"ip":"IP地址",
"fromUrl":"咨询页面url值",
"fromUrlTitle":"咨询页面title"
}
"省": "海南省",
"市": "乐东黎族自治县",
"公司地址": "北京市林萃路",
"公司网站": "http://www,7moor.com",
"附件":[]
}
]
示例参数解析: 其中多行文本、单行文本、单选框、复选框、下拉框、日期为自定义字段。公司名称、描述、联系人电话、联系人邮箱、微信、省、市、公司地址、公司网站为固定字段。
返回值: 用户在接受到用户资料后,返回200代表修改成功,400代表修改失败。
8.云客服删除用户资料接口
-
请求方式:POST
-
编码方式:UTF-8 , 使用URLDecoder.decode解码
json示例:
[
{
"_id":"c45ef0d0-571b-11e8-b9ea-4d6efe70975e",//用户资料主键ID
"eventType":"delete"//事件类型 ,删除
}
]
示例参数解析: 其中id为用户资料主键ID,eventType为当前事件的类型。
返回值: 用户在删除用户资料后,返回200代表修改成功,400代表修改失败。
9.云客服查询联系计划接口
-
HTTP请求方式:POST
-
鉴权方式:接口鉴权
-
请求url:{HOST}/v20170418/customer/queryContactPlan/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
频次限制:20次/每分钟
-
查询数据限制:默认最多返回1000条数据。支持分页查询
请求url:
http://apis.7moor.com/v20170418/customer/queryContactPlan/N00000000556?sig=3E92F146297FCA751F63493877EC9719
请求体
字段 | 类型 | 备注 |
version | String 必填 | 版本号 |
_id | String 必填 | 用户id |
status | String 非必填 | 状态(未完成:’0’,完成:’1‘,取消:’99‘) |
createBeginTime | String 非必填 | 联系计划创建的开始时间 |
createEndTime | String 非必填 | 联系计划创建的结束时间 |
beginTime | String 非必填 | 联系计划通知的开始时间 |
endTime | String 非必填 | 联系计划通知的结束时间 |
page | number;非必填 默认1 | 查询第几页数据 |
pageSize | number 非必填 默认1000 | 每页数量 |
请求体事例
{
"version": "202003180001",
"_id": "045dec65-ad20-45ac-9ec0-b0e79e9857f7"
}
响应代码:
代码 | 含义 |
200 | 请求成功 |
400 | 请求体参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回200事例:
{
"code": 200,
"message": "success!",
"data": {
"count": 1,
"plan": [
{
"_id": "02a2ec90-690b-11ea-997e-2f6787553d48",
"accountId": "N00000024392",
"userId": "7d24bc00-6ae3-11e8-be19-572db9504dae",
"executor": "7d24bc00-6ae3-11e8-be19-572db9504dae",
"remark": "123123",
"notifyTime": "2020-03-18 19:24",
"customerId": "045dec65-ad20-45ac-9ec0-b0e79e9857f7",
"createTime": "2020-03-18 19:24:19",
"lastUpdateTime": "2020-03-18 19:24:19",
"status": "0",
"deal": "1"
}
]
}
}
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
10.云客服查询联系历史接口
-
HTTP请求方式:POST
-
鉴权方式:接口鉴权
-
请求url:{HOST}/v20170418/customer/queryHistory/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
频次限制:20次/每分钟
-
查询数据限制:默认最多返回1000条数据。支持分页查询
请求url:
http://apis.7moor.com/v20170418/customer/queryHistory/N00000000556?sig=3E92F146297FCA751F63493877EC9719
请求体
字段 | 类型 | 备注 |
version | String 必填 | 版本号 |
_id | String 必填 | 用户id |
beginTime | String 非必填 | 要查询的时间段(开始时间) |
endTime | String 非必填 | 要查询的时间段(结束时间) |
type | String 非必填 | 联系历史的类型(全部是空字符串或不填,business,note,chat,email,callin,callout,remoteassist) |
page | number;非必填 默认1 | 查询第几页数据 |
pageSize | number 非必填 默认1000 | 每页数量 |
请求体事例
{
"version": "202003180001",
"_id": "045dec65-ad20-45ac-9ec0-b0e79e9857f7"
}
响应代码:
代码 | 含义 |
200 | 请求成功 |
400 | 请求体参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回200事例:
{
"code": 200,
"message": "success!",
"data": {
"count": 1,
"history": [
{
"_id": "02a2ec90-690b-11ea-997e-2f6787553d48",
"type": "note",
"customer": "045dec65-ad20-45ac-9ec0-b0e79e9857f7",
"createTime": "2020-03-18 19:24:19",
"agent": "7d24bc00-6ae3-11e8-be19-572db9504dae",
"status": "create",
"lastUpdateTime": "2020-03-18 19:24:19",
"comments": "[2020-03-18 19:24]123123",
"beginTime": "2020-03-18 19:24:19",
"endTime": "",
"dispose": "创建计划",
"biUpdateTime": "2020-03-18 19:24:19"
}
]
}
}
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}
11.云客服查询操作日志接口
-
HTTP请求方式:POST
-
鉴权方式:接口鉴权
-
请求url:{HOST}/v20170418/customer/queryOperationLog/{ACCOUNTID}?sig={SIG}
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
频次限制:20次/每分钟
-
查询数据限制:默认最多返回1000条数据。支持分页查询
请求url:
http://apis.7moor.com/v20170418/customer/queryOperationLog/N00000000556?sig=3E92F146297FCA751F63493877EC9719
字段 | 数据类型 | 是否必填 | 备注 |
version | String | 是 | 版本号 |
_id | String | 是 | 用户id |
user | String | 否 | 操作人(""/"system"/"坐席工号") |
type | String | 否 | 类型(全部是""或不填,add:增加用户,import:导入用户,update:更改用户,updateStatus:修改状态,updateOwner:修改归属,updateSource:修改来源,assign:分配用户,batchUpdateStatus:批量修改状态,claim:领取用户,autoAssignPool:自动分配, recycle:自动回收,changePool:转移用户,updateSysStatus:变更跟进状态,mergeCust:合并用户) |
beginTime | String | 否 | 要查询的时间段(开始时间) |
endTime | String | 否 | 要查询的时间段(结束时间) |
page | number | 否;默认1 | 查询第几页数据 |
pageSize | number | 否; 默认1000 | 每页的数量 |
请求体事例
{
"version": "202003180001",
"_id": "045dec65-ad20-45ac-9ec0-b0e79e9857f7"
}
响应代码:
代码 | 含义 |
400 | 请求体参数错误 |
403 | 接口访问频次达到上限 |
500 | 服务器错误 |
返回400事例:
{
"code": 400,
"message": "Please check your parameters"
}
返回403事例:
{
"code": 403,
"message": "Server is busy, max request frequency is 20/min"
}