api地址:http://www.bbaos.com/docs/indexjavascript
第一步
開發者登陸
獲取API token
POST
http://域名地址/foreign/auth/...
請求參數 Request Form Data Parameters
參數名 |
類型 |
說明 |
password必填 |
string |
開發者密碼 |
phone必填 |
string |
開發者帳號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
token |
string |
有效期交互密鑰 |
-
注意:
java
- 參數格式是Form Data格式、非Json格式
- 此接口無需包裝Headers信息
獲取微信登陸二維碼
獲取二維碼圖片
POST
http://域名地址/foreign/messa...
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/...
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...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
查看微信在線狀態
查看微信在線狀態
POST
http://域名地址/foreign/messa...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
好友管理
添加好友
添加好友申請
POST
http://域名地址/foreign/frien...
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/frien...
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...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
tags 必填 |
string |
標籤id 不傳返回全部 |
|
建立標籤
建立好友標籤
POST
http://域名地址/foreign/Wacat...
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...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
account必填 |
string |
多個 英文 , 逗號分隔 |
my_account必填 |
string |
登陸微信號 |
lable_id 必填 |
string |
多個 英文 , 逗號分隔 |
|
callback_url 必填 |
string |
回調地址 |
|
刪除標籤
刪除標籤
POST
http://域名地址/foreign/Wacat...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
lable_id |
string |
多個 英文 , 逗號分隔 |
|
callback_url 必填 |
string |
回調地址 |
|
檢測殭屍粉
檢測殭屍粉
POST
http://域名地址/foreign/Frien...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
account必填 |
string |
要檢測的微信號 |
callback_url 必填 |
string |
回調地址 |
|
搜索微信號信息
搜索微信號信息
POST
http://域名地址/foreign/wacat...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
extend |
integer |
擴展字段 回調時原樣返回 |
my_account必填 |
string |
登陸微信號 |
account必填 |
string |
好友微信號 |
好友待添加列表
好友待添加列表
POST
http://域名地址/foreign/frien...
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 |
推薦人暱稱 |
sourceAccount |
string |
推薦人微信 |
sourceGroupNumber |
string |
來源羣號 |
經過好友添加申請
經過好友添加申請
POST
http://域名地址/foreign/frien...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
account必填 |
string |
對方微信號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
獲取微信好友列表
獲取微信好友列表
POST
http://域名地址/foreign/Frien...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
callback_url必填 |
string |
回調地址 |
回調字段釋義
字段名 |
類型 |
說明 |
my_account |
string |
登陸的微信 |
currentPage |
string |
當前頁碼 |
info |
array |
信息 |
total |
int |
總數 |
info解析後數據
字段名 |
類型 |
說明 |
account |
string |
微信號 |
account_alias |
string |
微信ID |
name |
string |
暱稱 |
sex |
int |
性別:0未知,1男,2女 |
area |
string |
地區 |
thumb |
string |
頭像 |
description |
string |
描述 |
form_name |
string |
好友備註 |
disturb |
int |
是否免打擾:1是、2否 【接口爲mac直接回調】3表示未開啓免打擾,505表示開啓免打擾 |
v1 |
string |
惟一數據 |
tag |
string |
標籤 |
-
注意:
api
- 發送到回調接口的數據,每頁100條推送到回調地址,直到全部好友推送完
獲取微信號我的信息
獲取微信信息
POST
http://域名地址/foreign/messa...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
微信號 |
返回字段釋義:
字段名 |
類型 |
說明 |
account |
string |
微信號 |
account_alias |
string |
微信ID |
name |
string |
暱稱 |
sex |
int |
性別:0未知,1男,2女 |
area |
string |
地區 |
decription |
string |
我的簽名 |
thumb |
string |
頭像 |
description |
string |
描述 |
is_online |
int |
在線狀態(1:在線 2:離線) |
消息管理
發送普通消息
發送普通消息
POST
http://域名地址/foreign/messa...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
file_name |
string |
文件名稱 |
my_account必填 |
string |
微信號 |
to_account必填 |
string |
好友微信號 |
微信羣號 |
content必填 |
string |
內容 (語音、文件、圖片都是連接地址) |
content_type必填 |
string |
1文本 |
2圖片 |
4語音必須是silk文件,MP3的代碼能夠本身處理 |
5視頻 |
6文件 |
15動圖 |
type |
string |
1單聊,2羣聊(默認1) |
img_md5 |
string |
動圖必須圖片的MD5 |
img_size |
string |
動圖的文件大小 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
發送名片消息
發送名片消息
POST
http://域名地址/foreign/messa...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
微信號 |
to_account必填 |
string |
好友微信號 |
微信羣號 |
card_name必填 |
string |
推薦人微信號/公衆號微信號(支持我的名片、公衆號名片) |
type |
string |
1單聊,2羣聊(默認1) |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
發送URL連接
發送URL連接
POST
http://域名地址/foreign/messa...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
thumb |
string |
連接圖片地址 |
describe |
string |
連接描述 |
my_account必填 |
string |
微信號 |
to_account必填 |
string |
好友微信號 |
微信羣號 |
url必填 |
string |
連接地址 |
title必填 |
string |
連接標題 |
type |
string |
1單聊,2羣聊(默認1) |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
發送小程序
發送URL連接、分享公衆號、分享第三方文章等
POST
http://域名地址/foreign/messa...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
page_path |
string |
小程序跳轉頁面 |
app_name必填 |
string |
小程序的id (小程序相關參數如不清楚,能夠發送小程序消息,經過消息回調獲取到) |
title必填 |
string |
小程序名稱 |
thumb_key必填 |
string |
小程序預覽圖密鑰 |
my_account必填 |
string |
掃碼登陸的微信號 |
to_account必填 |
string |
好友微信號 |
微信羣號 |
describe |
string |
小程序描述 |
thumb_url |
string |
小程序預覽圖地址 |
type |
string |
1單聊,2羣聊 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
羣管理
設置羣公告
設置羣公告
POST
http://域名地址/foreign/Group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
number必填 |
string |
微信羣號 |
notice 必填 |
string |
公告內容 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
建立微信羣
建立微信羣
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
group_name必填 |
string |
建立羣暱稱 |
extend |
string |
擴充字段,可傳入自定義數據 |
my_account必填 |
string |
登陸微信號 |
account必填 |
string |
微信號(多個用英文狀態下的逗號隔開) |
callback_url |
string |
回調地址url |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
callback_url回調釋義
data |
array |
返回數據 |
account |
string |
微信羣號 |
extend |
string |
擴充字段 |
name |
string |
微信羣名稱 |
headerImage |
string |
微信羣頭像 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
data字段
"data": {
"account": "22156949594@chatroom",
"extend": " ",
"name": "歷來處來從去處去",
"headerImage": "",
}
退出微信羣
退出微信羣
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
g_number必填 |
string |
微信羣羣號 |
my_account必填 |
string |
微信號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
修改羣名稱
修改羣名稱
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
name必填 |
string |
微信羣名稱 |
my_account必填 |
string |
微信號 |
g_number必填 |
string |
微信羣羣號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
邀請新成員
邀請新成員
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
account必填 |
string |
微信羣名稱 |
my_account必填 |
string |
微信號 |
g_number必填 |
string |
微信羣羣號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
踢出羣成員
踢出羣成員
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
account必填 |
string |
羣成員微信號 |
my_account必填 |
string |
微信號 |
g_number必填 |
string |
微信羣羣號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
羣聊@成員
羣聊@成員
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
account必填 |
string |
微信羣號 |
my_account必填 |
string |
登陸微信號 (有wxid優先傳wxid) |
atUser必填 |
string |
微信用戶id(假如@多人,用英文逗號, 拼接) |
content必填 |
string |
'@'+成員的暱稱+空格+內容 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
獲取羣二維碼
獲取羣二維碼
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
g_number必填 |
string |
微信羣羣號 |
callback_url必填 |
string |
微信用戶id(假如@多人,用英文逗號, 拼接) |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
data |
array |
一維數組 |
data含義
qrcode |
string |
羣聊二維碼 |
group_nickname |
string |
羣聊別名 |
group_number |
string |
羣號 |
headimg |
string |
羣聊頭像 |
owner |
string |
羣主 |
type |
string |
類型 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
自動加入羣聊
自動加入羣聊
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
account必填 |
string |
微信羣號 |
status |
int |
0-關閉 1-開啓 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
data |
JSON |
一維數組 |
獲取羣詳細信息
獲取羣詳細信息
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
微信羣號 |
g_number 必填 |
string |
羣號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
data |
arrary |
返回數據 |
data數聽說明
參數名 |
類型 |
說明 |
name |
string |
羣暱稱 |
number |
string |
羣號 |
thumb |
string |
羣頭像 |
disturb |
string |
是否免打擾 |
author |
string |
羣主微信號或微信 |
data |
string |
羣成員信息 |
獲取微信羣列表
獲取微信羣列表
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
微信號 |
type 必填 |
int |
1全部羣 2通信錄的羣 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
data |
arrary |
返回數據 |
page |
int |
總個數 |
total |
int |
反饋信息 |
data數聽說明
參數名 |
類型 |
說明 |
number |
string |
羣號 |
name |
string |
羣暱稱 |
thumb |
string |
羣頭像 |
disturb |
string |
是否免打擾 |
author |
string |
羣主微信號或微信 |
獲取微信羣羣主
獲取微信羣羣主
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸微信號 |
g_number 必填 |
string |
微信羣羣號 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
data |
arrary |
返回數據 |
author |
string |
羣主微信號 |
獲取微信羣成員
獲取微信羣成員
POST
http://域名地址/foreign/Group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
number必填 |
string |
羣號 |
my_account 必填 |
string |
掃碼登陸的微信號 |
callback_url 必填 |
string |
回調地址 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
my_account |
string |
微信號wxID |
my_account_alias |
string |
微信號 |
info |
array |
二維數組 |
info解析
參數名 |
類型 |
說明 |
nickName |
string |
暱稱 |
displayName |
string |
備註 |
bigHeadImgUrl |
string |
頭像 |
userName |
string |
微信ID |
number |
string |
羣號 |
發送羣邀請連接
使用場景:羣人員必須高於40人生效數組
發送羣邀請連接 (需本人贊成方可入羣)
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
g_number必填 |
string |
羣號 |
my_account 必填 |
string |
掃碼登陸的微信號 |
account 必填 |
string |
要邀請的微信 【優先微信id】 |
自動加入羣聊設置
自動加入羣聊設置
若是自動加入羣聊選項關閉,對於收到的入羣邀請連接,能夠自行決定要不要入羣,要的話對這個url連接發post請求便可,這個url連接是通過咱們處理過的,處理前以下緩存
自動加入羣聊設置
POST
http://域名地址/foreign/group...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
account必填 |
string |
微信號 |
status 必填 |
string |
自動加入羣聊 0-關閉 1-開啓 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
朋友圈
發送朋友圈
發送朋友圈
POST
http://域名地址/foreign/Frien...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸的微信號 |
text 必填 |
string |
發送朋友圈內容 |
media_url 必填 |
string |
圖片url最多9張, 用{#}號分隔 | 視頻{#}縮略圖| 連接URL{#}縮略圖,沒有縮略圖也要帶上{#} |
media_type 必填 |
string |
1:圖片 2:文字 3:視頻 |
callback_url |
string |
回調地址url(接收結果) |
title |
string |
連接標題 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
朋友圈 -朋友圈點贊
朋友圈 -朋友圈點贊
POST
http://域名地址/foreign/Frien...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
my_account必填 |
string |
登陸的微信號 |
circle_id 必填 |
string |
朋友圈id |
content 必填 |
string |
評論內容 |
point_type 必填 |
string |
1-點贊 2-評論 |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
獲取朋友圈列表
獲取朋友圈列表
POST
http://域名地址/foreign/Frien...
Request Headers
Headers參數名 |
類型 |
說明 |
token必填 |
string |
有效期交互密鑰 |
請求參數 Form Data Parameters
參數名 |
類型 |
說明 |
statusId |
string |
根據id獲取指定朋友圈信息 |
extend |
string |
自定義拓展字段 回調時會原樣返回 |
my_account必填 |
string |
登陸的微信號 |
to_account |
string |
查詢指定微信號的我的相冊 |
load 必填 |
integer |
評論內容 |
callback_url 必填 |
string |
獲取列表數據回調的url |
返回說明
字段名 |
類型 |
說明 |
code |
int |
1成功,0失敗 |
msg |
string |
反饋信息 |
data |
array |
callback_url 回調 二維數組 |
my_account |
string |
登陸的微信號 |
info |
string |
回調內容 |
profileImageURLString |
string |
微信用戶頭像 |
userString |
string |
微信號 |
mediaType |
string |
類別:1-圖片 |
mediaObject |
string |
圖片對象 |
imageURLStrings |
string |
朋友圈圖片地址 |
nameString |
string |
暱稱 |
statusId |
string |
朋友圈ID |
contentstring |
string |
朋友圈內容 |
createTime |
int |
建立時間 |
timeString |
int |
發表時間 |
回調說明
接收單聊天消息
接收單聊天消息 -當登陸微信號收到好友消息時,會給大家的接口發送數據
POST 須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)
示例
{
{
"data": {
"my_account": "damibtc",
"my_name": 12,
"to_account": "damibtc",
"to_name": 12,
"content": "556",
"content_type": 1,
"file_name": "",
"voice_len": 0,
"type": 1
}
}
}
參數名 |
類型 |
說明 |
my_account |
string |
登陸的微信號 |
my_name |
string |
個人微信暱稱 |
to_account |
string |
好友的微信號 |
to_name |
string |
好友的微信暱稱 |
content |
integer |
內容 |
content_type |
string |
int 1文字、2圖片、3表情、4語音、5視頻、6文件、7公衆號名片、8url連接、9我的名片 10系統消息 11小程序 12 地圖 13紅包 14轉帳 15動圖 |
file_name |
string |
文件名 |
voice_len |
string |
語音時長 |
type |
string |
類型:1登陸號發的、2好友發的 |
msgid |
string |
消息ID可用於區分是不是同一條消息 |
接收羣聊天消息
當登陸微信號收到羣消息時,會給大家的接口發送數據微信
接收羣聊天消息
POST
示例
{
"data": {
"to_account": "damibtc",
"voice_len": 0,
"file_name": "",
"content_type": 1,
"to_name": "1266",
"my_account": "damibtc",
"g_name": "爲了美好的明天而戰888",
"g_number": "237576396656@chatroom",
"my_name": "1266",
"to_account_alias": "damibtc",
"content": "663"
}
}
參數名 |
類型 |
說明 |
my_account |
string |
登陸的微信號 |
my_name |
string |
個人微信暱稱 |
to_account |
string |
好友的微信號 |
to_name |
string |
好友的微信暱稱 |
content |
integer |
內容 |
content_type |
string |
int 1文字、2圖片、3表情、4語音、5視頻、6文件、7公衆號名片、8url連接、9我的名片 10系統消息 11小程序 12 地圖 13紅包 14轉帳 15動圖 |
file_name |
string |
文件名 |
voice_len |
string |
語音時長 |
type |
string |
類型:1登陸號發的、2好友發的 |
msgid |
string |
語音時長 |
msg_source |
string |
消息的額外信息 |
接收新增好友信息
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)app
接收新增好友信息(添加成功後的回調)
POST
示例
{
"data": {
"uid": 2339,
"my_account": "damibtc",
"my_name": "1266",
"to_account": "66s",
"data": {
"name": "damibtc",
"sex": 1,
"area": "",
"thumb": "",
"type": 2,
"time": 1565861411,
"v1": ""
}
}
}
參數名 |
類型 |
說明 |
my_account |
string |
登陸的微信號 |
my_name |
string |
個人微信暱稱 |
to_account |
string |
好友的微信號 |
data |
string |
好友信息 |
name |
integer |
好友暱稱 |
account |
string |
好友微信號 |
sex |
int |
性別:0未知,1男,2女 |
area |
string |
地區 |
thumb |
string |
頭像 |
type |
int |
請指定類型:1我加好友、2好友加我 |
接收微信退出、微信登陸消息
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)post
接收微信退出、微信登陸消息
POST
示例
{
"data": [{
"type": "1",
"account": "damibtc",
"account_alias": "大米",
"name": "1266",
"task_id": 34100,
"thumb": "",
"extend": ""
}]
}
參數名 |
類型 |
說明 |
my_account |
string |
登陸的微信號 |
my_name |
string |
個人微信暱稱 |
to_account |
string |
好友的微信號 |
data |
string |
好友信息 |
name |
integer |
好友暱稱 |
account |
string |
好友微信號 |
sex |
int |
性別:0未知,1男,2女 |
area |
string |
地區 |
thumb |
string |
頭像 |
type |
int |
請指定類型:1我加好友、2好友加我 |
接收有人加進羣消息
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)
當登陸微信全部羣中有人加入其中一個羣時,發出通知
POST
示例
{
"data": {
"g_number": "76655666@chatroom",
"account": "damibtc",
"name": "1266",
"my_account": "大米"
}
}
參數名 |
類型 |
說明 |
g_number |
string |
微信羣號 |
account |
string |
好友微信號 |
name |
string |
微信號別名 |
my_account |
string |
微信號 |
接收新加好友信息(被加)
當登陸微信號有新的好友添加申請是發出幸虧有的信息**微信須要設置-->【我】→【設置】→【隱私】→開啓按鈕【加我爲朋友時須要驗證】
設置回調通知接口中提供的newfriendlog
POST
示例
{
'account' => 'damibtc',
'my_account' => '大米',
'account_alias' => 'wxid_95z5p9j8crbc22',
'encodeUserName' => 'v1_c8a3a6dabff12763e89bffd8cf81ff28dd185cc55150b7e36fa5ea38c0ac@stranger',
'nickname' => '一隻貓',
'sex' => '0',
'country' => '',
'province' => '',
'city' => '',
'sign' => '',
'headHDImgUrl' => '',
'headImgUrl' => '',
'check_msg' => '我是一隻貓',
'source' => '經過掃碼添加',
'sourceNickname' => '',
'sourceAccount' => '',
'sourceGroupNumber' => '',
}
參數名 |
類型 |
說明 |
account |
string |
申請人的微信號 |
my_account |
string |
登陸的微信號 |
account_alias |
string |
申請人的微信ID |
encodeUserName |
string |
用戶名 |
nickname |
string |
暱稱 |
sex |
int |
性別:0未知,1男,2女 |
country |
string |
國家 |
province |
string |
省份 |
city |
string |
城市 |
sign |
string |
簽名 |
headHDImgUrl |
string |
頭像 |
headImgUrl |
string |
頭像 |
check_msg |
string |
微信號 |
source |
string |
來源 |
sourceNickname |
string |
推薦人暱稱 |
sourceAccount |
string |
推薦人微信 |
sourceGroupNumber |
string |
來源羣 在羣裏申請時 |
接收新加好友信息(被加)
當登陸微信號有新的好友添加申請是發出幸虧有的信息**微信須要設置-->【我】→【設置】→【隱私】→開啓按鈕【加我爲朋友時須要驗證】
設置回調通知接口中提供的newfriendlog
POST
示例
{
'account' => 'damibtc',
'my_account' => '大米',
'account_alias' => 'wxid_9505p9j8crbc22',
'encodeUserName' => 'v1_c8a3a6dabff12763e89bffd8cf81ff28dd185cc55150b7e36fa5ea38c0ac@stranger',
'nickname' => '一隻貓',
'sex' => '0',
'country' => '',
'province' => '',
'city' => '',
'sign' => '',
'headHDImgUrl' => '',
'headImgUrl' => '',
'check_msg' => '我是一隻貓',
'source' => '經過掃碼添加',
'sourceNickname' => '',
'sourceAccount' => '',
'sourceGroupNumber' => '',
}
參數名 |
類型 |
說明 |
account |
string |
申請人的微信號 |
my_account |
string |
登陸的微信號 |
account_alias |
string |
申請人的微信ID |
encodeUserName |
string |
用戶名 |
nickname |
string |
暱稱 |
sex |
int |
性別:0未知,1男,2女 |
country |
string |
國家 |
province |
string |
省份 |
city |
string |
城市 |
sign |
string |
簽名 |
headHDImgUrl |
string |
頭像 |
headImgUrl |
string |
頭像 |
check_msg |
string |
微信號 |
source |
string |
來源 |
sourceNickname |
string |
推薦人暱稱 |
sourceAccount |
string |
推薦人微信 |
sourceGroupNumber |
string |
來源羣 在羣裏申請時 |
接收刪除好友通知
當登陸微信號發起刪除好友申請執行刪除後,發出通知
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)
POST
示例
{
"code": 0,
"msg": "刪除成功",
"data": [{
"to_account": "damibtc",
"form_account": "azhi0hao"
}]
}
參數名 |
類型 |
說明 |
account |
string |
刪除的微信號 |
my_account |
string |
登陸的微信號 |
接收查詢微信好友信息
當登陸微信號收到好友消息時,會給大家的接口發送數據
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)
POST
示例
{
"account": "damibtc",
"account_alias": "大米",
"area": "福建福州",
"extend": "這邊是獲取微信好友列表",
"header_url": "http://wx.qlogo.cn/mmhead/ver_1/XRc2e5njrM2v84vA9kr95fiaZVtmAynRicGsj475icKOXxoj3l22saiw2icsZ2xsfn5S6VXGJOXqOwWQTucKO3Lvny7TxFe3bAAvaUfWhVgC6XU/132",
"myAccount": "wxid_6mq1pu8n0j3r2",
"nickName": "Gu🦑",
"sex": 2,
"type": 2
}
參數名 |
類型 |
說明 |
type |
int |
2 表示回調的是查詢的微信信息 |
account |
string |
微信號 |
account_alias |
string |
wxid |
area |
string |
地區 |
header_url |
string |
頭像 |
myAccount |
string |
登陸的微信號 |
nickName |
string |
暱稱 |
sex |
int |
性別 0未知 1男 2女 |
extend |
string |
擴展字段【自定義】 |
獲取微信全部標籤列表
當登陸微信號收到好友消息時,會給大家的接口發送數據
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)
POST
示例
{
"account": "damibtc",
"account_alias": "大米",
"area": "福建福州",
"extend": "這邊是獲取微信好友列表",
"header_url": "http://wx.qlogo.cn/mmhead/ver_1/XRc2e5njrM2v84vA9kr95fiaZVtmAynRicGsj475icKOXxoj3l22saiw2icsZ2xsfn5S6VXGJOXqOwWQTucKO3Lvny7TxFe3bAAvaUfWhVgC6XU/132",
"myAccount": "wxid_6mq1pu8n0j3r2",
"nickName": "Gu🦑",
"sex": 2,
"type": 2
}
參數名 |
類型 |
說明 |
type |
int |
2 表示回調的是查詢的微信信息 |
account |
string |
微信號 |
account_alias |
string |
wxid |
area |
string |
地區 |
header_url |
string |
頭像 |
myAccount |
string |
登陸的微信號 |
nickName |
string |
暱稱 |
sex |
int |
性別 0未知 1男 2女 |
extend |
string |
擴展字段【自定義】 |
用戶手機點擊掃碼確認按鈕的回調
須要你方提供接口地址(本身經過接口設置,接口說明在用戶類菜單裏)
返回微信掃碼狀態
POST
示例
{
"data": [{
"account": "damibtc",
"account_alias": "wxid_7mx5bzt1qz12",
"name": "大米",
"headimg": "http:\\/\\/wx.qlogo.cn\\/mmhead\\/ver_1\\/GL1FASadmu9AwAnhYXoq8Z3pAYYNh4M6CoZLu5cObjr31vaCib1nXPOacficFgYCQwagDaLKnNrooiaAdGoxUeGHLfTDz636tzSYZfjInhFo\\/0",
"status": 8,
"type": 4,
"app_token": "",
"extend": ""
}]
}
參數名 |
類型 |
說明 |
type |
int |
4 表示回調的是微信掃碼狀態 |
status |
int |
8用戶已經點擊確認按鈕 |
account |
string |
微信號 |
account_alias |
string |
微信號(wxid) |
name |
string |
暱稱 |
headimg |
string |
頭像 |
extend |
string |
獲取二維碼時自定義參數 |
開發者微信
![20190923155502.png 20190923155502.png](http://static.javashuo.com/static/loading.gif)