#联系作者微信 :damibtc
第一步
开发者登录
获取API token
POST http://域名地址/foreign/auth/login
请求参数 Request Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
password必填 |
string | 开发者密码 |
phone必填 |
string | 开发者账号 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
token | string | 有效期交互密钥 |
注意:
- 参数格式是Form Data格式、非Json格式
- 此接口无需包装Headers信息
获取微信登录二维码
获取二维码图片
POST http://域名地址/foreign/message/scanNew
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
extend | string | 用户自定义内容,回调时返回 |
account | string | 微信号(微信第一次扫码不传,以后必须传,否则您可能会出现登录设备已满,封号等情况) |
callback_url必填 |
string | 回调地址url(用于接收二维码、开发者需提供外网可访 访问的接口方法) |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
task_id | int | 任务Id |
Callback_url回调参数
|---------|--------|------------------------------|
| code | int | 1成功,0失败 |
| url | string | 二维码图片(有可能需要转义) |
| task_id | int | 任务Id |
| extend | string | 自定义字段 |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
自定义字段
{
"url": "https://xxxx/b0fdf40df44c3431601e59e988ee9f3.jpg",
"task_id": 40074,
"extend": ""
}
注意:
- 新微信号第一次调用此接口不传account,第二次至N次都要传account字段。
- 您编写的回调接口一定是Post方式且是表单
- 可以配置上下线回调地址获取扫码成功后的微信登录信息,缓存至数据库,下次对比是否是第一次登录
全局回调配置
配置所有微信回调通知
POST http://域名地址/foreign/user/setUrl
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
callbackSend 必填 |
string | 通用接口 |
delfriendlog | string | 删除好友回调接口地址 |
newfriendlog | string | 添加好友通知(待同意) |
messagelog | string | 单聊消息接口 |
crowdlog | string | 群聊消息接口 |
addfriendlog | string | 已添加好友通知(会话列表通知) |
wacatout | string | 接收微信状态接口地址(扫码成功后,会发送到此地址,上线,下线通知) |
addgrouplog | string | 入群回调 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
账户管理
退出微信
退出微信
POST http://域名地址/foreign/wacat/out
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
查看微信在线状态
查看微信在线状态
POST http://域名地址/foreign/message/wxStatus
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
好友管理
添加好友
添加好友申请
POST http://域名地址/foreign/friends/add
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
extend | string | 自定义字段,通用回调–'加好友通知’原样返回 |
my_account必填 |
string | 登录微信号 |
account必填 |
string | 微信号| 手机号(多个用英文状态下的逗号隔开) |
content必填 |
string | 验证消息 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
删除好友
删除好友申请
POST http://域名地址/foreign/friends/del
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
extend | string | 自定义字段,通用回调–'加好友通知’原样返回 |
my_account必填 |
string | 登录微信号 |
to_account必填 |
string | 好友微信号 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
获取标签
获取标签
POST http://域名地址/foreign/Wacat/getLables
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
tags 必填 |
string | 标签id 不传返回所有 |
创建标签
创建好友标签
POST http://域名地址/foreign/Wacat/addLable
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
lables 必填 |
string | 标签名称 多个以英文 , 分割 |
callback_url 必填 |
string | 回调地址 |
callback_url 回调地址
|------------|--------|----------|
| lable_id | int | 标签id |
| account | string | 微信号 |
| lable_name | string | 标签名称 |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
{
"code": 1,
"info": [{
"lable_id": 6,
"account": "Forever4664666",
"lable_name": "你好"
}],
"msg": "创建成功"
}
修改标签
修改标签
POST http://域名地址/foreign/Wacat/updLable
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
account必填 |
string | 多个 英文 , 逗号分隔 |
my_account必填 |
string | 登录微信号 |
lable_id 必填 |
string | 多个 英文 , 逗号分隔 |
callback_url 必填 |
string | 回调地址 |
删除标签
删除标签
POST http://域名地址/foreign/Wacat/delLable
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
lable_id | string | 多个 英文 , 逗号分隔 |
callback_url 必填 |
string | 回调地址 |
检测僵尸粉
检测僵尸粉
POST http://域名地址/foreign/Friends/checkZombie
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
account必填 |
string | 要检测的微信号 |
callback_url 必填 |
string | 回调地址 |
搜索微信号信息
搜索微信号信息
POST http://域名地址/foreign/wacat/newGetWacatInfo
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
extend | integer | 扩展字段 回调时原样返回 |
my_account必填 |
string | 登录微信号 |
account必填 |
string | 好友微信号 |
好友待添加列表
好友待添加列表
POST http://域名地址/foreign/friends/newFriendList
Request Headers
Headers参数名 | 类型 | 说明 |
---|---|---|
token必填 |
string | 有效期交互密钥 |
请求参数 Form Data Parameters
参数名 | 类型 | 说明 |
---|---|---|
my_account必填 |
string | 登录微信号 |
status必填 |
string | -1:所有、 0:待验证、 1:已通过 、2:已过期 |
返回说明
字段名 | 类型 | 说明 |
---|---|---|
code | int | 1成功,0失败 |
msg | string | 反馈信息 |
data | array |
data解析
字段名 | 类型 | 说明 |
---|---|---|
id | int | ID |
my_account | string | 登录微信号 |
account | string | 对方微信号 |
nickname | string | 微信呢称 |
sign | string | 签名 |
headHDImgUrl | string | 微信头像地址 |
status | int | -1所有 0待验证 1已通过 2已过期 |
start_time | int | 申请添加时间 |
check_msg | string | 验证消息 |
source | string | 来源 |
sourceNickname | string |