本文檔為 Dora 平台對接企業微信機器人的前置操作流程,請按順序完成,否則系統無法對接企業微信帳號/ID。
1)必須擁有企業微信管理後台權限;
2)已為 Dora 服務配置域名;
3)已獲取 FineAI 組件所在伺服器的 IP地址(用於企微可信 IP 配置)。
企業微信管理者登入 企業微信管理後台,進入「應用管理>應用>自建」,建立應用
設定應用 logo,應用名稱與可見範圍,其中可見範圍需包括企業中所有會使用機器人的使用者/部門,建議選擇全員。
注:未被納入應用可見範圍的企業微信使用者,將無法透過使用者映射匹配到對應的 Dora 使用者,也無法正常使用機器人。
完成自建應用建立後,自動跳轉至應用配置詳情頁,在「功能>接收訊息」中點選「設定API接收」,進入接收訊息伺服器配置頁。
1)參考以下規則,獲取URL
https://{dora服務域名}/{BI服務後綴}/external/api/im/config/wecom/callback
範例:https://www.example.com/decision/external/api/im/config/wecom/callback
2)點選隨機獲取,系統自動生成 Token 與 EncodingAESKey
注:生成 Token 和 EncodingAESKey 後,先不要點儲存!必須先去 Dora 管理後台填寫這兩項。
以超級管理者身分進入「Dora 管理後台>使用者管理>IM使用者映射」,點選應用對接的配置按鈕,將上一步獲取到的 Token 與 EncodingAESKey 填入彈窗中,並點選下一步,完成對接操作。
回到企業微信後台,儲存【3.2】中的API接收配置。
1)在「開發者API>網頁授權及JS-JDK」卡片中,點選「設定可信域名」,將企業配置好的 Dora 存取域名新增至「可呼叫JS-JDK、跳轉小程式的可信域名」中。
2)點選「申請校驗域名」下載校驗檔案,校驗檔案的名稱通常為:WW_verify_xxx.txt。
3)將校驗檔案新增至企業該 Dora 域名根目錄下,確定 https://<域名>/WW_verify_xxx.txt 能直接存取,其中域名存放路徑可參考下表:
非短域名
(存取地址含 webroot,如 http://域名/webroot/decision)
宿主機掛載目錄:
/掛載目錄/fanruanxxx/bi7-web/ROOT
(存取地址省略 webroot)
需手動copy到 bi-web 容器內 webroot 根目錄
操作範例:
docker cp WW_verify_xxx.txt <bi-web 容器名>:/usr/local/tomcat/webapps/webroot/
在「開發者API>企業可信 IP」卡片中,點選配置按鈕,在彈窗中新增 Dora 服務的出口 IP 地址,點選確認,完成白名單配置。
企業可信 IP 需遵循以下限制:
域名必須已 ICP 備案,且備案主體與企業微信企業主體一致或有聯動。
建立的應用不支援 IP、帶埠的地址或內網域名。
填寫的必須是使用者在行動端實際開啟 Dora 時地址欄裡的域名;若經過網關或反向代理存取,則填寫網關對外的域名。
1)前往「自建應用>配置詳情頁>Secret」,點選查看,可獲取 CorpSecret
2)前往「我的企業>企業資訊」中,下拉頁面,獲取企業ID
以超級管理者身分進入「Dora 管理後台>使用者管理>IM使用者映射」,繼續【3.3】步驟的下一步,在彈窗中填入剛剛獲取到的 CorpSecret 與 CorpId,點選「測試連結並儲存」,頁面提示「已配置」,即為配置成功。
以上步驟全部完成後,建議測試並確認 Dora 伺服器可以正常存取 qyapi.weixin.qq.com。
若後台配置了代理或私有化地址,則需要能存取對應的代理或私有化地址。