行为操作类接口
添加好友
接口URL: friend/Add_Friend
请求方式:POST
Headers:
access_token:token
Content-type: text/json
###### 其他参数参考Headers说明
请求参数
参数名 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
ReceiVerId | string | 是 | 接收机器的微信号 |
Wechat_Moble | string | 是 | 手机号,微信号,QQ号或可添加的好友微信号 |
GreeTing | string | 是 | 打招呼语 |
PcKid | string | 是 | 自定义ID,要求唯一 |
sffcode | string | 否 | 添加好友的工号(该参数不传会进入排队,该员工是CRM员工账号,可用接口聚合聊天接口绑定订单账号绑定员工号或去客户端绑定) |
请求示例
{
"ReceiVerId":"agsoft",
"Wechat_Moble":"2254",
"GreeTing":"001",
"PcKid":"agsoft0251",
"sffcode":"001"
}
接收返回结果
{
msgTime: {2018/5/11 14:47:48}
errmsg: 20000
succeed: true
values: true
errdesc:""
}
返回结果说明
参数名 | 数据类型 | 说明 |
---|---|---|
msgTime | datetime | 信息产生时间 |
errmsg | int | 错误码,对应错误码返回说明 |
succeed | bool | 调用是否成功 |
values | bool | 请求成功 |
errdesc | string | 发生错误时的错误描述 |
批量添加好友(已弃用)
接口URL: friend/Add_FriendPull
请求方式:POST
Headers:
access_token:token
Content-type: text/json
###### 其他参数参考Headers说明
请求参数
参数名 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
ReceiVerId | string | 是 | 接收机器的微信号 |
Wechat_Moble | object | 是 | 要加好友手机号,微信号,QQ号或可添加的好友微信号(数组) |
GreeTing | object | 是 | 打招呼语(数组,不用打招呼语时传空数组) |
PcKid | object | 是 | 自定义ID(数组) |
sffcodelist | object | 否 | 添加好友的工号(数组,传入该值时即不需传sffcode) |
sffcode | string | 否 | 添加好友的工号(不传sffcodelist时该字段传值即所有好友都归属该员工,两者都不传进入排队,该员工是CRM员工账号,可用聚合聊天接口绑定订单账号绑定员工号或去客户端绑定) |
请求示例
{
"ReceiVerId":"agsoft",
"Wechat_Moble":["001","002","003"],
"GreeTing":["001你好","002你好","003你好"],
"PcKid":["001","002","003"],
"sffcodelist":["A01","A02","A03"]
}
接收返回结果
{
msgTime: {2018/5/11 14:47:48}
errmsg: 20000
succeed: true
values: true
}
返回结果说明
参数名 | 数据类型 | 说明 |
---|---|---|
msgTime | datetime | 信息产生时间 |
errmsg | int | 错误码,对应错误码返回说明 |
succeed | bool | 调用是否成功 |
values | bool | 请求成功 |
errdesc | string | 发生错误时的错误描述 |
添加群内好友
接口URL: friend/AddchatroomFriend
请求方式:post FromBody提交
Headers:
access_token:token
Content-type: text/json
###### 其他参数参考Headers说明
请求参数
参数名 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
ReceiVerId | string | 是 | 接收机器的微信号 |
Wechat_Moble | string | 是 | 群内好友的原始微信号 |
ad_chatroom_name | string | 是 | 群号 |
Remark | string | 否 | 备注 |
GreeTing | string | 是 | 打招呼语 |
PcKid | string | 是 | 自定义ID |
请求示例
{
"ReceiVerId":"dong23287",
"Wechat_Moble":"wxid_w4ebc6txje6622",
"ad_chatroom_name":"16113956040@chatroom",
"GreeTing":"你好",
"PcKid":"1234",
"sffcode":"1001"
}
接收返回结果
返回参数:
{
"errmsg": 20000,
"succeed": true,
"msgTime": "2019-12-12T19:35:06.9011912+08:00",
"values": true
}
返回结果说明
参数名 | 数据类型 | 说明 |
---|---|---|
MsgTime | datetime | 信息产生时间 |
errmsg | int | 错误码,对应错误码返回说明 |
succeed | bool | 调用是否成功 |
values | bool | 请求成功 |
errdesc | string | 发生错误时的错误描述 |
添加被动删除好友
接口URL: friend/Add_Passive_Delete_Friend
请求方式:POST
Headers:
access_token:token
Content-type: text/json
###### 其他参数参考Headers说明
请求参数
参数名 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
ReceiVerId | string | 是 | 接收机器的微信号 |
list | array | 是 | 被动删除的好友数组 |
originalWeChatId | string | 是 | 好友原始微信号 |
GreeTing | string | 是 | 打招呼语 |
请求示例
{
"ReceiVerId":"agsoft",
"list": [
{
"originalWeChatId": "xxxx",
"greeTing": "001"
}
]
}
接收返回结果
{
msgTime: {2018/5/11 14:47:48}
errmsg: 20000
succeed: true
values: true
errdesc:""
}
返回结果说明
参数名 | 数据类型 | 说明 |
---|---|---|
msgTime | datetime | 信息产生时间 |
errmsg | int | 错误码,对应错误码返回说明 |
succeed | bool | 调用是否成功 |
values | bool | 请求成功 |
errdesc | string | 发生错误时的错误描述 |
发送个微消息(新)
接口URL:ChatMess/Send
请求方式:post FromBody提交
Headers:
access_token:token
Content-type:text/json
###### 其他参数参考Headers说明
请求参数
参数名 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
taskId | string | 是 | 任务编号(要求唯一,建议使用时间戳加随机数组成) |
friendId | int | 是 | 好友编号 |
originalNober | string | 是 | 运营机原始微信号 |
originalWeChatId | string | 是 | 好友原始微信号 |
taskType | int | 是 | 任务类型(0文本,1图片,2文件,3视频,4链接,5名片,6公众号,7小程序) |
text | object | 否 | taskType=0时必须 |
content | string | 否 | 文本内容 |
image | object | 否 | taskType=1时必须 |
url | string | 否 | 图片链接 |
title | string | 否 | 图片标题 |
file | object | 否 | taskType=2时必须 |
url | string | 否 | 文件链接 |
title | string | 否 |