api如何使用（api使用教程）

在企業微信建立自建應用

1、登入企業微信後臺，在“應用管理>自建”中點選“建立應用”，填寫應用資訊建立。

   

建立應用

API配置表引數值獲取

1、corpid:企業ID。在企業微信後臺的“我的企業>企業資訊”中獲取。

   

獲取企業ID

2、corpsecret：應用憑證密匙。在自建應用詳情中獲取。

   

獲取應用憑證密匙

如果要使用通訊錄相關API則corpsecret在“管理工具>通訊錄同步”中獲取。

   

獲取通訊錄相關API

3、AesKey及token：加密的AES KEY和訊息token。

如果是接收外部聯絡人變更回撥等事件資訊，則在“自建應用詳情>接收訊息>設定API接收”中獲取。

   

找到“設定API接收”

   

獲取

如果是接收通訊錄相關回撥事件資訊，則在“管理工具>通訊錄同步>設定接收事件伺服器”中獲取。

   

通訊錄同步

   

設定接收事件伺服器

   

獲取

雲函式使用

1、根據企業微信API模板建立雲函式

   

建立雲函式

2、參照上文填寫配置引數。

   

填寫引數

3、在程式設計中編寫API。可使用$modules.wcworkApi呼叫部分已封裝API，使用$output輸出。

   

編寫API

滑鼠移入可檢視API說明。

   

檢視API說明

4、儲存測試。

編寫完成後，點選右上方的儲存按鈕儲存程式碼，並將此雲函式開啟。

   

先1再2啊看清楚

在程式設計下方展開線上除錯工具，點選測試，檢視執行結果。

   

測試

5、在功能中呼叫雲函式。

確保雲函式無誤開啟後，在功能中建立API步驟，選擇“自定義API”，再選擇對應雲函式加以呼叫。

   

呼叫

Webhook使用

1、以與雲函式類似的方式建立webhook，並配置相關引數。

   

配置引數

2、按照以下格式編寫程式碼

async function hook($req, $resp, $modules = modules) {     //get 請求用於驗證有效性 if ($req.method == "GET") { //處理已封裝，可直接呼叫         $resp.body = await modules.wxworkApi.getVerifyMsg($req);     } else if ($req.method == "POST") {         //無法保證在五秒內處理完成，先回復（企業微信伺服器在五秒內收不到響應會斷掉連線）         $resp.body = "success";         //處理         let handle = async () => {             //將資料轉換成json             let data = await modules.wxworkApi.getMsgData($req);             if (data.Event == "change_contact" && data.ChangeType == "create_party") {                  //TODO 處理新增部門事件             }         }         handle();     } }

3、儲存程式碼，複製webhook路徑。

   

儲存後複製

4、在企業微信後臺的訊息回撥配置中（自建應用的API接收訊息或通訊錄同步中的接收訊息伺服器設定）將複製的webhook路徑貼上到url中。儲存時將驗證有效性。

   

貼上

5、在瀏覽器中直接開啟webhook路徑應顯示“ok”。使用企業微信做相關操作觸發回撥以檢測webhook處理結果。

   

測試