数据读取类接口 - 友米聚合

读取好友

接口URL:friend

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

以下参数均是可选参数，当不传任何参数情况下，系统会默认返回前20个好友！

参数名	数据类型	是否必须	说明
Wechat_id	int	否	聚合聊天系统微信号ID
Wechat_No	string	否	要查询的微信号
StartTime	string	否	按添加时间查询开始时间（该时间格式时：2018-08-08 10:01:03）
EndTime	string	否	按添加时间查询截止时间（该时间格式时：2018-08-08 10:01:03）
ad_bind_Stime	int	否	按绑定时间查询开始时间（该时间格式时：精确到秒的时间戳）
ad_bind_Etime	int	否	按绑定时间查询截止时间（该时间格式时：精确到秒的时间戳）
ad_updatechatting_Stime	int	否	按最后聊天时间查询开始时间（该时间格式时：精确到秒的时间戳）
ad_updatechatting_Etime	int	否	按最后聊天时间查询截止时间（该时间格式时：精确到秒的时间戳）
Page	int	否	页数（默认1）
PageSize	int	否	每页多少行(默认20)
ad_staff_code	string	否	获取归属某个聚合聊天员工的数据
ad_relation_expand3	int	否	大于最后修改时间的数据，精确到秒的时间戳
ad_relation_isflock	int	否	客户类型（-1所有，0好友，1群，2企业微信个人号，3企业微信群，默认-1）
ad_relation_state	int	否	好友关系状态（-1所有，0有效（可聊天的好友），1主动删除，4被动删除，5主动拉黑，6被动拉黑,默认0查询有效）
ad_wechat_lei	int	否	运营号类型（0 个微、3 企微）
order_by_key	string	否	排序字段；当前支持ad_relation_id、ad_updatechatting_time
order_by_model	string	否	排序方式；支持asc、desc

请求示例

http://《你服务器IP》:5003/v1/friend?Wechat_id=2538

接收返回结果

{
	"msgTime": "2018/5/11 14:32:40",
	"errmsg": 20000,
	"succeed": true,
	"values": {
		"ad_friend_id": 1153549,
		"ad_friend_uwenober": "www_7182453",
		"ad_friend_wenober": "wxid_167px6des5ie22",
		"username": "A宝儿",
		"avatar": "http://wx.qlogo.cn/mmhead/ver_1/15HPPguo4E1bFMkHbSVrd6pY1HXvwRbmawsN57AicLWKwqRJrtjGOdRwlG4vg0Mo0IAG8KicN0tLWhq7vmTRtTw3XawhtOyiaDjRW8JMUoibfBA/132",
		"ad_ring": "{}",
		"ad_expand2": "[]",
		"ad_relation_state": 0,
		"ad_expand": "",
		"ad_expand3": "{\"describe\": \"\"}",
		"ad_relation_remark": "",
		"ad_relation_expand3": 1592895700,
		"ad_relation_isflock":0,
		"ad_wechat_nick": "测试8240",
		"ad_original_nober": "wxid_30tas02fxbfq22",
		"ad_wechat_id": 2538,
		"ad_staff_code": "10000",
		"ad_relation_time": "2018-04-13T18:03:55+08:00",
		"ad_del_time": "2018-04-13T18:03:55+08:00",
		"ad_bind_time": 0,
		"details": "{}",
		"ad_manage_name": "",
		"ad_ditch_name": "",
		"ad_order": "{}",
		"ad_updatechatting_time": "1587893701",
        "ad_request_time": 1587893700,
        "user_moble": null,
        "user_nick": null,
        "user_name": null,
        "user_chenwei": null,
        "user_mobletwo": null,
        "user_moblethree": null,
        "ad_label": ["标签"],
        "ad_relation_addedmode": 0,
        "ad_relation_scene": 30
	}
}

返回结果说明(自定义字段通过好友详情获取)

参数名	数据类型	说明
ad_friend_id	int	1150933(聚合聊天系统专用ID)
ad_friend_uwenober	string	G887009(好友微信更改后微信号)
ad_friend_wenober	string	wxid_ujwy4r6nkjdb22(好友微信原始微信号)
username	string	A宝儿(微信昵称)
avatar	string	http://wx.qlogo.cn/mmhead/ver_1/yVUnQictAnCl21MU2Bma7PI1mHFGJNmFgq8WtARJhA7f89VOialcarvsMxsrNIqMA7Nz6IicF4CWFyg3ARsajrA/96(微信头像)
ad_ring	string	已弃用
ad_expand2	string	["1","2"],选中标签
ad_relation_state	int	0有效（可聊天的好友），1主动删除，4被动删除，5主动拉黑，6被动拉黑
ad_expand	string	10000(绑定员工工号)
ad_expand3	object	描述
ad_relation_remark	string	iiii(备注信息)
ad_relation_expand3	int	最后修改时间（精确到秒的时间戳）
ad_relation_isflock	int	客户类型（0好友，1群）
ad_wechat_nick	string	P5(所属机号)
ad_original_nober	string	wxid_w4ebc6txje66229（所属机号的原始微信号）
ad_wechat_id	int	1906(所属机号ID)
ad_relation_time	2018-03-09T18:24:32+0800	入库时间
ad_del_time	2018-03-09T18:24:32+0800	1主动删除，4被动删除，5主动拉黑，6被动拉黑的操作时间，0有效时该时间无效
ad_bind_time	1523929223	绑定时间
details	object	"{"sex": 2, "city": "广东", "sign": "深圳富士康招聘大量普工长期工、临时工【咨询报名处】·另招代理", "province": "中国"}"
ad_manage_name	string	fff(所属广告名称)
ad_ditch_name	string	ff(所属媒体名称)
ad_order	object	{}(聚合聊天同步的订单信息)
ad_updatechatting_time	int	1587893701（客户最后聊天时间,精确到秒的时间戳）
ad_request_time	int	1587893700
user_moble	string	客户详细资料的电话号码
user_mobletwo	string	客户详细资料的电话号码2
user_moblethree	string	客户详细资料的电话号码2
user_nick	string	客户详细资料的客户昵称
user_chenwei	string	客户详细资料的称谓
user_name	string	真实姓名
ad_label	object	["自动测试224"] (好友微信标签)
ad_relation_addedmode	int	0(加好友方式：-1未知 0你添加对方 1对方添加你)
ad_description	string	好友微信详细描述
ad_relation_scene	int	30(来源)

好友来源说明

 * ad_relation_scene 
 * 来源字段枚举
 
30:通过扫一扫添加
3:通过搜索微信号添加
17:通过名片分享添加
24:27:28:29:通过摇一摇添加
10:13:通过手机通讯录添加
18:通过附近的人添加
25:通过漂流瓶添加
1:通过搜索QQ号添加
8:14:通过群聊添加
15:通过搜索手机号添加
48:雷达
94:对方通过扫一扫添加
67:对方通过搜索微信号添加
74:对方通过手机通讯录添加
78:对方通过群聊添加
82:对方通过附近的人添加
93:对方通过摇一摇添加
81:对方通过名片分享添加
89:对方通过漂流瓶添加
65:对方通过搜索QQ号添加
77:79:对方通过搜索手机号添加

读取好友总数

接口URL:friend/count

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

以下参数均是可选参数

参数名	数据类型	是否必须	说明
Wechat_id	int	否	聚合聊天系统微信号ID
Wechat_No	string	否	要查询的微信号
StartTime	string	否	按添加时间查询开始时间（该时间格式时：2018-08-08 10:01:03）
EndTime	string	否	按添加时间查询截止时间（该时间格式时：2018-08-08 10:01:03）
ad_bind_Stime	int	否	按绑定时间查询开始时间（该时间格式时：精确到秒的时间戳）
ad_bind_Etime	int	否	按绑定时间查询截止时间（该时间格式时：精确到秒的时间戳）
ad_updatechatting_Stime	int	否	按最后聊天时间查询开始时间（该时间格式时：精确到秒的时间戳）
ad_updatechatting_Etime	int	否	按最后聊天时间查询截止时间（该时间格式时：精确到秒的时间戳）
ad_staff_code	string	否	获取归属某个聚合聊天员工的数据
ad_relation_expand3	int	否	大于最后修改时间的数据，精确到秒的时间戳
ad_relation_isflock	int	否	客户类型（-1所有，0好友，1群，2企业微信个人号，3企业微信群，默认-1）
ad_relation_state	int	否	好友关系状态（-1所有，0有效（可聊天的好友），1主动删除，4被动删除，5主动拉黑，6被动拉黑,默认0查询有效）
ad_wechat_lei	int	否	运营号类型（0 个微、3 企微）

请求示例

http://《你服务器IP》:5003/v1/friend/count?Wechat_id=2538

接收返回结果

{
	"msgTime": "2018/5/11 14:32:40",
	"errmsg": 20000,
	"succeed": true,
	"values": 1000
}

返回结果说明(自定义字段通过好友详情获取)

参数名	数据类型	说明
values	int	总条数

好友详情

接口URL:friend/GetDetail

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_friend_wenober	string	是	好友原始微信号/修改后的微信号
ad_wechat_id	int	否	查询机号对应的ID（二选1）
ad_wechat_nober	string	否	查询机号的微信号（二选1）
ad_wechat_lei	int	否	运营号类型（0 个微、3 企微）

请求示例

http://《你服务器IP》:5003/v1/friend/GetDetail?ad_friend_wenober=wxid_cdh8t1ajl8qm22&ad_wechat_id=3308&ad_wechat_lei=0

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-03-11T14:23:49.3410444+08:00",
    "values": {
        "ad_friend_id": 2716147,
        "ad_friend_uwenober": "zznn72537",
        "ad_friend_wenober": "wxid_2yfwlz5fu21922",
        "ad_friend_name": "测试",
        "ad_friend_photo": "http://wx.qlogo.cn/mmhead/ver_1/L9Qqvt4c3Wf20AtTiaKxcLViaibqZHibbpyah1vl8e1KAITtcxNq5XoClLRV4NMY9qUM6UydI1icia2rFThDdcGjMrrX98WYQtgM4FcleC7RDKmCY/96",
        "ad_ring": "{}",
        "ad_expand2": "["1","2"]",
        "ad_relation_addedmode": 0,
        "ad_relation_scene": 30,
        "ad_relation_state": 0,
        "ad_expand": "10000",
        "ad_expand3": "{\"describe\": \"\"}",
        "ad_relation_remark": "",
        "ad_wechat_nick": "P11",
        "ad_original_nober": "wxid_1r8a1mfrbdek22",
        "ad_wechat_id": 3527,
        "ad_staff_code": "5427",
        "ad_relation_time": "2020-03-10T10:53:32+08:00",
        "ad_del_time": "2020-03-10T10:53:32+08:00",
        "ad_bind_time": 0,
        "ad_wechatreply_time":0,
        "details": "{\"sex\": 2, \"city\": \"朝阳\", \"sign\": \"嘎嘎嘎\", \"phoneNum\": \"\", \"province\": \"北京\"}",
        "ad_manage_name": "",
        "ad_updatechatting_time": "1583808812",
        "ad_request_time": 1587893700,
        "ad_ditch_name": "",
        "ad_order": "{}",
        "ad_relation_isflock": 0,
        "ad_relation_expand": "0",
        "ad_relation_expand4": 0,
        "chatroomflag": 0,
        "ad_wechat_nober": "yg1811121",
        "user_moble": null,
        "user_nick": null,
        "user_chenwei": null,
        "user_mobletwo": null,
        "user_moblethree": null，
        "user_name":"张三",
		"ad_label": ["标签"],
		"ad_description": "描述"，
        "ad_relation_adcode"|string|广告码
       "user_extend": "[{\"17\": \"122\"}, {\"16\": \"男女\"}, {\"15\": \"1222\"}, {\"14\": [\"足球\", \"篮球\", \"游泳\"]}, {\"13\": \"2020-06-18\"}, {\"12\": \"122\"}]"
    }
}

返回结果说明

参数名	数据类型	说明
ad_friend_id	int	27161479(聚合聊天系统专用ID)
ad_friend_uwenober	string	zznn72537(微信更改后微信号)
ad_friend_wenober	string	wxid_2yfwlz5fu21922(微信原始微信号)
ad_friend_name	string	测试(微信昵称)
ad_friend_photo	string	http://wx.qlogo.cn/mmhead/ver_1/L9Qqvt4c3Wf20AtTiaKxcLViaibqZHibbpyah1vl8e1KAITtcxNq5XoClLRV4NMY9qUM6UydI1icia2rFThDdcGjMrrX98WYQtgM4FcleC7RDKmCY/96(微信头像)
ad_ring	object	已放弃
ad_expand2	object	["1","2"]，选中标签
ad_relation_addedmode	int	0(加好友方式：-1未知 0你添加对方 1对方添加你)
ad_relation_scene	int	30(来源)
ad_relation_state	int	状态(0有效，1主动删除，4被动删除，5主动拉黑，6被动拉黑）
ad_expand	string	10000(绑定员工工号)
ad_expand3	object	{"describe": ""}
ad_relation_remark	string	iiii(备注信息)
ad_wechat_nick	string	P5(所属机号)
ad_original_nober	string	wxid_w4ebc6txje6622(所属机号的原始微信号)
ad_wechat_id	int	1906(所属机号ID)
ad_staff_code	string	10000(接线员工工号)
ad_relation_time	datetime	2018-03-09T18:24:32+0800
ad_del_time	2018-03-09T18:24:32+0800	1主动删除，4被动删除，5主动拉黑，6被动拉黑的操作时间，0有效时该时间无效
ad_bind_time	int	1523929223(绑定时间,精确到秒的时间戳）
ad_wechatreply_time	int	0(运营号最后聊天时间，精确到秒的时间戳)
details	object	"{"sex": 2, "city": "广东", "sign": "深圳富士康招聘大量普工长期工、临时工【咨询报名处】·另招代理", "province": "中国"}"(微信上的详细信息)
ad_updatechatting_time	int	1583808812(客户最后聊天时间,精确到秒的时间戳）
ad_request_time	int	1587893700（客户申请时间,精确到秒的时间戳）
ad_manage_name	string	fff(所属广告名称)
ad_ditch_name	string	ff(所属媒体名称)
ad_order	object	{}(聚合聊天同步的订单信息)
ad_relation_isflock	int	0(客户类,0好友，1群)
ad_relation_expand4	int	0(0微信号，1公众号，2小程序)
chatroomflag	int	0
ad_wechat_nober	int	yg1811121(运营机微信号)
user_moble	string	客户详细资料的电话号码
user_mobletwo	string	客户详细资料的电话号码2
user_moblethree	string	客户详细资料的电话号码2
user_nick	string	客户详细资料的客户昵称
user_chenwei	string	客户详细资料的称谓
user_name	string	真实姓名
ad_label	object	["自动测试224"] (好友微信标签)
ad_description	string	描述
ad_relation_adcode	string	广告码
user_extend	object	自定义字段返回数据（根据自定义字段接口列表取出相对应的值）

好友来源说明

 * ad_relation_scene 
 * 来源字段枚举
 
30:通过扫一扫添加
3:通过搜索微信号添加
17:通过名片分享添加
24:27:28:29:通过摇一摇添加
10:13:通过手机通讯录添加
18:通过附近的人添加
25:通过漂流瓶添加
1:通过搜索QQ号添加
8:14:通过群聊添加
15:通过搜索手机号添加
48:雷达
94:对方通过扫一扫添加
67:对方通过搜索微信号添加
74:对方通过手机通讯录添加
78:对方通过群聊添加
82:对方通过附近的人添加
93:对方通过摇一摇添加
81:对方通过名片分享添加
89:对方通过漂流瓶添加
65:对方通过搜索QQ号添加
77:79:对方通过搜索手机号添加

聊天历史

接口URL:ChatMess

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_friend_wenober	string	否	好友原始微信号（如果不传即所有聊天记录）
ad_wechat_id	int	否	机号ID
startDate	int	否	聊天记录开始时间(精确到秒的时间戳)
endDate	int	否	聊天记录结束时间(精确到秒的时间戳)
ad_chatting_id	int	否	聊天编号（传入即查询大于该聊天编号的数据）
page	int	否	页数(默认1)
pagesize	int	否	每页多少条（默认10）

请求示例

http://《你服务器IP》:5003/v1/ChatMess?ad_friend_wenober=wxid_ujwy4r6nkjdb22&ad_wechat_id=1906

接收返回结果


{
    msgTime: {2018/5/11 14:47:48}
    errmsg: 20000
    succeed: true
    values: {[
  {
    "ad_chatting_talter": "wxid_ujwy4r6nkjdb22",
    "ad_chatting_issend": 1,
    "ad_chatting_resvred": null,
    "ad_wechat_id": 1906,
    "merchantid": "333513091",
    "ad_chatting_updatetime": "2018-04-26T16:23:21.838195+08:00",
    "ad_chatting_sate": 3,
    "ad_sermsgid": "1524730993715m",
    "ad_chatting_time": "1524730993",
    "ad_chatting_content": "imgs[6d1472bf5f6cebbcd013d89c68a461111524730993]",
    "ad_staff_code": "10000",
    "ad_friend_photo": "http://wx.qlogo.cn/mmhead/ver_1/yVUnQictAnCl21MU2Bma7PI1mHFGJNmFgq8WtARJhA7f89Z0VOialcarvsMxsrNIqMA7Nz6IicF4CWFyg3ARsajrA/96",
    "ad_friend_name": "心赠于你w",
    "ad_expand": "0"，
    "ad_wechat_nober": "wcy_candice2"
  },
  {
    "ad_chatting_talter": "wxid_ujwy4r6nkjdb22",
    "ad_chatting_issend": 0,
    "ad_chatting_resvred": null,
    "ad_wechat_id": 1906,
    "merchantid": "333513091",
    "ad_chatting_updatetime": "2018-04-18T10:01:00.784618+08:00",
    "ad_chatting_sate": 1,
    "ad_sermsgid": "348722752404833281",
    "ad_chatting_time": "1524016859",
    "ad_chatting_content": "早上好",
    "ad_staff_code": null,
    "ad_friend_photo": "http://wx.qlogo.cn/mmhead/ver_1/yVUnQictAnCl21MU2Bma7PI1mHFGJNmFgq8WtARJhA7f89Z0VOialcarvsMxsrNIqMA7Nz6IicF4CWFyg3ARsajrA/96",
    "ad_friend_name": "心赠于你w",
    "ad_expand": "0"，
    "ad_wechat_nober": "wcy_candice2"
  },
  {
    "ad_chatting_talter": "wxid_ujwy4r6nkjdb22",
    "ad_chatting_issend": 1,
    "ad_chatting_resvred": null,
    "ad_wechat_id": 1906,
    "merchantid": "333513091",
    "ad_chatting_updatetime": "2018-04-17T21:42:59.897157+08:00",
    "ad_chatting_sate": 1,
    "ad_sermsgid": "1497183686434128180",
    "ad_chatting_time": "1523972438",
    "ad_chatting_content": "晚上好[嘿哈]",
    "ad_staff_code": "10000",
    "ad_friend_photo": "http://wx.qlogo.cn/mmhead/ver_1/yVUnQictAnCl21MU2Bma7PI1mHFGJNmFgq8WtARJhA7f89Z0VOialcarvsMxsrNIqMA7Nz6IicF4CWFyg3ARsajrA/96",
    "ad_friend_name": "心赠于你w",
    "ad_expand": "0"，
    "ad_wechat_nober": "wcy_candice2"
  }
]}
}

返回结果说明

参数名	数据类型	说明
ad_chatting_id	long	聊天编号
ad_chatting_talter	string	wxid_ujwy4r6nkjdb22(发送的好友原始微信号)
ad_chatting_issend	string	0(0客户发送信息，1运营机发送消息）
ad_chatting_resvred	string	(内容格式默认null)
ad_wechat_id	int	1906（运营机编号）
ad_chatting_updatetime	datetime	2018-04-11T10:08:37.847551+08:00(入库时间)
ad_chatting_sate	int	1(信息状态)
ad_sermsgid	int	728806287326258317m(信息唯一ID)
ad_chatting_time	int	1523412516(聊天时间)
ad_chatting_content	string	给你04月11日的朋友圈<人民网北京4月11日电（邢郑）据国家市场监管总局网站显示...>\n点赞(聊天内容)
ad_staff_code	string	null(当是自己发送的时候会产生工号)
ad_friend_photo	http://wx.qlogo.cn/mmhead/	用户头像
ad_friend_name	心赠于你w	用户名称
ad_expand	int	是否已读（0已读，1未读，主要针对语音)
ad_wechat_nober	string	运营机微信号
ad_voice_txt	string	语音转文本内容

信息状态说明

CDN资源访问：http://ttimg.agsoft.net/商家编号/chatRes/对应的key

类型	含义	ad_chatting_content格式	ad_chatting_resvred格式（urlDecode解码）
1	文本
2/3/4	图片	imgs[图片KEY]；需要查看大图时：key_hd，助手必须打开自动查看原图或客户端发送查看大图的任务
4/34	语音	audio[语音KEY]或audioT[语音KEY]	{"downloadKey":"语音文件","type":-1,"videoLen":语音长度（秒）}
42	名片	MP[联系人昵称]	{"nickname":"名片名称"}
48	位置	a(位置链接)	{"desc":"详细地址","thumbUrl":"缩略图","title":"位置标题","url":"位置链接"}
49	链接	a(链接地址)	{"title":"链接标题","url":"链接地址"}
50	视频聊天
495	群聊邀请		{"desc":"邀请描述","thumbUrl":"缩略图","title":"邀请标题","url":"邀请链接"}
496	文件	file[文件KEY]	{"title":"文件名称","totalLen":文件大小,"url":""}
1001	分享名片
4919	聊天记录转发
4933	小程序		{"appIconUrl":"小程序小图标","displayName":"小程序名称","downloadKey":"小程序封面KEY","title":"小程序标题"}
4362	群收款,群红包,红包
7549	视频号		{"avatar":"视频号头像","description":"视频号描述","nickname":"视频号名称","thumbUrl":"封面缩略图"}
8220	引用		{"type":"消息类型,与原有消息类型一致,代表引用的是什么类型的消息","content":"引用的消息的文本内容","title":"文件和链接消息的标题","downloadKey":"需要下载资源的消息(图片视频文件)","url":"链接消息的url"}
9730	直播		{"avatar":"直播头像","description":"直播描述","nickname":"直播名称","thumbUrl":"封面缩略图"}
10000	系统消息
10001	标识符更新
10002	好友验证
10003	好友申请
10004	异常通知
10005	实名信息
11001	待办消息
12001	托管消息		{"key":"托管标识","name":"申请人昵称","reason":"申请理由"}

统计员工发送文本消息关键字数量

接口URL:staff/GetKeywordDataByStaff

请求方式：Post

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_staff_code_list	array	否	员工列表
depart_id	int	否	部门ID
depart_group_id	int	否	分组ID
start_time	int	否	聊天记录开始时间(精确到秒的时间戳)
end_time	int	否	聊天记录结束时间(精确到秒的时间戳)
keyword	string	是	统计关键字

请求示例

{
	"ad_staff_code_list": [],
	"depart_id": 0,
	"depart_group_id": 0,
	"start_time": 0,
	"end_time": 0,
	"keyword": "好"
}

接收返回结果


{
  "requestId": null,
  "errmsg": 20000,
  "succeed": true,
  "msgTime": "2023-01-03T17:05:53.0614882+08:00",
  "values": [
    {
      "ad_staff_code": "S01",
      "ad_staff_name": "S01",
      "departname": "技术部",
      "departgroupname": "开发一组",
      "start_time": "2023-01-02 00:00:00",
      "end_time": "2023-01-03 00:00:00",
      "keyword": "好",
      "fans_count": 10,
      "keyword_count": 20
    },
    {
      "ad_staff_code": "10000",
      "ad_staff_name": "10000",
      "departname": "技术部",
      "departgroupname": "开发二组",
      "start_time": "2023-01-02 00:00:00",
      "end_time": "2023-01-03 00:00:00",
      "keyword": "好",
      "fans_count": 89,
      "keyword_count": 190
    }
  ],
  "errdesc": null
}

返回结果说明

参数名	数据类型	说明
ad_staff_code	string	员工编号
ad_staff_name	string	员工名称
depart_name	string	部门名称
depart_group_name	string	分组名称
start_time	string	开始时间
end_time	string	结束时间
keyword	string	关键字
fans_count	int	发送粉丝数量
keyword_count	int	关键字数量

加好友结果

==该接口结果每刷新一次会删除一次当前获取到的结果==

接口URL:friend/Get_Friend

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

暂无

请求示例

http://《你服务器IP》:5003/v1/friend/Get_Friend

接收返回结果

{ msgTime: 2018/5/11 14:32:40
    errmsg: 20000
    succeed: true
    values: [{
  "friendList": [
    {
      "phoneNum": "yyyy",
      "wechatId": "scyule888",
      "type": 1
    },
    {
      "phoneNum": "yyyy",
      "wechatId": "scyule888",
      "type": 1
    },
    {
      "phoneNum": "yyyy",
      "wechatId": "scyule888",
      "type": 1
    }
  ]
},{
  "friendList": [
    {
      "phoneNum": "yyyy",
      "wechatId": "scyule888",
      "type": 1
    },
    {
      "phoneNum": "yyyy",
      "wechatId": "scyule888",
      "type": 1
    },
    {
      "phoneNum": "yyyy",
      "wechatId": "scyule888",
      "type": 1
    }
  ]
}]}

返回结果说明

参数名	数据类型	说明
phoneNum	string	自定义ID
wechatId	string	好友微信号
type	int	类型（1.对方已通过 2.任务执行失败 3.等待验证 4.已是好友 5.未开通微信 6.被搜帐号异常 7.操作过于频繁 8.好友申请发送失败）

好友重复记录

接口URL:friend/Get_RedFaind

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_friend_wenober	string	是	好友原始微信号/修改后的微信号
wechat_lei	int	是	运营号类型；默认为0；0=个微、3=企微

请求示例

http://《你服务器IP》:5003/v1/friend/Get_RedFaind?ad_friend_wenober=wxid_lohgmuo9i3a012

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-06-19T18:27:36.6541257+08:00",
    "values": [
        {
            "ad_wechat_nick": "P10",
            "ad_wechat_id": 3526,
            "ad_wechat_nober": "yg181112",
            "ad_friend_wenober": "wxid_lohgmuo9i3a012",
            "ad_friend_uwenober": "soso7657",
            "ad_expand": "MetalHeart",
             "ad_relation_time": "2022-11-16T14:22:12"
        },
        {
            "ad_wechat_nick": "P11",
            "ad_wechat_id": 3527,
            "ad_wechat_nober": "yg1811121",
            "ad_friend_wenober": "wxid_lohgmuo9i3a012",
            "ad_friend_uwenober": "soso7657",
            "ad_expand": "b08",
            "ad_relation_time": "2022-03-23T21:04:06"
        },
        {
            "ad_wechat_nick": "P13",
            "ad_wechat_id": 3520,
            "ad_wechat_nober": "cs88ag",
            "ad_friend_wenober": "wxid_lohgmuo9i3a012",
            "ad_friend_uwenober": "soso7657",
            "ad_expand": "MetalHeart",
            "ad_relation_time": "2020-08-07T10:41:59"

        }
    ],
    "errdesc": null
}

返回结果说明

参数名	数据类型	说明
ad_wechat_nick	string	运营号机号
ad_wechat_id	int	运营机编号
ad_wechat_nober	string	运营机微信号
ad_friend_wenober	string	好友原始微信号
ad_friend_uwenober	string	好友修改后微信号
ad_expand	string	归属员工（对应聚合聊天员工）
ad_relation_time	DateTime	添加时间

群资料

接口URL: friend/Getchatroom

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_wechat_id	int	是	运营号编号
ad_chatroom_name	string	是	群号

请求示例

http://《你服务器IP》:5003/v1/friend/Getchatroom?ad_chatroom_name=2315551176@chatroom&ad_wechat_id=3533

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2019-12-12T17:22:06.2327781+08:00",
    "values": {
        "ad_chatroom_name": "22315551176@chatroom",
        "ad_chatroom_memberlist": "wxid_w4ebc6txje6622;wxid_3qh9x1bq12je22;wxid_sm1x4gk37ten22",
        "ad_wechat_id": 3533,
        "ad_chatroom_real_displayname": "[\"嘿撒丽娜\", \"自动测试196\", \"WatsonLiufu\"]",
        "exist_frend": "[\"wxid_3qh9x1bq12je22\",\"wxid_sm1x4gk37ten22\",\"wxid_w4ebc6txje6622\"]",
        "ad_chatroom_notice": ""，
        "ad_wechat_nober": "dong23287",
        "ad_chatroom_qrcode": "wxid_6oygtisfn89122mmqrcode1619330917997.png",
        "ad_chatroom_qrcodedate": 1619330918
    }
}

返回结果说明

参数名	数据类型	说明
ad_chatroom_name	string	群号
ad_chatroom_memberlist	string	群成员原始微信号
ad_wechat_id	int	运营号编号
ad_chatroom_real_displayname	string	群显示名字（数组,与ad_chatroom_memberlist一对一对应）
exist_frend	string	运营号已存在群好友的原始微信号
ad_chatroom_notice	string	群公告
ad_wechat_nober	string	运营号
ad_chatroom_qrcode	string	群二维码(url地址:http://ttimg.agsoft.net/商家编号/other/群二维码key)
ad_chatroom_qrcodedate	string	群二维码获取时间（群二维码获取时间，群二维码获取之后7天内有效）

好友申请通知

接口URL:NotificAtion

请求方式：Get

Headers:

access_token:token
Content-type: text/json

请求参数

参数名	数据类型	是否必须	说明
startDate	string	否	最后修改开始时间（格式:2018-10-10 12:00:00）
endDate	string	否	最后修改结束时间（格式:2018-10-10 12:00:00）
qStartDate	string	否	好友申请开始时间（格式:2018-10-10 12:00:00）
qEndDate	string	否	好友申请结束时间（格式:2018-10-10 12:00:00）
wechat_no	string	否	运营号微信号
notification_deviceid	string	否	运营号机号
notification_stte	int	否	状态（默认-1全部，0未通过，1已通过）
page	int	否	页数(默认第1页)
pagesize	int	否	每页多少个（默认20）

请求示例

http://《你服务器IP》:5003/v1/NotificAtion?startDate=2020-01-01

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2018-05-11T15:40:14.1523923+08:00",
    "values": [
    {
      "notification_upid": 135389,
      "notification_title": null,
      "notification_instructions": null,
      "notification_deviceId": null,
      "notification_datetime": 1523359156496,
      "notification_extend": "{\"sex\": 0, \"city\": \"\", \"sign\": \"\", \"alias\": \"\", \"sayHi\": \"我是夏日星\", \"scene\": 3, \"status\": 1, \"deviceId\": \"测试1278\", \"nickname\": \"夏日星座\", \"province\": \"\", \"username\": \"wxid_d9oq2mmvro9h22\", \"requestTime\": 1523360512075, \"smallheadimgurl\": \"\", \"lastModifiedTime\": 1523360512075}",
      "notification_accept": "[\"10000\", \"10005\", \"MetalHeart\"]",
      "notification_deal_saffcode": null,
      "notification_dealtime": "2018-04-10T19:19:17+08:00",
      "notification_id": "3602ab822cfa00fc3ca01ed6f93a11c1",
      "notification_type": 0,
      "notification_stte": 1,
      "notification_updatedatetime": 1523360512075,
      "notification_deviceid": "测试1278",
      "merchantid": "333513091",
      "ad_wechat_id": "wxid_banxmzfo0z6c51"
    },
    {
      "notification_upid": 135389,
      "notification_title": null,
      "notification_instructions": null,
      "notification_deviceId": null,
      "notification_datetime": 1523359156496,
      "notification_extend": "{\"sex\": 0, \"city\": \"\", \"sign\": \"\", \"alias\": \"\", \"sayHi\": \"我是夏日星\", \"scene\": 3, \"status\": 1, \"deviceId\": \"测试1278\", \"nickname\": \"夏日星座\", \"province\": \"\", \"username\": \"wxid_d9oq2mmvro9h22\", \"requestTime\": 1523360512075, \"smallheadimgurl\": \"\", \"lastModifiedTime\": 1523360512075}",
      "notification_accept": "[\"10000\", \"10005\", \"MetalHeart\"]",
      "notification_deal_saffcode": null,
      "notification_dealtime": "2018-04-10T19:19:17+08:00",
      "notification_id": "3602ab822cfa00fc3ca01ed6f93a11c1",
      "notification_type": 0,
      "notification_stte": 1,
      "notification_updatedatetime": 1523360512075,
      "notification_deviceid": "测试1278",
      "merchantid": "333513091",
      "ad_wechat_id": "wxid_banxmzfo0z6c51"
    }]
}

返回结果说明

参数名	数据类型	说明
notification_upid	long	ID
notification_title	string	好友标题
notification_extend	object	好友申请参数
notification_accept	object	申请通知员工
notification_deal_saffcode	string	最后操作员工号
notification_dealtime	string	员工操作时间
notification_stte	int	申请状态（0未通过，1已通过）
notification_updatedatetime	long	记录最后更新时间(精确到毫秒)
notification_deviceid	string	运营机号
ad_wechat_id	string	运营号原始微信号

notification_extend 说明

参数名	说明
sex	性别
city	城市
alias	地区
sayHi	打招呼语
scene	好友申请来源
nickname	好友昵称
requestTime	申请时间(精确到毫秒)

好友朋友圈

接口URL: Circle

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
page	int	是	页数
pagesize	int	是	每页多少条
ad_friend_wenober	string	否	好友微信号（如果不传即所有好友朋友圈）
ad_friend_lei	int	是	（0运营号朋友圈，1客户朋友圈）
ad_original_nober	string	否	运营机原始微信号（如果选择查看运营号朋友圈，运营机原始微信号必填）
ad_snsid	string	否	朋友圈编号

请求示例

http://《你服务器IP》:5003/v1/Circle?page=1&pagesize=100&ad_friend_lei=1

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-06-22T21:05:18.8942876+08:00",
    "values": [
        {
            "ad_snsid": "-5085121991862439777",
            "ad_friend_wenober": "wxid_dzeql6nahq7l22",
            "ad_client_content": "{\"url\": \"http://www.bdrfqs.cn/QTpC/tykkebtucfgeurihxzl.html?from=groupmessage&from=groupmessage#\", \"title\": \"奇闻：这是中国最邪门的18个神秘事件，至今无法解释，看过都不敢相信！\", \"imgUrl\": [], \"content\": \"三个头乌龟🐢 乌龟王八蛋谁见过！马上开开眼界吧[强][强][强][强][强][强]\"}",
            "ad_type": 3,
            "ad_createtime": 1592829475,
            "ad_comment": "[]",
            "ad_friend_photo": "http://wx.qlogo.cn/mmhead/ver_1/iaueg1bHsibfln5yUVGAG7nE47iawu4KoA8lMUQicttrGOfdlwJAbJGehUvyFqprmnZB8aFkJyBMwbQufJBbiadUTicXCS3VqaCBM3B4FzmOtXUac/96",
            "ad_friend_name": "何润发",
            "ad_friend_lei": 1,
            "ad_wechat_id": 34780,
            "ad_wechat_nick": "P05",
            "ad_wechat_nober": "dong23287",
            "ad_original_nober": "wxid_w4ebc6txje6622",
            "ad_relation_remark": "",
            "ad_friend_id": 2723890
        },
        {
            "ad_snsid": "-5085127561539407700",
            "ad_friend_wenober": "wxid_y3048qbey11921",
            "ad_client_content": "{\"imgUrl\": [\"13361616512538980545\", \"13361616512573976739\"], \"content\": \"村里有个姑娘叫小莉，长得不好看却善良😂\\n开播💗\"}",
            "ad_type": 1,
            "ad_createtime": 1592828811,
            "ad_comment": "[]",
            "ad_friend_photo": "http://wx.qlogo.cn/mmhead/ver_1/cv5xnaWCLf3ib8R28kfO0uXrC0OsKcry2oPHkIxIIuI674HjXztopN1PewYuYDuv30ePibhTCLwJ6dBvum1ia2rc3MDVXgFvZS4LtvgkpoCBZ8/96",
            "ad_friend_name": "宝藏莉妹",
            "ad_friend_lei": 1,
            "ad_wechat_id": 34780,
            "ad_wechat_nick": "P05",
            "ad_wechat_nober": "dong23287",
            "ad_original_nober": "wxid_w4ebc6txje6622",
            "ad_relation_remark": "A🌸小莉",
            "ad_friend_id": 2724832
        }]
}

返回结果说明

参数名	数据类型	说明
ad_snsid	string	朋友圈编号
ad_friend_wenober	string	朋友圈好友微信号
ad_client_content	string	朋友圈内容,
ad_type	int	朋友圈类型（1: 图片,2: 文字,3: 链接,4: 音乐，15：视频）
ad_createtime	int	朋友圈发布时间(精确到秒的时间戳)
ad_comment	object	朋友圈评论和点赞，朋友圈回复他人评论
ad_friend_photo	string	朋友圈好友头像
ad_friend_name	string	朋友圈好友昵称
ad_friend_lei	int	0运营号朋友圈，1客户朋友圈
ad_wechat_id	int	运营号编号
ad_wechat_nick	string	运营号机号
ad_wechat_nick	string	运营号微信号
ad_original_nober	string	运营号原始微信号
ad_relation_remark	string	朋友圈好友备注
ad_friend_id	int	朋友圈好友编号

投放组新增的客户总数

请求url：AdManage/GetFanTotalBybrand
请求方式：post  FromBody提交

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_brand_id	int	是	投放组编号
notinvalid	int	否	是否忽略归属给无效工号的客户。0否，1是。默认值0
requeststarttime	int	否	客户申请开始时间，时间戳精确到秒(不传时间会是该投放组投放广告相应状态的开始时间)
requestendtime	int	否	客户申请结束时间，时间戳精确到秒(不传时间会是该投放组投放广告相应状态的结束时间)
ad_wechat_id	json数组	否	该投放组的微信号唯一标识集合
ad_wechat_nick	json数组	否	该投放组的机号集合
ad_wechat_nober	json数组	否	该投放组的微信号集合
ad_manage_sate	int	否	广告状态（0只查上线状态的新增客户数，1只查下线状态的新增客户数，2所有）

请求示例

{
    "ad_brand_id": 145,
    "notinvalid": 0,
    "requeststarttime": "1554048000",
    "requestendtime":1569759391,
    "ad_wechat_id": [
        "3430",
        "3350"],
    "ad_wechat_nick":[
        "P06",
        "P07"],
    "ad_wechat_nober":[
        "kkk368555",
        "yg1811261"],
    "ad_manage_sate":0
}

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2019-09-30T09:24:27.3668159+08:00",
    "values": 123
}

返回结果说明

参数名	数据类型	说明
values	int	总数

转账/红包列表

接口URL:ChatMess/TransferList

请求方式：Get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

以下参数均是可选参数，当不传任何参数情况下，系统会默认返回前20个好友！

参数名	数据类型	是否必须	说明
type	int	是	类型,0：收款列表，1：收红包列表，2：转账列表，3：发红包列表
startDate	string	否	开始日期，默认当天日期
endDate	string	否	结束日期，默认当天日期
page	int	否	页码，默认1
pageSize	int	否	页面大小，默认20
handled	string	否	是否处理，-1：全部，true：已处理，false：未处理，默认-1(注意是字符串类型)
weChat	string	否	收/付款方微信
friendName	string	否	客户昵称
friendRemark	sring	否	客户备注
handledRemark	string	否	处理备注
state	int	否	处理状态 -1：全部， 0：未收， 1：已收， 2：过期，3：已退

请求示例

{
	"type": 0,
	"startDate": "2021-03-15",
	"endDate": "2021-03-15",
	"page": 1,
	"pageSize": 20,
	"handled": "-1",
	"weChat": "微信号"，
	"friendName": "昵称"，
	"friendRemark": "备注",
	"handledRemark"L "处理备注",
	"state": -1
}

接收返回结果

[{
	"ad_we_transfer_id": 719130,
	"ad_wechat_id": 34783,
	"ad_wechat_talter": "Zhangzhongren814",
	"ad_wechat_money": 0.00,
    "ad_wechat_type":0,
	"ad_wechat_operationtime": "2020-07-22T15:48:23+08:00",
    "ad_wechat_time":"2020-07-22T15:48:23+08:00",
	"ad_wechat_view": true,
    "ad_wechat_text":"100",
	"ad_wechat_nober": "zvzv9223",
	"ad_wechat_nick": "P01",
	"ad_friend_name": "xiaorenzi",
	"ad_friend_uwenober": "",
	"ad_wechat_remark": "163233",
	"ad_wechat_state": 2,
	"ad_relation_remark": "xiaorenziu"
}]

返回结果说明

参数名	数据类型	说明
ad_we_transfer_id	int
ad_wechat_id	int	微信表id
ad_wechat_talter	string	客户微信号
ad_wechat_money	double	金额
ad_wechat_type	int	0：收款列表，1：收红包列表，2：转账列表，3：发红包列表类）
ad_wechat_operationtime	string	聊天时间
ad_wechat_time	string	入库时间
ad_wechat_view	bool	是否处理
ad_wechat_text	string	记录备注
ad_wechat_nober	string	运营机微信号
ad_wechat_nick	string	所属机号
ad_friend_name	string	客户昵称
ad_friend_uwenober	string	好友微信更改后微信号
ad_wechat_remark	string	客户备注
ad_wechat_state	int	转账/红包状态，0：未收，1：已收，2：过期，3：已退
ad_relation_remark	string	处理状态

获取设备设置

接口URL: Helper/GetHelperSetUp

请求方式：get

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
page	int	否	默认为1
pagesize	int	否	默认为10
orderby	string	否	需要排序的字段，默认为settingtime
sort	string	否	排序类型,asc：升序，desc：降序，默认为desc
ad_original_nober	string	否	原始微信号

请求示例

http://《你服务器IP》:5003/v1/Helper/GetHelperSetUp?page=1&pagesize=10&ad_original_nober=wxid_1uj53oslpos422

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-09-08T20:54:47.6687419+08:00",
    "values": "操作成功",
    "errdesc": null
}

返回结果说明

参数名	数据类型	说明
succeed	bool	true成功，false失败
msgTime	DateTime	信息返回时间
values	object	返回的数据

values字段说明

参数名	数据类型	说明
ad_original_nober	string	原始微信号
ad_upgrade_time	DateTime	助手升级时间
merchantid	string	商家编号
ad_submit_time	DateTime	提交升级时间
settingbeanJson	Object	好友设置详情
accessibilitystatus	int	任务状态
settingtime	DateTime	最后获取设置时间
balancetime	DateTime	获取余额时间
wxpluginversioncode	int	拓展功能插件版本号
wxpluginversionname	string	拓展功能插件版本名称
manufacturer	string	手机生产商
remainingEnergy	int	电量 -1:未知
remainingTelCharge	int	手机余额 -2:未知,-1:获取失败
remainingChatRecord	int	待上传数据 -1:未知
wxState	int	微信状态 -1:未知,0:未安装,1:未登录,2:未授权,3:数据解析错误,4:已授权
accServiceState	int	行为服务状态 -1:未知,0:不支持,1:未开启,2:异常,3:暂停,4:正常
dataServiceState	int	数据服务状态 -1:未知,0:异常,1:正常
versionName	string	微助手版本名称
versionCode	int	微助手版本号 -1:未知
wxVersionName	string	微信版本名称
wxVersionCode	int	微信版本号 -1:未知
deviceModel	string	设备型号
deviceManufacturer	string	设备制造商
deviceImei	string	设备唯一码
enterpriseMode	int	企业模式 -1:未知,0:不支持,1:未激活,2:已激活

settingbeanJson 字段说明

参数名	数据类型	说明 1：是，0：否
friendRequest	int	自动通过好友申请设置
gathering	int	是否打开红包/转账
autoCutVideo	int	自动挂断语音和视频会话
autoAcc	int	自动开启行为服务
autoOpenImg	int	自动查看原图/视频
autoRebootPhone	int	自动重启手机
frsBean	object	好友设置详情
masRateBean	object	群发频率
momentsBean	object	朋友圈设置
autoUpgradeBean	object	自动升级
autoRemarkBean	object	通过好友后自动备注
addContactsBean	object	通讯录加好友
adminSettingsBean	object	管理员设置
runPatternBean	object	运行模式
operationBean	object	操作设置
autoReplyCollectionBean	object	自动整理好友申请记录（开启可提高通过好友的频率）
chatRoomBean	object	群聊相关
activeWxBean	object	活跃微信号

frsBean 好友设置详情字段说明

参数名	数据类型	说明 1：是，0：否
autoReply	int	通过后自动回复
autoReplyContent	string	自动回复详情/转账
date	string	自动回复的日期（周一至周日）
trimRequestRecord	int	整理好友记录
passFansMaxFailureCount	int	好友申请允许最大连续失败
useAutoReplyInitiativeContent	int	使用主动通过好友的自动回复内容
passRateBean	object	好友通过频率

passRateBean 好友通过频率详情字段说明

参数名	数据类型	说明
dayMax	int	一天最多通过多少个好友
hourMax	int	一小时最多通过多少个好友
minMax	int	一分钟最多通过多少个好友

masRateBean 群发频率详情字段说明

参数名	数据类型	说明
dayMax	int	一天最多群发多少条
hourMax	int	一小时最多群发多少条
minMax	int	一分钟最多群发多少条

momentsBean 朋友圈设置详情字段说明

参数名	数据类型	说明 1：是，0：否
refreshMoment	int	自动刷新朋友圈
refreshMomentsImg	int	自动获取朋友圈图片
refreshMomentsSingle	int	自动刷新新进好友朋友圈
uploadMoments	int	上传朋友圈数据

autoUpgradeBean 自动升级详情字段说明

参数名	数据类型	说明 1：是，0：否
autoReply	int	是否自动升级
autoUpgradeTimeBlock	string	自动升级时间段,此字段为JSON数组的字符串形式，其中元素为对象，包含以下字段：startTime: 整型，开始时间，时间戳剥离日期部分,endTime: 整型，结束时间，为时间戳剥离日期部分
autoUpgradeWx	int	微信自动升级

autoRemarkBean 通过好友后自动备注详情字段说明

参数名	数据类型	说明 1：是，0：否
autoRemark	int	自动添加备注是否打开
definedRemarkPart1	string	自定义内容1
definedRemarkPart2	string	自定义内容2
definedRemarkPart3	string	分隔符
autoRemarkOrder	string	自动添加备注排序数组

addContactsBean 通讯录加好友详情字段说明

参数名	数据类型	说明 1：是，0：否
addContacts	int	通讯录加好友
startTime	long	通讯录加好友开始时间（时间）
endTime	long	通讯录加好友结束时间（时间）
maxCount	int	每天最多执行
onceCount	int	每次执行最多添加
remarkPhoneNum	int	使用手机号码备注
autoReplyInitiative	int	好友通过后自动回复
useAutoReplyContent	int	使用好友申请的自动回复内容
autoReplyInitiativeContent	string	主动加好友后通过后自动回复详情

adminSettingsBean 管理员设置详情字段说明

参数名	数据类型	说明 1：是，0：否
adminCipher	stirng	管理员密码
deniedUninstall	int	微助手防卸载
settingsLock	int	微助手设置锁定
callRecord	int	强制通话录音
deniedSendKeyword	int	拦截含有监控关键字的任务
inspectSensitiveBothway	int	双向监控聊天关键字
deniedDeleteChatRecord	int	是否允许删除消息

runPatternBean 运行模式详情字段说明

参数名	数据类型	说明
runPattern	int	运行模式,0数据分析，1聚合聊天，2快速通过好友
resetSettings	int	初始化设置为默认设置

operationBean 操作设置详情字段说明

参数名	数据类型	说明 1：是，0：否
operationDelay	int	页面切换延时（毫秒）
autoBackWechatx	int	任务结束后返回助手
operationTimeout	int	基础操作超时 5-10s
coreServiceRunMode	int	数据服务运行速率
accPauseMode	int	行为服务暂停后重新启动

autoReplyCollectionBean 自动整理好友申请记录（开启可提高通过好友的频率）详情字段说明

参数名	数据类型	说明 1：是，0：否
autoReplyCollection	int	通过好友后自动回复收藏内容（只在【快速通过好友】模式下生效）

chatRoomBean 群聊相关详情字段说明

参数名	数据类型	说明 1：是，0：否
uploadChatRoomRes	int	上传群聊图片和视频

activeWxBean 活跃微信号详情字段说明

参数名	数据类型	说明 1：是，0：否
activeWx	int	自动活跃微信号 0开启，1不开启
rRefreshFansMoments	int	自动浏览好友朋友圈
rChatWithFans	int	自动与好友聊天
randomFans	string	自动与好友聊天列表
rReadNews	int	自动浏览腾讯新闻
rSendMoments	int	自动发送朋友圈
rReadFansList	int	自动浏览好友列表
rClickUnread	int	自动查看未读消息
timeBlock	string	操作时间段
date	string	操作日期
randomFansNick	string	自动好友列表的昵称

读取员工激活客户数排行榜

接口URL: staff/GetActivationListByStaff

请求方式：Post

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
time	int	是	取当天零点时间戳（精确到秒）
wechat_lei	int	否	0=个微、3=企微
ad_staff_code	string	否	员工工号

请求示例

http://《你服务器IP》:5003/v1/staff/GetActivationListByStaff

{
    "time": 1706112000
}

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-06-22T21:05:18.8942876+08:00",
    "values": [
        {
            "activationnum": 1,
            "ad_staff_code": "zhiyi",
            "ad_staff_name": "志艺",
            "depart_name": "技术部",
            "depart_group_name": "技术部一组"
        }
      ]
}

返回结果说明

参数名	数据类型	说明
activationnum	int	激活客户数
ad_staff_code	string	员工工号
ad_staff_name	string	员工名称
depart_name	string	部门名称
depart_group_name	string	分组名称

读取员工行为记录

接口URL: staff/GetStaffBehaviorLog

请求方式：Post

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
page	int	是	页数
pagesize	int	是	每页多少条
ad_staff_behavior_type	int	否	行为类型：发朋友圈=1、点赞朋友圈=2、评论朋友圈=3、完成待办=4、群发任务=5
ad_staff_behavior_result	int	否	行为结果：待执行=0、执行成功=1、执行失败=2
start_time	int	否	行为开始时间
end_time	int	否	行为结束时间
ad_staff_code	string	否	行为执行员工

请求示例

http://《你服务器IP》:5003/v1/staff/GetStaffBehaviorLog

{
    "page": 1,
    "pagesize": 10,
    "ad_staff_behavior_type": 1
}

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-06-22T21:05:18.8942876+08:00",
    "values": [
        {
            "ad_staff_behavior_type": 1,
            "ad_staff_behavior_addtime": 1592829475,
            "ad_staff_behavior_updatetime": 1592829475,
            "ad_staff_behavior_result": 1,
            "ad_staff_behavior_content": "",
            "ad_staff_code": "P05",
            "merchantid": "111111"
        }
      ]
}

返回结果说明

参数名	数据类型	说明
ad_staff_behavior_type	int	行为类型：发朋友圈=1、点赞朋友圈=2、评论朋友圈=3、完成待办=4、群发任务=5
ad_staff_behavior_addtime	int	记录时间
ad_staff_behavior_updatetime	int	完成时间
ad_staff_behavior_result	int	行为结果：待执行=0、执行成功=1、执行失败=2
ad_staff_behavior_content	string	行为内容
ad_staff_code	string	所属员工
merchantid	string	商户号

读取员工行为记录总数

接口URL: staff/GetStaffBehaviorLogCount

请求方式：Post

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

参数名	数据类型	是否必须	说明
ad_staff_behavior_type	int	否	行为类型：发朋友圈=1、点赞朋友圈=2、评论朋友圈=3、完成待办=4、群发任务=5
ad_staff_behavior_result	int	否	行为结果：待处理=0、已处理=1
start_time	int	否	行为开始时间
end_time	int	否	行为结束时间
ad_staff_code	string	否	行为执行员工

请求示例

http://《你服务器IP》:5003/v1/staff/GetStaffBehaviorLogCount

{
    "page": 1,
    "pagesize": 10,
    "ad_staff_behavior_type": 1
}

接收返回结果

{
    "errmsg": 20000,
    "succeed": true,
    "msgTime": "2020-06-22T21:05:18.8942876+08:00",
    "values": 100
}

返回结果说明

参数名	数据类型	说明
values	int	记录总数

运营机电话监控通话列表

接口URL:CallRecord

请求方式：Post

Headers:

access_token:token
Content-type: text/json

###### 其他参数参考Headers说明

请求参数

以下参数均是可选参数

参数名	数据类型	是否必须	说明
CallTime	long	否	开始通话的时间，精确到毫秒的时间戳，默认为0，传0查询所有通话记录
ad_wechat_nober	string	否	微信号，支持模糊查询
ad_wechat_nick	string	否	机号，支持模糊查询
Page	int	否	页码，默认1
PageSize	int	否	页面大小，默认100

请求示例

{
	"CallTime": 1638201600000,
	"ad_wechat_nober": "yg1811264",
	"ad_wechat_nick": "P07",
	"Page": 1,
	"PageSize": 100
}

接收返回结果

{
    "list": [
        {
            "callrecord_id": 559,
            "imei": "862519046602583",
            "callnumber": "13751821837",
            "selfnumber": null,
            "calltype": 2,
            "callstate": 1,
            "calltypename": "未接",
            "calltime": 1559808798489,
            "callduration": 0,
            "recorddownloadkey": null,
            "ad_wechat_nober": "yg1811121",
            "ad_wechat_nick": "P11",
            "ad_create_time": 1577674563,
        }
    ],
    "ad_update_time": 1571906687156
}

返回结果说明

参数名	数据类型	说明
callrecord_id	int	自动增长编号
imei	string	手机唯一码
callnumber	string	客户号码
selfnumber	string	自己手机号码(为空时未绑定手机号码)
calltype	int	1呼入，2呼出
callstate	int	电话状态（1未接，2已接，3黑名单，4语音信箱，5呼叫转移）
calltypename	string	电话状态对应的文本类型
calltime	long	开始通话的时间,精确到毫秒的时间戳
callduration	int	通话时长(秒)
recorddownloadkey	string	录音文件key,只有有通话时长的才有录音文件，链接为 http://ttimg.agsoft.net/商家编号/callRecord/对应的key
ad_wechat_nober	string	所属微信号
ad_wechat_nick	string	所属机号
ad_create_time	long	入库时间,精确到毫秒的时间戳