Kerjasama API
Dengan menggunakan Chat&Messenger API, Anda dapat dengan mudah terhubung dengan sistem dan program eksternal.
Integrasi API memungkinkan pemrosesan berikut.
- Tautan dengan sistem internal dan memberitahukan data bisnis ke ruang obrolan
- Mendeteksi kesalahan sistem dan memberi tahu pihak terkait
- Tautan konferensi web dari groupware internal
- Dapatkan informasi jadwal dan reservasi ruang konferensi dan hubungkan dengan sistem lain
Token API dan Antarmuka API
Mendapatkan Token API dari layar manajemen
Saat melakukan integrasi API, dapatkan Token API terlebih dahulu.
Silakan meneruskan apiToken/serverURL yang diperoleh ke JavaScript/curl seperti yang dijelaskan dalam "Antarmuka API" di bawah.

antarmuka API
API インターフェイスとして、JavaScript / curl コマンドライン / 任意のHTTPアクセスプログラムが利用できます。以下のサンプルは共に、会議室の登録情報をJSON形式で取得する事ができます。
Di lingkungan di mana SSL biasa tidak diterapkan, URL server akan menjadi port HTTP 8080.
JavaScript
let config = {
"apiToken": "QIQVOSvRJHrQElDwj20x******",
"serverURL": "https://*****************"
}
let client = new CAMAPIClient(config);
let response = await client.getConferenceRooms();
baris perintah keriting
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms
Program akses HTTP apa pun
Itu juga dapat dihubungkan dengan program akses HTTP apa pun.
Layar sampel API
Ada contoh URL tempat Anda dapat dengan mudah mencoba eksekusi API. Jika Anda ingin menggunakannya untuk pengujian, silakan hubungi kami dari formulir pertanyaan.

API Pesan
mengirim pesan
Kirim pesan.
Sampel
Kirim dengan menentukan ID pengguna di 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
Tentukan ruang obrolan dan kirim
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
argumen
mengirim |
|
pengguna |
|
pesan |
|
segel |
|
Kirim pesan
Kirim pesan secara massal dari file json.
Silakan simpan file json dalam kode karakter UTF8.
Sampel
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"}
]
Panggilan API
konferensi web cepat Buat URL.
buatQuickCall
Sampel
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);
argumen
tanggal kadaluarsa | Tentukan batas waktu untuk rapat cepat (UnixTime milimeter) |
title | 会議画面に表示されるタイトルを設定 ※ ブランクの場合は、表示されない |
kata sandi | Tentukan kata sandi rapat cepat ※ ブランクの場合は、パスワード無しの会議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会議の現在の参加者数などステータスを返却します。
Sampel
let response = await getAPIClient().getCallStats(
8sQYFO2sPYHb7xSsibpVCKaqrFmTpCureVqKvwKgSZJs, // Web会議のID
);
argumen
roomName | Web会議のIDを指定、クイック会議の場合はSID |
レスポンス
roomName | Web会議ID |
title | Web会議件名 |
creationDate | 作成日時 |
tanggal kadaluarsa | 有効期限 |
participants | 現在の参加者数 |
inProgress | 会議が進行中の場合は true、そうでない場合は false |
API Pengguna
API Pengguna hanya menyediakan perintah curl. Anda juga memerlukan hak administrator untuk menjalankannya.
pengguna ekspor
Informasi pengguna akan diunduh dalam format CSV ke lokasi yang ditentukan oleh jalur.
Sampel
curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsers
perbaruiPenggunaCSV
Perbarui informasi pengguna secara massal dari berkas CSV. ※ referensi Format CSV
Sampel
curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSV
API Ruang Obrolan
perbaruiChatRoom
Membuat/memperbarui ruang obrolan
Sampel
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"]);
argumen
ruang obrolan |
|
Jadwal API
dapatkan ConferenceMaster
Dapatkan daftar utama ruang konferensi.
Sampel
let response = await getAPIClient().getConferenceMaster();
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["conferenceRooms"]);
argumen
tidak ada
dapatkanConferenceRoomStatus
Dapatkan daftar status reservasi ruang konferensi
Sampel
let response = await getAPIClient().getConferenceRoomStatus("201908");
let errors = response['errors'];
if (errors) {
console.log(errors);
return;
}
console.log(response["conferenceRoomStatus"]);
argumen
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 | 意味 | pesan |
---|---|---|
400 | クライアント側の不正なリクエスト | このリクエストは無効です。 |
405 | 存在しないグループ | – |
406 | グループ変更ができない | – |
451 | ユーザが登録されていない | ユーザが登録されていません。先にユーザ登録してください。 ※ユーザが自身で登録できる場合 |
452 | ユーザが登録されていない | ユーザが登録されていません。 |
490 | ログイン施行回数を超過した | パスワード試行回数の上限に達しためログインできません。しばらく時間をおいてから再度お試しください。 |
491 | リクエスト回数が多すぎる | – |
500 | 予期せぬサーバ起因のエラー | – |
503 | サービスが利用できない | – |
800 | 管理者専用機能のため利用できない | この機能は管理者しか利用できません。 |
802 | API専用機能のため利用できない | この操作はAPIのみで利用可能です。 |
805 | APIトークン不正 | APIトークンが正しくありません。 |