選單
整合企業聊天、人工智慧、網路會議、日程安排、文件管理、工作流程和考勤管理的群組軟體 | Chat&Messenger 網路會議
  1. 家
  2. 如何使用
  3. 雲端移動
  4. 透過API整合實現內部業務流程自動化。

透過API整合實現內部業務流程自動化。

雲端移動
目錄

API集成

透過使用 Chat&Messenger API，您可以輕鬆地與外部系統和程式整合。
API整合支援以下流程：

  • 它與內部系統集成，並將業務資料通知聊天室。
  • 偵測系統錯誤並通知相關方。
  • 從內部群件整合網路會議
  • 獲取日程安排和會議室預訂信息，並與其他系統整合。
API 整合需要雲端企業版/本地部署終極版或更高等級的套件。

API令牌和API介面

從管理面板取得 API 令牌。

與 API 整合時，必須先取得 API 令牌。

請依照下列「API介面」中的說明，將取得到的apiToken/serverURL傳遞給JavaScript/curl。

請像保管密碼一樣妥善保管您的 API 令牌。

API介面

可以使用 JavaScript、curl 命令列或任何 HTTP 存取程式作為 API 介面。以下兩個範例均可檢索 JSON 格式的會議室註冊資訊。

在沒有適當 SSL 加密的環境中，伺服器 URL 將位於 HTTP 連接埠 8080 上。

JavaScript

let config = {
	"apiToken": "QIQVOSvRJHrQElDwj20x******",
	"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);
let response = await client.getConferenceRooms();

curl 命令列

curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms

任何HTTP訪問程序

它還可以與任何HTTP存取程式整合。 API執行是 內容類型 を application/x-www-form-urlencoded 請以郵寄方式寄送。

API 範例螢幕

我們提供了一個範例 URL，方便您輕鬆試用 API。如果您想使用它進行測試，請透過諮詢表單與我們聯繫。

訊息 API

SendMessage

發送訊息。

樣本

透過即時通訊軟體發送，並指定用戶ID。
let response = await getAPIClient().sendMessage(
	"messenger", 	// messenger を指定したダイレクトメッセージを指定
	"Hello!",  	// 送信するメッセージ
	false,   	// 封書は off 
	["user1@xxx.com", "user2@xxx.com"]	// 宛先 Email アドレス 
	);
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 = await getAPIClient().sendMessage(
	"ルーム名", 
	"Hello!", 
	false,
        ["user1@xxx.com", "user2@xxx.com"]	// メンションとして Email アドレス指定 
);
curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"ルーム名\",\"message\":\"Hello\",\"isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage

爭論

傳送
  • 指定收件者
  • 對於即時通訊應用，請指定「即時通訊」；對於聊天應用，請指定房間名稱。
使用者
  • 如果發送的是即時通訊訊息，則會傳送給指定接收使用者。如果發送的是聊天室訊息，則會與所有人分享，然後系統會發送一則提及通知。
  • 透過電子郵件地址搜尋用戶
  • 發送多封電子郵件時，請指定逗號 (,) 作為分隔符號。
資訊
  • 請指定要傳送的訊息。
  • 若要在文字中插入換行符，請插入換行符代碼 \n。
海豹
  • 請指定是/否。發送已讀回執。

發送訊息

從JSON檔案批次發送訊息。

請使用 UTF-8 字元編碼儲存 JSON 檔案。

樣本

curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages 
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=[
  {"send": "test", "message":"テスト 1"}
]

呼叫 API

快速網路會議 建立網址。

建立快速呼叫

樣本

let response = await getAPIClient().createQuickCall(
	1624368868714, 	// クイック会議の期限(UnixTimeミリ)
	"password!",  	// クイック会議のパスワードを指定
	);

爭論

過期日期請指定快速會議的截止時間（以 Unix 時間毫秒為單位）。
標題設定會議畫面上顯示的標題。
* 如果留空，則不會顯示。
密碼請指定快速會議的密碼。
* 如果留空，則會建立一個沒有密碼的會議 URL。

回覆

側網路會議 ID
URL網路會議網址
演示者通行證建立僅供查看的會議時，演示者需要密碼。

自動登入

若要自動登入 createQuickCall 產生的會議 URL，請將使用者名稱和密碼作為 URL 參數連接起來存取它，如下所示。

https://app.chat-messenger.com/share/{Web会議ID}使用者名稱=Taro&密碼=000

獲取通話統計信息

此函數傳回網路會議的狀態，包括目前參與者人數。

樣本

let response = await getAPIClient().getCallStats(
	8sQYFO2sPYHb7xSsibpVCKaqrFmTpCureVqKvwKgSZJs, 	// Web会議のID
	);

爭論

房間名稱指定網路會議的 ID，或快速會議的 SID。

回覆

房間名稱網路會議 ID
標題網路會議主題
項目日期建立日期
過期日期到期日期
。目前參與者人數
進行中會議進行中時為真，否則為假。

使用者 API

使用者 API 僅提供 curl 指令，且需要管理員權限才能執行該指令。

匯出用戶

使用者資訊將以 CSV 格式下載到 `path` 指定的位置。

樣本

curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsers

更新用戶數據

從 CSV 檔案批次更新使用者資訊。 *參考參考資料* CSV格式

樣本

curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSV

聊天室 API

更新聊天室

建立和更新聊天室

樣本

let chatRoom = { 
   "id":"1564831284702237059",
   "name":"秘密会議"
   "createUserId":"11u1pu9d32p8vuvjoZdd",
   "isPublic":false,
   "memberUids":{ 
      "11u1pu9d32p8vuvjoZdd":true,
      "1lmn7hoh3s1ja26fsazw":true,
      "hhx10sfdv1jyou4la1ny":true,
      "3400w9rfvs504c35dt99":true,
      "309d32p8vuvjo5euuuwx":true
   },
}
let response = await getAPIClient().updateChatRoom(chatRoom);
let errors = response['errors'];
if (errors) {
	console.log(errors);
	return;
}
console.log(response["chatRoom"]);

爭論

聊天室
  • 使用 JSON 建立和更新聊天室。
  • 新帳戶無需提供身分證件。

調度 API

獲取會議主控

取得會議室總列表。

樣本

let response = await getAPIClient().getConferenceMaster();
let errors = response['errors'];
if (errors) {
	console.log(errors);
	return;
}
console.log(response["conferenceRooms"]);

爭論

沒有任何

取得會議室狀態

取得會議室預訂狀態清單。

樣本

let response = await getAPIClient().getConferenceRoomStatus("201908");
let errors = response['errors'];
if (errors) {
	console.log(errors);
	return;
}
console.log(response["conferenceRoomStatus"]);

爭論

yyyyMMdd
  • 如果沒有指定任何參數，則會擷取會議室總清單。
  • 透過在參數 yyyyMMdd 中指定月份或日期，您可以擷取對應會議室的預訂狀態。例如：201908 或 20190801
  • 預訂狀態儲存在 conferenceRooms.reservedSchedules 中。

API錯誤偵測

API錯誤應以以下方式判定：

HTTP 狀態碼不是 200

如果 HTTP 狀態碼不是 200，則無一例外地判定為錯誤。

HTTP 狀態碼為 200，但伺服器發生錯誤。

如果 API 令牌無效或目標資料不存在，HTTP 狀態碼本身將傳回 200，回應中的狀態碼為 520。此外，錯誤欄位將包含一個數組，其中包含錯誤代碼和錯誤訊息。

{"status":520, "errors":[{"code":"805","message":"APIトークンが正しくありません"}]}

該程式碼的含義以及同時回傳的訊息詳情如下：

程式碼意義資訊
400客戶端無效請求此請求無效。
405不存在的團體–
406無法更改群組–
451該用戶未註冊。目前還沒有用戶註冊。請先註冊。
*用戶可自行註冊時
452該用戶未註冊。尚未有用戶註冊。
490登入嘗試次數已超過限制。您已達到密碼嘗試次數上限，無法登入。請稍後再試。
491請求過多–
500意外的伺服器相關錯誤–
503該服務不可用。–
800此功能僅限管理員使用，目前無法使用。此功能僅對管理員可用。
802此功能僅提供 API 版本，因此無法使用。此操作僅可透過 API 實作。
805API 令牌詐欺API令牌不正確。
雲端移動
  • 網址をコピーしました！
目錄