Tự động hóa các quy trình kinh doanh nội bộ bằng cách tích hợp API.

Tích hợp API

Bằng cách sử dụng API của Chat&Messenger, bạn có thể dễ dàng tích hợp với các hệ thống và chương trình bên ngoài.
Việc tích hợp API cho phép thực hiện các quy trình sau:

• Nó tích hợp với các hệ thống nội bộ và thông báo dữ liệu kinh doanh cho phòng chat.
• Phát hiện lỗi hệ thống và thông báo cho các bên liên quan.
• Tích hợp hội nghị trực tuyến từ phần mềm cộng tác nội bộ.
• Truy xuất lịch trình và thông tin đặt phòng họp, đồng thời tích hợp với các hệ thống khác.

Mã thông báo API và giao diện API

Lấy mã API Token từ bảng quản trị.

Khi tích hợp với API, trước tiên bạn phải lấy được Mã thông báo API.

Vui lòng chuyển apiToken/serverURL đã nhận được cho JavaScript/curl như mô tả trong "Giao diện API" bên dưới.

Hãy bảo quản mã API Token của bạn cẩn thận, giống như cách bạn bảo quản mật khẩu vậy.

Giao diện API

JavaScript, dòng lệnh curl hoặc bất kỳ chương trình truy cập HTTP nào đều có thể được sử dụng làm giao diện API. Cả hai ví dụ sau đều có thể truy xuất thông tin đăng ký phòng họp ở định dạng JSON.

Trong môi trường không có mã hóa SSL thích hợp, URL máy chủ sẽ nằm trên cổng HTTP 8080.

JavaScript

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

dòng lệnh curl

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

Bất kỳ chương trình truy cập HTTP nào

Nó cũng có thể được tích hợp với bất kỳ chương trình truy cập HTTP nào. Việc thực thi API là... Loại nội dung を ứng dụng/x-www-form-urlencoded Vui lòng gửi qua đường bưu điện.

Màn hình mẫu API

Có một URL mẫu cho phép bạn dễ dàng dùng thử API. Nếu bạn muốn sử dụng nó để thử nghiệm, vui lòng liên hệ với chúng tôi qua biểu mẫu yêu cầu.

API tin nhắn

Gửi tin nhắn

Gửi tin nhắn.

vật mẫu

Gửi qua ứng dụng nhắn tin bằng cách chỉ định ID người dùng.

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

Gửi bằng cách chỉ định phòng trò chuyện.

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

lý lẽ

gửi tin nhắn

Gửi tin nhắn hàng loạt từ một tệp JSON.

Vui lòng lưu tệp JSON bằng mã hóa ký tự UTF-8.

vật mẫu

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"}
]

Gọi API

Hội nghị trực tuyến nhanh chóng Tạo URL.

tạo cuộc gọi nhanh

vật mẫu

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

lý lẽ

phản ứng

Đăng nhập tự động

Để tự động đăng nhập vào URL cuộc họp được tạo bởi createQuickCall, hãy truy cập URL đó bằng cách nối tên người dùng và mật khẩu làm tham số URL, như hình bên dưới.

https://app.chat-messenger.com/share/{Web会議ID}?userName=Taro&password=000

getCallStats

Hàm này trả về trạng thái của hội nghị trực tuyến, bao gồm cả số lượng người tham gia hiện tại.

vật mẫu

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

lý lẽ

phản ứng

API người dùng

API người dùng chỉ cung cấp lệnh curl, và cần có quyền quản trị viên để thực thi lệnh này.

xuất người dùng

Thông tin người dùng sẽ được tải xuống ở định dạng CSV vào vị trí được chỉ định bởi `path`.

vật mẫu

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

cập nhật dữ liệu người dùng

Cập nhật thông tin người dùng hàng loạt từ tệp CSV. *Xem tài liệu tham khảo* Định dạng CSV

vật mẫu

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

API Phòng trò chuyện

cập nhật Phòng trò chuyện

Tạo và cập nhật phòng trò chuyện

vật mẫu

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"]);

lý lẽ

API lập lịch

getConferenceMaster

Lấy danh sách đầy đủ các phòng họp.

vật mẫu

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

lý lẽ

không có

getConferenceRoomStatus

Lấy danh sách trạng thái đặt phòng họp.

vật mẫu

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

lý lẽ

phát hiện lỗi API

Các lỗi API cần được xác định như sau:

Trạng thái HTTP khác 200

Nếu trạng thái HTTP không phải là 200, đó là lỗi không thể tránh khỏi.

Trạng thái HTTP là 200, nhưng có lỗi ở máy chủ.

Nếu mã API không hợp lệ hoặc dữ liệu đích không tồn tại, trạng thái HTTP sẽ được trả về là 200, và trạng thái trong phản hồi có thể được xác định là 520. Ngoài ra, trường lỗi sẽ chứa một mảng bao gồm mã lỗi và thông báo lỗi.

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

Ý nghĩa của mã lỗi và chi tiết của thông báo được trả về cùng lúc như sau: