ทำให้การดำเนินงานภายในเป็นแบบอัตโนมัติด้วยการทำงานร่วมกันของ API

18 มกราคม 2018

สารบัญ

ความร่วมมือด้านเอพีไอ

ด้วยการใช้ Chat&Messenger API คุณสามารถเชื่อมโยงกับระบบและโปรแกรมภายนอกได้อย่างง่ายดาย
การรวม API ช่วยให้สามารถประมวลผลต่อไปนี้ได้

เชื่อมโยงกับระบบภายในและแจ้งข้อมูลทางธุรกิจไปยังห้องสนทนา
ตรวจจับข้อผิดพลาดของระบบและแจ้งผู้ที่เกี่ยวข้อง
การเชื่อมโยงการประชุมทางเว็บจากกรุ๊ปแวร์ภายในองค์กร
รับข้อมูลการจองตารางเวลาและห้องประชุมและเชื่อมโยงกับระบบอื่นๆ

API 連携はクラウド Enterprise / オンプレミス Ultimate 以上のプランが必要です。

โทเค็น API และอินเทอร์เฟซ API

การรับโทเค็น API จากหน้าจอการจัดการ

เมื่อดำเนินการรวม API ขั้นแรกให้รับโทเค็น API

โปรดส่ง apiToken / serverURL ที่ได้รับไปยัง JavaScript / curl ตามที่อธิบายไว้ใน "อินเทอร์เฟซ API" ด้านล่าง

โปรดจัดการโทเค็น API ด้วยความระมัดระวังเนื่องจากเป็นโทเค็นเดียวกันกับรหัสผ่าน

อินเทอร์เฟซเอพีไอ

API インターフェイスとして、JavaScript / curl コマンドライン / 任意のHTTPアクセスプログラムが利用できます。以下のサンプルは共に、会議室の登録情報をJSON形式で取得する事ができます。

ในสภาพแวดล้อมที่ไม่ได้ใช้ SSL ปกติ serverURL จะเป็นพอร์ต HTTP 8080

จาวาสคริปต์

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

บรรทัดคำสั่งขด

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

โปรแกรมเข้าถึง HTTP ใด ๆ

นอกจากนี้ยังสามารถเชื่อมโยงกับโปรแกรมเข้าถึง HTTP ใดก็ได้

หน้าจอตัวอย่าง API

มี URL ตัวอย่างที่คุณสามารถลองใช้การดำเนินการ API ได้อย่างง่ายดาย หากคุณต้องการนำไปใช้ในการทดสอบโปรดติดต่อเราจากแบบฟอร์มสอบถาม

ข้อความ API

ส่งข้อความ

ส่งข้อความ.

ตัวอย่าง

ส่งโดยระบุ ID ผู้ใช้ใน 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

ระบุห้องสนทนาและส่ง

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

การโต้แย้ง

ส่ง	ระบุเป้าหมายการส่ง สำหรับ Messenger ให้ระบุ Messenger สำหรับแชท ให้ระบุชื่อห้อง
ผู้ใช้	หากส่งเป็น Messenger ไปยังผู้ใช้ปลายทาง ในกรณีของห้องสนทนา คุณจะได้รับแจ้งด้วยการกล่าวถึงหลังจากแชร์เรื่องทั้งหมดแล้ว ค้นหาผู้ใช้ที่เกี่ยวข้องด้วยที่อยู่อีเมล เมื่อส่งอีเมลหลายฉบับ ให้ระบุ เป็นตัวคั่นอีเมล
ข้อความ	ระบุข้อความที่จะส่ง หากคุณต้องการให้ข้อความขึ้นบรรทัดใหม่ ให้ใส่โค้ดตัวแบ่งบรรทัด \n
ผนึก	ระบุจริง/เท็จ ส่งพร้อมใบเสร็จรับเงินการอ่าน

ส่งข้อความ

ส่งข้อความจำนวนมากจากไฟล์ json

โปรดบันทึกไฟล์ json ในรหัสอักขระ UTF8

ตัวอย่าง

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

เรียก API

การประชุมทางเว็บที่รวดเร็ว สร้าง URL

สร้าง QuickCall

ตัวอย่าง

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

การโต้แย้ง

วันหมดอายุ	ระบุกำหนดเวลาการประชุมด่วน (UnixTime มิลลิเมตร)
title	会議画面に表示されるタイトルを設定 ※ ブランクの場合は、表示されない
รหัสผ่าน	ระบุรหัสผ่านการประชุมด่วน ※ ブランクの場合は、パスワード無しの会議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会議の現在の参加者数などステータスを返却します。

ตัวอย่าง

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

การโต้แย้ง

roomName

Web会議のIDを指定、クイック会議の場合はSID

レスポンス

roomName	Web会議ID
title	Web会議件名
creationDate	作成日時
วันหมดอายุ	有効期限
participants	現在の参加者数
inProgress	会議が進行中の場合は true、そうでない場合は false

API ของผู้ใช้

User API จะให้เฉพาะคำสั่ง curl เท่านั้น คุณจะต้องมีสิทธิ์ของผู้ดูแลระบบจึงจะรันมันได้

ส่งออกผู้ใช้

ข้อมูลผู้ใช้จะถูกดาวน์โหลดในรูปแบบ CSV ไปยังตำแหน่งที่ระบุโดยเส้นทาง

ตัวอย่าง

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

อัปเดตผู้ใช้ CSV

อัปเดตข้อมูลผู้ใช้เป็นกลุ่มจากไฟล์ CSV ※ อ้างอิง รูปแบบ CSV

ตัวอย่าง

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

API ห้องสนทนา

อัพเดต ChatRoom

สร้าง/อัพเดตห้องสนทนา

ตัวอย่าง

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

การโต้แย้ง

ห้องสนทนา

JSON เพื่อสร้าง/อัปเดตห้องสนทนา
ไม่จำเป็นต้องใช้รหัสหากใหม่

กำหนดการ API

รับConferenceMaster

รับรายชื่อห้องประชุมหลัก

ตัวอย่าง

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

การโต้แย้ง

ไม่มี

รับConferenceRoomStatus

รับรายการสถานะการจองห้องประชุม

ตัวอย่าง

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

การโต้แย้ง

เย้ๆๆๆ

หากไม่มีการระบุอาร์กิวเมนต์ จะได้รับรายชื่อห้องประชุมหลัก
หากคุณป้อนเดือนหรือวันที่ในอาร์กิวเมนต์ yyyyMMdd คุณสามารถรับสถานะการจองของห้องประชุมที่เกี่ยวข้องได้ ตัวอย่าง) 201908 หรือ 20190801
การจองจะถูกเก็บไว้ใน conferenceRooms.reservedSchedules

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	意味	ข้อความ
400	クライアント側の不正なリクエスト	このリクエストは無効です。
405	存在しないグループ	–
406	グループ変更ができない	–
451	ユーザが登録されていない	ユーザが登録されていません。先にユーザ登録してください。 ※ユーザが自身で登録できる場合
452	ユーザが登録されていない	ユーザが登録されていません。
490	ログイン施行回数を超過した	パスワード試行回数の上限に達しためログインできません。しばらく時間をおいてから再度お試しください。
491	リクエスト回数が多すぎる	–
500	予期せぬサーバ起因のエラー	–
503	サービスが利用できない	–
800	管理者専用機能のため利用できない	この機能は管理者しか利用できません。
802	API専用機能のため利用できない	この操作はAPIのみで利用可能です。
805	APIトークン不正	APIトークンが正しくありません。

URL をkoピーしました！