Otomatiskan proses bisnis internal dengan integrasi API.

Integrasi API

Dengan menggunakan API Chat&Messenger, Anda dapat dengan mudah berintegrasi dengan sistem dan program eksternal.
Integrasi API memungkinkan proses-proses berikut:

• Sistem ini terintegrasi dengan sistem internal dan memberi tahu ruang obrolan tentang data bisnis.
• Mendeteksi kesalahan sistem dan memberi tahu pihak terkait.
• Integrasi konferensi web dari perangkat lunak kolaborasi internal.
• Mengambil jadwal dan informasi reservasi ruang rapat serta mengintegrasikannya dengan sistem lain.

Token API dan Antarmuka API

Dapatkan Token API dari panel admin.

Saat melakukan integrasi dengan API, Anda harus terlebih dahulu mendapatkan Token API.

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

Harap tangani Token API Anda dengan hati-hati, sama seperti kata sandi Anda.

Antarmuka API

JavaScript, perintah curl, atau program akses HTTP apa pun dapat digunakan sebagai antarmuka API. Kedua contoh berikut dapat mengambil informasi pendaftaran ruang rapat dalam format JSON.

Pada lingkungan tanpa enkripsi SSL yang memadai, serverURL akan berada di port HTTP 8080.

JavaScript

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

baris perintah curl

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

Program akses HTTP apa pun

Ini juga dapat diintegrasikan dengan program akses HTTP apa pun. Eksekusi API adalah Jenis Konten を aplikasi/x-www-form-urlencoded Mohon kirimkan melalui POS.

Contoh Tampilan API

Tersedia URL contoh yang memungkinkan Anda untuk mencoba API dengan mudah. Jika Anda ingin menggunakannya untuk pengujian, silakan hubungi kami melalui formulir pertanyaan.

API Pesan

KirimPesan

Mengirim pesan.

mencicipi

Kirim dengan menentukan ID pengguna di aplikasi pesan.

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

Kirim dengan menentukan ruang obrolan.

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

kirimPesan

Mengirim pesan secara massal dari file JSON.

Harap simpan file JSON menggunakan pengkodean karakter UTF-8.

mencicipi

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

Panggil API

Konferensi Web Cepat Buat URL.

buatPanggilanCepat

mencicipi

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

argumen

tanggapan

Login otomatis

Untuk masuk secara otomatis ke URL rapat yang dihasilkan oleh createQuickCall, akses URL tersebut dengan menggabungkan userName dan password sebagai parameter URL, seperti yang ditunjukkan di bawah ini.

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

Dapatkan statistik panggilan

Fungsi ini mengembalikan status konferensi web, termasuk jumlah peserta saat ini.

mencicipi

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

argumen

tanggapan

API Pengguna

API Pengguna hanya menyediakan perintah curl, dan hak akses administrator diperlukan untuk menjalankannya.

eksporPengguna

Informasi pengguna akan diunduh dalam format CSV ke lokasi yang ditentukan oleh `path`.

mencicipi

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

perbaruiDATAPengguna

Perbarui informasi pengguna secara massal dari file CSV. *Lihat referensi* format CSV

mencicipi

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

API Ruang Obrolan

perbaruiRuangObrolan

Buat dan perbarui ruang obrolan.

mencicipi

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

argumen

API Jadwal

dapatkanMaster Konferensi

Ambil daftar utama ruang rapat.

mencicipi

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

argumen

tidak ada

dapatkanStatusRuangKonferensi

Dapatkan daftar status reservasi ruang rapat.

mencicipi

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

argumen

Deteksi kesalahan API

Kesalahan API harus ditentukan sebagai berikut:

Status HTTP selain 200

Jika status HTTP selain 200, itu adalah kesalahan tanpa pengecualian.

Status HTTP adalah 200, tetapi ada kesalahan pada server.

Jika token API tidak valid atau data target tidak ada, status HTTP itu sendiri akan dikembalikan sebagai 200, dan status dalam respons dapat diidentifikasi sebagai 520. Selain itu, kolom errors akan berisi array yang memuat kode kesalahan dan pesan.

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

Arti kode dan detail pesan yang dikembalikan secara bersamaan adalah sebagai berikut: