Otomatiskan operasi internal dengan kolaborasi API

18 Januari 2018

Daftar isi

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

Integrasi API memerlukan paket Perusahaan atau lebih tinggi untuk cloud dan lokal.

Token API dan Antarmuka API

Mendapatkan Token API dari layar manajemen

Saat melakukan integrasi API, dapatkan Token API terlebih dahulu.

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

Silakan meneruskan apiToken/serverURL yang diperoleh ke JavaScript/curl seperti yang dijelaskan dalam "Antarmuka API" di bawah.

antarmuka API

Baris perintah JavaScript/curl dapat digunakan sebagai antarmuka API. Kedua contoh di bawah ini dapat memperoleh 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

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

* Direncanakan untuk diperluas secara bertahap mulai dari item dengan penggunaan tinggi.

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	Tentukan target pengiriman Untuk messenger, tentukan messenger; untuk chat, tentukan nama ruangan
pengguna	Jika yang dikirim adalah messenger, ke pengguna tujuan. Dalam kasus ruang obrolan, Anda akan diberi tahu melalui penyebutan setelah membagikan semuanya. Cari pengguna yang sesuai berdasarkan alamat email Saat mengirim beberapa email, tentukan , sebagai pembatas email.
pesan	Tentukan pesan yang akan dikirim Jika ingin teks terpecah pada baris baru, masukkan kode ganti baris \n.
segel	Tentukan benar/salah. Kirim dengan tanda terima telah dibaca

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

buatQuickCall

konferensi web cepat Buat URL.

Sampel

Buat URL rapat cepat

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

argumen

tanggal kadaluarsa	Tentukan batas waktu untuk rapat cepat (UnixTime milimeter)
kata sandi	Tentukan kata sandi rapat cepat Jika dibiarkan kosong, URL rapat tanpa kata sandi akan dibuat.

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

JSON untuk membuat/memperbarui ruang obrolan
id tidak diperlukan jika baru

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

Jika tidak ada argumen yang ditentukan, daftar utama ruang konferensi diperoleh.
Jika Anda memasukkan bulan atau tanggal dalam argumen yyyyMMdd, Anda bisa mendapatkan status reservasi ruang konferensi terkait. Contoh) 201908 atau 20190801
Reservasi disimpan di conferenceRooms.reservedSchedules.

URLをコピーしました！