目錄
API合作
透過使用Chat&Messenger API,您可以輕鬆地與外部系統和程式連結。
API 整合支援以下處理。
- 與內部系統連結,將業務資料通知聊天室
- 偵測系統錯誤並通知相關方
- 來自內部組件的網路會議鏈接
- 獲取日程和會議室預訂資訊並與其他系統鏈接
API 整合需要針對雲端和本地的企業計劃或更高版本。
API令牌和API介面
從管理畫面取得 API Token
進行API整合時,請先取得API Token。
請小心處理 API 令牌,因為它與密碼相同。
請將獲得的 apiToken / serverURL 傳遞給 JavaScript /curl,如下面「API 介面」所述。
API介面
JavaScript/curl 命令列可以用作 API 介面。下面的兩個範例都可以取得JSON格式的會議室註冊資訊。
在不應用常規 SSL 的環境中,serverURL 將是 HTTP 8080 連接埠。
JavaScript
let config = {
"apiToken": "QIQVOSvRJHrQElDwj20x******",
"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);
let response = await client.getConferenceRooms();
捲曲命令列
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms
任何HTTP訪問程序
它還可以與任何 HTTP 存取程式連結。
API 範例螢幕
有一個範例 URL,您可以在其中輕鬆嘗試 API 執行。如果您想使用它進行測試,請透過查詢表與我們聯絡。
應用程式介面
* 計劃從使用率高的專案開始分階段擴展。
傳訊息
發送一個訊息。
樣本
透過在 Messenger 中指定使用者 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
爭論
傳送 |
|
使用者 |
|
資訊 |
|
海豹 |
|
傳送訊息
從 json 檔案批次發送訊息。
請以字元編碼UTF8儲存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"}
]
建立快速呼叫
快速网络会议 建立一個網址。
樣本
建立快速會議 URL
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);
爭論
過期日期 |
|
密碼 |
|
更新聊天室
建立/更新聊天室
樣本
let chatRoom = {
"id":"1564831284702237059",
"name":"秘密会議"
"createUserId":"11u1pu9d32p8vuvjoZdd",
"adminUserId":"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"]);
爭論
聊天室 |
|
獲取會議主持人
取得會議室主列表。
樣本
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"]);
爭論
年月日 |
|