選單

通过应用程序接口连接实现内部操作自动化。

目錄

API合作

透過使用Chat&Messenger API,您可以輕鬆地與外部系統和程式連結。
API 整合支援以下處理。

  • 與內部系統連結,將業務資料通知聊天室
  • 偵測系統錯誤並通知相關方
  • 來自內部組件的網路會議鏈接
  • 獲取日程和會議室預訂資訊並與其他系統鏈接
API 整合需要針對雲端和本地的企業計劃或更高版本。

API令牌和API介面

從管理畫面取得 API Token

進行API整合時,請先取得API Token。

請小心處理 API 令牌,因為它與密碼相同。

請將獲得的 apiToken / serverURL 傳遞給 JavaScript /curl,如下面「API 介面」所述。

API介面

JavaScript/curl 命令列可以用作 API 介面。下面的兩個範例都可以取得JSON格式的會議室註冊資訊。

JavaScript

讓配置= {“apiToken”:“QIQVOSvRJHrQElDwj20x******”,“serverURL”:“https://********************”}讓客戶端=新CAMAPIClient(config);讓response =等待client.getConferenceRooms();

捲曲命令列

捲曲-H“x-cam-apiToken:令牌*****”$ {serverURL} / getConferenceRooms

*本機環境的伺服器 URL 是 HTTP 8080 連接埠。

任何HTTP訪問程序

它還可以與任何 HTTP 存取程式連結。

API 範例螢幕

有一個範例 URL,您可以在其中輕鬆嘗試 API 執行。如果您想使用它進行測試,請透過查詢表與我們聯絡。

應用程式介面

* 計劃從使用率高的專案開始分階段擴展。

傳訊息

發送一個訊息。

樣本

  • 透過在 Messenger 中指定使用者 ID 傳送
    let response = wait getAPIClient().sendMessage( "messenger", // 指定帶有Messenger的直接訊息"Hello!", // 要傳送的訊息false, // 關閉信封["user1@xxx.com", " user2@ xxx.com"] // 目標電子郵件地址 );
    
    curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"messenger\",\"message\":\"Hello\",\" isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
    
  • 指定聊天室並發送
    let response = wait getAPIClient().sendMessage( "房間名稱", "Hello!", false, ["user1@xxx.com", "user2@xxx.com"] // 指定電子郵件地址 );
    
    curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"房間名稱\",\"message\":\"你好\", \ "isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
    

爭論

傳送
  • 指定發送目標
  • 對於 Messenger,指定 Messenger;對於聊天,指定房間名稱
使用者
  • 如果發送的是信使,則發送至目標用戶。如果是聊天室,您將在分享整個內容後收到提及通知。
  • 透過郵箱地址搜尋對應的用戶
  • 發送多封電子郵件時,指定 , 作為電子郵件分隔符號。
資訊
  • 指定要傳送的訊息
  • 如果您希望文字換行,請插入換行程式碼 \n。
海豹
  • 指定真/假。發送已讀回執

傳送訊息

從 json 檔案批次發送訊息。

請以字元編碼UTF8儲存json檔案。

樣本

  • 捲曲命令列
    捲曲-H“x-cam-apiToken:token******”-d @messages.json $ {serverURL} / sendMessages
    
  • 透過直接訊息發送時的 messages.json 檔案範例
    messages=[ {"message":"你好1","property":{"users":"user1@test.com,user2@test.com"}}, {"message":"你好2", "property ":{"users":"user1@test.com,user2@test.com"}}, {"message":"你好3","property":{"users":"user1@test. com,user2 @test.com"}}, {"message":"你好4","property":{"users":"user1@test.com,user2@test.com"}}, ]
    
  • 發送給參與聊天室測試的每個人時的範例 messages.json 文件
    messages=[ {"發送": "測試", "訊息":"測試 1"} ]
    

建立快速呼叫

快速网络会议 建立一個網址。

樣本

  • 建立快速會議 URL。
    let response = wait getAPIClient().createQuickCall( 1624368868714, // 快速會議截止時間 (UnixTime mm) "password!", // 指定快速會議密碼 );
    

爭論

過期日期
  • 指定快速會議的截止日期(UnixTime 毫米)
密碼
  • 指定快速會議密碼
  • 如果留空,將會建立一個沒有密碼的會議 URL。

更新聊天室

建立/更新聊天室

樣本

let chatRoom = { "id":"1564831284702237059", "name":"秘密會議" "createUserId":"11u1pu9d32p8vuvjoZdd", "adminUserId":"11u19d32p8vuvjoZdd", "adminUserId":"11u19d32p8vuvjoZdd", "adminUserId":"11u19d32p8,areadZadi" }, } 讓response =等待getAPIClient().updateChatRoom(chatRoom); 讓錯誤=response['errors']; if (errors) { console.log(errors); return; } console.log(response["chatRoom" ]);

爭論

聊天室
  • 用於建立/更新聊天室的 JSON
  • 如果是新的則不需要 id

獲取會議主持人

取得會議室主列表。

樣本

取得會議室主列表

讓回應 =等待 getAPIClient().getConferenceMaster(); 讓錯誤 = 回應['錯誤']; if (錯誤) { console.log(錯誤); 回傳; } console.log(回應["conferenceRooms"]);

爭論

沒有任何

取得會議室狀態

取得會議室預訂狀態列表

樣本

讓回應 =等待 getAPIClient().getConferenceRoomStatus("201908"); 讓錯誤 = 回應['錯誤']; if (錯誤) { console.log(錯誤); 回傳; } console.log(回應["conferenceRoomStatus"] );

爭論

年月日
  • 如果不指定參數,將取得會議室主列表。
  • 如果在參數yyyyMMdd中輸入月份或日期,則可以取得對應會議室的預訂狀態。例)201908 或 20190801
  • 預訂資訊儲存在conferenceRooms.reservedSchedules 中。
  • 網址をコピーしました!
目錄