Hợp tác API
Bằng cách sử dụng API Chat&Messenger, bạn có thể dễ dàng liên kết với các hệ thống và chương trình bên ngoài.
Tích hợp API cho phép xử lý sau.
- Liên kết với hệ thống nội bộ và thông báo dữ liệu doanh nghiệp lên 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
- Liên kết hội nghị trên web từ phần mềm nhóm nội bộ
- Nhận thông tin về lịch trình, đặt phòng hội nghị và liên kết với các hệ thống khác
Mã thông báo API và giao diện API
Nhận mã thông báo API từ màn hình quản lý
Khi thực hiện tích hợp API, trước tiên hãy lấy Mã thông báo API.
Vui lòng chuyển apiToken/serverURL thu được sang JavaScript/curl như được mô tả trong "Giao diện API" bên dưới.

Giao diện API
API インターフェイスとして、JavaScript / curl コマンドライン / 任意のHTTPアクセスプログラムが利用できます。以下のサンプルは共に、会議室の登録情報をJSON形式で取得する事ができます。
Trong môi trường không áp dụng SSL thông thường, serverURL sẽ là 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 cuộn tròn
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 liên kết với bất kỳ chương trình truy cập HTTP nào.
Màn hình mẫu API
Có một URL mẫu nơi bạn có thể dễ dàng thử thực thi 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 từ 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 bằng cách chỉ định ID người dùng trong Messenger
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
Chỉ định phòng trò chuyện và gửi
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 |
|
người dùng |
|
tin nhắn |
|
niêm phong |
|
gửi tin nhắn
Gửi tin nhắn hàng loạt từ tệp json.
Vui lòng lưu tệp json bằng mã ký tự UTF8.
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ị web nhanh Tạo một URL.
tạoQuickCall
vật mẫu
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);
lý lẽ
ngày hết hạn | Chỉ định thời hạn cho cuộc họp nhanh (UnixTime milimét) |
title | 会議画面に表示されるタイトルを設定 ※ ブランクの場合は、表示されない |
mật khẩu | Chỉ định mật khẩu cuộc họp nhanh ※ ブランクの場合は、パスワード無しの会議URLが作成される |
レスポンス
sid | Web会議ID |
url | Web会議URL |
presenterPass | 視聴のみモードの会議を生成した場合に、プレゼンターが必要になるパスワード |
自動ログイン
createQuickCall で生成した会議URLに自動でログインするには、次のようにURLパラメータに userName、password を連結してアクセスしてください。
https://app.chat-messenger.com/share/{Web会議ID}?userName=太郎&password=000
getCallStats
Web会議の現在の参加者数などステータスを返却します。
vật mẫu
let response = await getAPIClient().getCallStats(
8sQYFO2sPYHb7xSsibpVCKaqrFmTpCureVqKvwKgSZJs, // Web会議のID
);
lý lẽ
roomName | Web会議のIDを指定、クイック会議の場合はSID |
レスポンス
roomName | Web会議ID |
title | Web会議件名 |
creationDate | 作成日時 |
ngày hết hạn | 有効期限 |
participants | 現在の参加者数 |
inProgress | 会議が進行中の場合は true、そうでない場合は false |
API người dùng
API người dùng chỉ cung cấp lệnh curl. Bạn cũng cần có quyền quản trị để chạy nó.
xuất khẩuNgườ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 đường dẫn.
vật mẫu
curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsers
cập nhậtUsersCSV
Cập nhật thông tin người dùng hàng loạt từ tệp CSV. ※ thẩm quyền giải quyết Định dạng CSV
vật mẫu
curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSV
API phòng chat
cập nhậtPhòng trò chuyện
Tạo/cập nhật phòng trò chuyện
vật mẫu
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"]);
lý lẽ
phòng chat |
|
Lịch trình API
getConferenceMaster
Lấy danh sách tổng thể các phòng hội nghị.
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ó
lấyTrạng tháiphòng hội nghị
Nhận danh sách tình trạng đặt phòng hội thảo
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ẽ
yyyyMMdd |
|
API のエラー判定
API のエラー判定は、次の通り判定してください。
HTTPステータスが200以外
HTTPステータスが200以外の場合は、例外なくエラーです。
HTTPステータスが200だが、サーバでエラー
APIトークンが不正や、対象データが存在しない場合などは、HTTPステータスそのものは200で返却され、レスポンス中の status が 520 で判定可能です。また errors にはエラー原因の code と message が配列で格納されます。
{"status":520, "errors":[{"code":"805","message":"APIトークンが正しくありません"}]}
code の意味と、同時に返却される message の詳細は以下です。
code | 意味 | tin nhắn |
---|---|---|
400 | クライアント側の不正なリクエスト | このリクエストは無効です。 |
405 | 存在しないグループ | – |
406 | グループ変更ができない | – |
451 | ユーザが登録されていない | ユーザが登録されていません。先にユーザ登録してください。 ※ユーザが自身で登録できる場合 |
452 | ユーザが登録されていない | ユーザが登録されていません。 |
490 | ログイン施行回数を超過した | パスワード試行回数の上限に達しためログインできません。しばらく時間をおいてから再度お試しください。 |
491 | リクエスト回数が多すぎる | – |
500 | 予期せぬサーバ起因のエラー | – |
503 | サービスが利用できない | – |
800 | 管理者専用機能のため利用できない | この機能は管理者しか利用できません。 |
802 | API専用機能のため利用できない | この操作はAPIのみで利用可能です。 |
805 | APIトークン不正 | APIトークンが正しくありません。 |