SPEISEKARTE

Automatisieren Sie interne Vorgänge durch API-Verknüpfungen.

Inhaltsverzeichnis

API-Kooperation

Mithilfe der Chat&Messenger-API können Sie problemlos eine Verbindung zu externen Systemen und Programmen herstellen.
Die API-Integration ermöglicht die folgende Verarbeitung.

  • Verbindet sich mit dem internen System und benachrichtigt den Chatroom über Geschäftsdaten
  • Erkennen Sie Systemfehler und benachrichtigen Sie die betroffenen Parteien
  • Webkonferenzanbindung aus hauseigener Groupware
  • Erhalten Sie Zeitplan- und Konferenzraumreservierungsinformationen und verknüpfen Sie sie mit anderen Systemen
Für die API-Integration ist sowohl in der Cloud als auch vor Ort ein Enterprise-Plan oder höher erforderlich.

API-Token und API-Schnittstelle

Abrufen eines API-Tokens über den Verwaltungsbildschirm

Wenn Sie eine API-Integration durchführen, besorgen Sie sich zunächst ein API-Token.

Browserversion
Desktop-Version
Bitte gehen Sie vorsichtig mit dem API-Token um, da es dasselbe wie ein Passwort ist.

Bitte übergeben Sie das erhaltene apiToken/serverURL an JavaScript/curl, wie unten unter „API-Schnittstelle“ beschrieben.

API-Schnittstelle

Als API-Schnittstelle kann die JavaScript/Curl-Befehlszeile verwendet werden. Mit den beiden folgenden Beispielen können Sie Registrierungsinformationen für Konferenzräume im JSON-Format erhalten.

In Umgebungen, in denen kein reguläres SSL angewendet wird, ist die Server-URL der HTTP-8080-Port.

JavaScript

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

Curl-Befehlszeile

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

Jedes HTTP-Zugriffsprogramm

Es kann auch mit jedem HTTP-Zugriffsprogramm verknüpft werden.

API-Beispielbildschirm

Es gibt eine Beispiel-URL, mit der Sie die API-Ausführung einfach ausprobieren können. Wenn Sie es zum Testen verwenden möchten, kontaktieren Sie uns bitte über das Anfrageformular.

API

* Geplant ist eine stufenweise Erweiterung, beginnend mit Artikeln mit hoher Nutzung.

Nachricht senden

Eine Nachricht schicken.

Probe

Senden Sie, indem Sie die Benutzer-ID im Messenger angeben
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
Chatraum angeben und senden
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

Streit

schicken
  • Geben Sie das Sendeziel an
  • Geben Sie für Messenger den Messenger an; für Chat geben Sie den Raumnamen an
Benutzer
  • Wenn es sich beim Senden um einen Messenger handelt, an den Zielbenutzer. Im Falle eines Chatrooms werden Sie durch Erwähnung benachrichtigt, nachdem Sie das Ganze geteilt haben.
  • Suchen Sie nach dem entsprechenden Benutzer anhand der E-Mail-Adresse
  • Wenn Sie mehrere E-Mails senden, geben Sie , als E-Mail-Trennzeichen an.
Nachricht
  • Geben Sie die zu sendende Nachricht an
  • Wenn der Text in einer neuen Zeile umgebrochen werden soll, fügen Sie den Zeilenumbruchcode \n ein.
Siegel
  • Geben Sie wahr/falsch an. Mit Lesebestätigung senden

Sende Nachrichten

Senden Sie Nachrichten in großen Mengen aus einer JSON-Datei.

Bitte speichern Sie die JSON-Datei im Zeichencode UTF8.

Probe

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

createQuickCall

schnelle Webkonferenz Erstellen Sie eine URL.

Probe

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

Streit

abgelaufenes Datum
  • Geben Sie die Frist für ein kurzes Meeting an (UnixTime-Millimeter).
Passwort
  • Geben Sie ein Schnellbesprechungskennwort an
  • Bleibt das Feld leer, wird eine Meeting-URL ohne Passwort erstellt.

updateChatRoom

Chatraum erstellen/aktualisieren

Probe

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

Streit

ChatRoom
  • JSON zum Erstellen/Aktualisieren eines Chatrooms
  • Im Neuzustand ist kein Ausweis erforderlich

getConferenceMaster

Holen Sie sich die Hauptliste der Konferenzräume.

Probe

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

Streit

keiner

getConferenceRoomStatus

Erhalten Sie eine Liste des Konferenzraumreservierungsstatus

Probe

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

Streit

jjjjMMtt
  • Wenn kein Argument angegeben wird, wird eine Masterliste der Konferenzräume erhalten.
  • Wenn Sie im Argument yyyyMMdd den Monat oder das Datum angeben, können Sie den Reservierungsstatus des entsprechenden Konferenzraums erhalten. Beispiel) 201908 oder 20190801
  • Reservierungen werden in ConferenceRooms.reservedSchedules gespeichert.
  • URLをコピーしました!
Inhaltsverzeichnis