Otomatiskan operasi internal dengan kolaborasi API

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.

Harap tangani token API dengan hati-hati karena sama dengan kata sandi.

antarmuka API

Antarmuka API dapat digunakan dengan JavaScript, baris perintah curl, atau program akses HTTP apa pun. Kedua contoh berikut dapat mengambil informasi pendaftaran ruang konferensi dalam format 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

Program akses HTTP apa pun dapat digunakan. Eksekusi API adalah Jenis Konten dari aplikasi/x-www-form-urlencoded Lalu kirim melalui POST.

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

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

tanggapan

Login otomatis

Untuk masuk secara otomatis ke URL konferensi yang dihasilkan oleh createQuickCall, akseslah dengan menggabungkan userName dan password dalam parameter URL sebagai berikut:

https://app.chat-messenger.com/share/{ID konferensi web}Nama pengguna=Taro&kata sandi=000

dapatkanStatistikPanggilan

Mengembalikan status konferensi web saat ini, termasuk jumlah peserta.

Sampel

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

argumen

tanggapan

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

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

Deteksi kesalahan API

Harap menilai kesalahan API sebagai berikut:

Kode status HTTP selain 200

Status HTTP apa pun selain 200 adalah kesalahan tanpa terkecuali.

Status HTTP adalah 200, tetapi ada kesalahan di server

Jika token API tidak valid atau data target tidak ada, status HTTP itu sendiri akan dikembalikan sebagai 200, dan kesalahan dapat ditentukan oleh status respons yang menjadi 520. Selain itu, kesalahan akan berisi larik kode dan pesan penyebab kesalahan.

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

Arti kode dan rincian pesan yang dikembalikan pada saat yang sama adalah sebagai berikut: