友米聚合 - 开放API
  1. 接口详情
友米聚合 - 开放API
  • 应用场景
    • 自有订单系统 嵌入 企客聊侧边栏
  • v1
    • 文档
      • 介绍
        • 开发文档阅读说明
        • 错误码返回说明
      • 入门说明
        • 生成signature
        • 获取TOKEN方法
        • 请求Headers说明
      • 接口详情
        • 基础数据类接口
        • 数据读取类接口
        • 行为操作类接口
        • 回调数据
  • v2
    • 事件发布格式说明
    • ChatMess
      • 发送消息
      • 申请接管
      • 终止接管
      • 激活会话
      • 发送通知
      • 读取聊天记录
    • Report
      • 获取员工客服统计
      • 获取员工激活客户数统计
    • System
      • 获取部门列表
      • 根据部门获得组
      • 根据组获得员工
      • 获得员工列表
    • Friend
      • 读取粉丝列表
      • 读取粉丝总数
    • Todo
      • 新增待办记录
      • 新增待办记录(返回编号)
      • 获取待办列表
      • 获取待办列表总数
    • Ad
      • 读取广告列表
      • 读取广告条数
    • BulkSend
      • 保存RPA群发
      • 删除RPA群发
    • 注册回调地址
      POST
    • 订阅事件
      POST
    • 获取商户TOKEN
      POST
  1. 接口详情

回调数据

接口URL: 由商户在后台设置

请求方式:Post
Headers:#
Content-type: text/json

回调请求参数#

参数名数据类型说明
Typeint操作类型
MerchantIdstring商户ID
MsgTimelong信息产生时间(时间戳:秒)
ValuesObject附带数据

请求示例#

{
	"Type": 0,
	"MerchantId": 9527,
	"MsgTime": 1600239001,
	"Values": {
		"ad_friend_id": 1153549,
		"ad_friend_uwenober": "www_7182453",
		"ad_friend_wenober": "wxid_167px6des5ie22",
	}
}

预期返回格式#

参数名数据类型说明
Resultbool结果
ReturnCodeint响应编码
Messagestring响应信息

返回示例#

{
	"Result": true,
	"ReturnCode": 200,
	"Message": "操作完成"
}

操作类型说明#

数值操作类型
0标签、备注保存操作
1发送消息
2修改客户资料
3群操作
4获取聊天消息
5获取好友列表
6设备异常
7评论/点赞朋友圈
8回复自己朋友圈的评论

各操作类型具体请求说明#

标签、备注保存操作#

Values说明#
参数名数据类型说明
labeltypeint操作类型,0新增标签,1移除标签,3修改备注,5同步修改标签和备注,6修改标签
ad_relation_remarkstring备注信息
chooselabelstring修改或删除的标签
friendIdsstring客户微信ID+机号微信ID,格式为"客户微信ID
{
	"Type": 0,
	"MerchantId": 9527,
	"MsgTime": 1600239001,
	"Values": {
		"labeltype": 0,
		"ad_relation_remark": "备注",
		"chooselabel": "["123","456"]",
		"friendIds": "0769|9527" 
	}
}

发送消息#

Values说明#
参数名数据类型说明
ad_original_noberint原始微信号
taskStatestring任务状态 0收到 1成功 2失败 3撤回
taskResultint任务执行结果
taskIdstring任务id
taskTimestring预计任务执行结束是在多少毫秒之后
sendUserIdstring发送该任务的账号
extendstring内容
taskTypestring任务类型
{
	"Type": 1,
	"MerchantId": 9527,
	"MsgTime": 1600239001,
	"Values": {
		"ad_original_nober": "2020",
		"taskState": "0",
		"taskResult":"任务完成",
		"taskId": "1234",
		"taskTime": 1600239001,
		"takeType": 1,
		"sendUserId": "9527",
		"extend": "内容",
	}
}

修改客户资料#

Values说明#
参数名数据类型说明
labeltypeint操作类型,0新增标签,1移除标签,2修改备注
ad_original_noberstring原始微信号
taskStateint任务状态 0收到 1成功 2失败 3撤回
taskResultstring任务执行结果
taskIdstring任务id
taskTimestring预计任务执行结束是在多少毫秒之后
Accountsstring账号
Birthdaystring生日
ChenWeistring称谓
ExtendJsonstring自定义字段json
Moblestring手机号
Namestring真实姓名
Nickstring昵称
Sexstring性别
UserIdstring用户id
Hidefriendint是否隐藏信息,等于1则隐藏
Addressstring地址
ProvinceCodestring省份code
CityCodestring城市code
AreaCodestring区域code
StreetCodestring街道code
MobleTwostring手机号2
MobleThreestring手机号3
MerchantIdstring商户ID
{
	"Type": 1,
	"MerchantId": 9527,
	"MsgTime": 1600239001,
	"Values": {
		"Accounts": "账号",
		"Birthday": "生日",
		"ChenWei":"称谓",
		"ExtendJson": "自定义字段json",
		"Moble": "手机号",
		"Name": "真实姓名",
		"Nick": "昵称",
		"Sex": "性别",
		"UserId": "用户id",
		"Hidefriend": 1,
		"Address":"地址",
		"ProvinceCode": "省份code",
		"CityCode": "城市code",
		"AreaCode": "区域code",
		"StreetCode": "街道code",
		"MobleTwo": "手机号2",
		"MobleThree": "手机号3",
		"MerchantId": "商户ID"
	}
}

群操作#

Values说明#
参数名数据类型说明
ad_original_noberstring原始微信号
taskStateint任务状态 0收到 1成功 2失败 3撤回
taskResultstring任务执行结果
taskIdstring任务id
taskTimestring预计任务执行结束是在多少毫秒之后
sendUserIdstring发送该任务的账号
takeTypestring任务类型
extendstring内容
{
	"Type": 1,
	"MerchantId": 9527,
	"MsgTime": 1600239001,
	"Values": {
		"ad_original_nober": "2020",
		"taskState": "0",
		"taskResult":"任务完成",
		"taskId": "1234",
		"taskTime": 1600239001,
		"takeType": 1,
		"sendUserId": "9527",
		"extend": "内容",
	}
}

获取聊天消息#

Values说明#
参数名数据类型说明
ad_chatting_idlong记录ID
ad_chatting_talterstring接收人ID(接收者微信号)
ad_chatting_contentstring聊天内容
ad_chatting_issendint发送类型
ad_chatting_resvredstring内容格式
ad_wechat_idstring所属微信号
merchantidstring所属商户
ad_chatting_updatetimeDateTime最新上传时间
ad_chatting_sateint内容状态
ad_staff_codestring员工号
ad_staff_namestring员工姓名
ad_expandstring是否已读(0已读,1未读,主要针对语音)
isRecallint是否为撤回消息(0否,1是)
ad_voice_txtstring语音转文本内容
[{
		"ad_chatting_id": 0,
		"ad_chatting_talter": "wxid_2everm6btnvp22",
		"ad_chatting_content": "987",
		"ad_chatting_issend": 1,
		"ad_chatting_time": "1614050169",
		"ad_chatting_resvred": null,
		"ad_wechat_id": "yg1811123",
		"merchantid": null,
		"ad_chatting_updatetime": "0001-01-01T00:00:00",
		"ad_chatting_sate": 1,
		"ad_staff_code": null,
		"ad_expand": null,
		"ad_staff_name": null,
		"isRecall": 0,
		"ad_voice_txt": null
	}]

获取好友列表#

Values说明#
参数名数据类型说明
ad_friend_photostring头像
wenoberstring微信号
ad_friend_wenoberstring好友微信号
ad_relation_typeint关系类型
ad_isdelint是否删除
ad_labelstring标签
detailsstring好友详情
ad_request_timelong好友申请时间
chatroomflagint是否群主(0 不是群主 1 是群主)
describestring助手标识符
addedModeint(加好友方式:-1未知 0你添加对方 1对方添加你)
provincestring地区
sceneint来源(见下表)
sex性别
signstring个人签名
ad_friend_namestring好友昵称(有修改则上上传)
ad_relation_remarkstring好友备注(有修改则上上传)
ad_wechat_idint运营号微信ID
ad_original_noberstring运营号原始微信号
好友来源说明
 * 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:对方通过搜索手机号添加
{
  "list": [
    {
      "ad_friend_photo": "https://wx.qlogo.cn/mmhead/ver_1/0awanSz1GI06D1icGSOnc9coRDDEICckfFbPDU6gia42iazLFpCt7UEticalMe2qPTvNb2Bc0ibUb1WQVAU648td1L4yU9lK8iaBF9OTWpDOJQicn4/96",
      "ad_friend_wenober": "wxid_9527xp921",
      "ad_isdel": 0,
      "ad_label": "[\"标签1\", \"标签2\"]",
      "ad_relation_type": 3,
      "ad_request_time": 0,
      "chatroomFlag": 0,
      "describe": "lhvlq",
      "details": {
        "addedMode": 1,
        "province": "中国大陆",
        "scene": 94,
        "sex": 2,
        "sign": "暮年仍应咆哮"
      },
	  "ad_friend_name": "粽子"	  
    }
  ],
  "wenober": "ytk5194",
  "ad_wechat_id":3231,
  "ad_original_nober":"wxid_w4ebc6txje6622"
}

设备异常通知#

Values说明#
参数名数据类型说明
merchantidstring商家编号
build_staffstring创建员工
remind_contentstring提醒内容
remind_typeint提醒类型,设备异常默认为1
remind_otherstring备注说明
remind_titlestring提醒标题
remind_machine_nostring提醒机号
ad_original_noberstring提醒的原始微信号
{
	"merchantid": "163856712",
	"build_staff": "b9527",
	"remind_content": "设备异常",
	"remind_type": 1,
	"remind_other": "设备异常说明",
	"remind_title": "标题",
	"remind_machine_no": "b14",
	"ad_original_nober": "wx_489f6sdf1w83egf"
	}

评论/点赞朋友圈 && 回复自己朋友圈的评论#

Values说明#
参数名数据类型说明
ad_original_noberstring原始微信号
taskStateint任务状态 0收到 1成功 2失败 3撤回
taskResultstring任务执行结果
taskIdstring任务id
taskTimestring预计任务执行结束是在多少毫秒之后
sendUserIdstring发送该任务的账号
takeTypestring任务类型
extendstring内容json字符串,content: 评论内容(为“”或null则为点赞), snsId: 朋友圈ID
{
	"Type": 1,
	"MerchantId": 9527,
	"MsgTime": 1600239001,
	"Values": {
		"ad_original_nober": "2020",
		"taskState": "0",
		"taskResult":"任务完成",
		"taskId": "1234",
		"taskTime": 1600239001,
		"takeType": 1,
		"sendUserId": "9527",
		"extend": "{\"content\":\"评论内容\",\"snsId\":\"30624700\"}",
	}
}
上一页
行为操作类接口
下一页
事件发布格式说明
Built with