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
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.
Bitte übergeben Sie das erhaltene apiToken/serverURL an JavaScript/curl, wie unten unter „API-Schnittstelle“ beschrieben.

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

Nachrichten-API
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 |
|
Benutzer |
|
Nachricht |
|
Siegel |
|
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"}
]
API aufrufen
schnelle Webkonferenz Erstellen Sie eine URL.
createQuickCall
Probe
let response = await getAPIClient().createQuickCall(
1624368868714, // クイック会議の期限(UnixTimeミリ)
"password!", // クイック会議のパスワードを指定
);
Streit
abgelaufenes Datum | Geben Sie die Frist für ein kurzes Meeting an (UnixTime-Millimeter). |
title | 会議画面に表示されるタイトルを設定 ※ ブランクの場合は、表示されない |
Passwort | Geben Sie ein Schnellbesprechungskennwort an ※ ブランクの場合は、パスワード無しの会議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会議の現在の参加者数などステータスを返却します。
Probe
let response = await getAPIClient().getCallStats(
8sQYFO2sPYHb7xSsibpVCKaqrFmTpCureVqKvwKgSZJs, // Web会議のID
);
Streit
roomName | Web会議のIDを指定、クイック会議の場合はSID |
レスポンス
roomName | Web会議ID |
title | Web会議件名 |
creationDate | 作成日時 |
abgelaufenes Datum | 有効期限 |
participants | 現在の参加者数 |
inProgress | 会議が進行中の場合は true、そうでない場合は false |
Benutzer-API
Die Benutzer-API stellt nur den Curl-Befehl bereit. Sie benötigen zum Ausführen außerdem Administratorrechte.
Benutzer exportieren
Benutzerinformationen werden im CSV-Format an den durch den Pfad angegebenen Speicherort heruntergeladen.
Probe
curl -H "x-cam-apiToken:token******" -d "path=exportUsers.csv" ${serverURL}/exportUsers
Benutzer aktualisierenCSV
Aktualisieren Sie Benutzerinformationen in großen Mengen aus einer CSV-Datei. ※ Referenz CSV-Format
Probe
curl -H "x-cam-apiToken:token******" -F "file=@updateUsers.csv" ${serverURL}/updateUsersCSV
ChatRoom-API
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 |
|
Zeitplan-API
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 |
|
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 | 意味 | Nachricht |
---|---|---|
400 | クライアント側の不正なリクエスト | このリクエストは無効です。 |
405 | 存在しないグループ | – |
406 | グループ変更ができない | – |
451 | ユーザが登録されていない | ユーザが登録されていません。先にユーザ登録してください。 ※ユーザが自身で登録できる場合 |
452 | ユーザが登録されていない | ユーザが登録されていません。 |
490 | ログイン施行回数を超過した | パスワード試行回数の上限に達しためログインできません。しばらく時間をおいてから再度お試しください。 |
491 | リクエスト回数が多すぎる | – |
500 | 予期せぬサーバ起因のエラー | – |
503 | サービスが利用できない | – |
800 | 管理者専用機能のため利用できない | この機能は管理者しか利用できません。 |
802 | API専用機能のため利用できない | この操作はAPIのみで利用可能です。 |
805 | APIトークン不正 | APIトークンが正しくありません。 |