本文通過 access_token 憑證的方式來講解怎么調用 企業微信 API,并一步步介紹如何獲取企業微信 API 的 corpsecret、corpid、access_token 憑證以及怎么向企業微信的應用發送消息。 企業微信 API 在線地址為:https://qiyeweixin.apifox.cn/ ,這個在線地址的項目你可以克隆到 Apifox,以方便調試。話不多說,下面進入實操。
完整的企業微信 API 接口調用教程:快速調用-1.jpg (77.44 KB, 下載次數: 41)
下載附件
2024-8-8 17:03 上傳
企業微信添加自建應用
1、如果你是企業微信的企業管理員,點擊 “管理企業” 進入企業微信后臺(不同版本可能不一樣)
完整的企業微信 API 接口調用教程:快速調用-2.jpg (67.6 KB, 下載次數: 36)
下載附件
2024-8-8 17:03 上傳
2、然后在 “應用管理” 下方,選擇 “創建應用”
完整的企業微信 API 接口調用教程:快速調用-3.jpg (34.7 KB, 下載次數: 38)
下載附件
2024-8-8 17:03 上傳
3、填寫應用相關信息
完整的企業微信 API 接口調用教程:快速調用-4.jpg (28.23 KB, 下載次數: 35)
下載附件
2024-8-8 17:03 上傳
4、創建成功后,即可看到 Secret 的信息,這個 Secret 就是等會兒要用的 corpsecret。
完整的企業微信 API 接口調用教程:快速調用-5.jpg (43 KB, 下載次數: 39)
下載附件
2024-8-8 17:03 上傳
5、獲取 corpid, 點擊 “我的企業” 即可看到企業 ID ,這個企業 ID 就是 corpid。
完整的企業微信 API 接口調用教程:快速調用-6.jpg (63.3 KB, 下載次數: 31)
下載附件
2024-8-8 17:03 上傳
企業微信獲取access_token 憑證
為方便企業微信 API 的調試,下面使用 Apifox 獲取 access_token 憑證。企業微信API 的 access_token 是應用調用 api 的憑證,由 corpid 和 corpsecret 換取。
請求方式: GET(HTTPS)
請求 URL: https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET
使用 Apifox 發送 GET 請求即可得到 access_token(請把截圖中的 corpid、corpsecret 換為自己的 corpid(企業 ID)、應用 secret)。企業微信 API 在線地址為:https://qiyeweixin.apifox.cn/ ,這個在線地址的項目你可以克隆到 Apifox,以方便調試。
完整的企業微信 API 接口調用教程:快速調用-7.jpg (94.69 KB, 下載次數: 33)
下載附件
2024-8-8 17:03 上傳
企業微信發送應用消息
企業微信的應用支持推送文本、圖片、視頻、文件、圖文等類型。
請求方式: POST(HTTPS)
請求地址: https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=ACCESS_TOKEN
企業微信的 touser
獲取 touser,通訊錄列表的成員賬號就是 touser。
完整的企業微信 API 接口調用教程:快速調用-8.jpg (56.33 KB, 下載次數: 29)
下載附件
2024-8-8 17:03 上傳
企業微信的 agentid
每個應用都有唯一的 agentid。在“管理后臺”->“應用管理”->“應用”,點進某個應用,即可看到 agentid。
完整的企業微信 API 接口調用教程:快速調用-9.jpg (38.82 KB, 下載次數: 37)
下載附件
2024-8-8 17:03 上傳
構造消息體
可以發送文本、圖片、視頻等多種類型的應用消息,這里以最簡單的文本消息為例:(注意修改 touser、agentid 為自己想要的接收者 userid 列表、應用 id)
{ "touser" : "abelzhu|ZhuShengben", "msgtype" : "text", "agentid" : 1000002, "text" : { "content" : "我就試一下" }, "safe":0}發送消息
如下圖示,有了 access_token、touser、agentid和消息體,在 Apifox 中發送 post 請求即可(紅色箭頭所指為需要注意的點)
完整的企業微信 API 接口調用教程:快速調用-10.jpg (92.74 KB, 下載次數: 30)
下載附件
2024-8-8 17:03 上傳
如果報錯返回"errcode": 60020,那么你需要配置可信任域名。在“應用管理”->“企業可信 IP”下配置即可。這里需要你下載WW_verify_7x7IN1QfqcsOLA6J.txt文件,并將其放到域名的根目錄下,然后驗證。
完整的企業微信 API 接口調用教程:快速調用-11.jpg (38.74 KB, 下載次數: 38)
下載附件
2024-8-8 17:03 上傳
響應成功
如下圖所示,在企業微信里,成功響應了消息回來。
完整的企業微信 API 接口調用教程:快速調用-12.jpg (49.24 KB, 下載次數: 32)
下載附件
2024-8-8 17:03 上傳
使用 Apifox 調試、管理接口
- Apifox: 我們團隊深入使用兩年的 API 接口調試工具
Apifox 是一個比 Postman 更強大的接口測試工具,Apifox = Postman + Swagger + Mock + JMeter,Apifox 支持調試 http (s)、WebSocket、Socket、gRPC、Dubbo 等協議的接口,并且集成了 IDEA 插件。在開發完接口后,可以通過 Apifox 的 IDEA 插件一鍵生成接口文檔,多端同步,非常方便測試和維護。
- 什么是 gRPC
- 一個 HTTP 請求需要具備的 5 個要點
完整的企業微信 API 接口調用教程:快速調用-13.jpg (93.93 KB, 下載次數: 37)
下載附件
2024-8-8 17:03 上傳
完整的企業微信 API 接口調用教程:快速調用-14.jpg (237.85 KB, 下載次數: 34)
下載附件
2024-8-8 17:03 上傳
|
|