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
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.
JavaScript
let config = { "apiToken": "QIQVOSvRJHrQElDwj20x******", "serverURL": "https://********************" } let client = new CAMAPIClient(config); let Response = waiting client.getConferenceRooms();
Curl-Befehlszeile
curl -H "x-cam-apiToken:token******" ${serverURL}/getConferenceRooms
*Die Server-URL für die lokale Umgebung ist der HTTP-8080-Port.
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
Nachricht senden
Eine Nachricht schicken.
Probe
- Senden Sie, indem Sie die Benutzer-ID im Messenger angeben
let Response = waiting getAPIClient().sendMessage( "messenger", // Geben Sie eine Direktnachricht mit dem Messenger „Hallo!“ an, // Zu sendende Nachricht false, // Umschlag aus ["user1@xxx.com", "user2@ xxx.com"] // Ziel-E-Mail-Adresse);
curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"messenger\",\"message\":\"Hallo\",\" isOpened\":false,\"generalPurposes\":{\"users\":\"user1@xxx.com,user2@xxx.com\"}}" ${serverURL}/sendMessage
- Chatraum angeben und senden
let Response = waiting getAPIClient().sendMessage( „Raumname“, „Hallo!“, false, [„user1@xxx.com“, „user2@xxx.com“] // E-Mail-Adresse als Erwähnung angeben);
curl -H "x-cam-apiToken:token******" -d message="{\"panelName\":\"Raumname\",\"message\":\"Hallo\",\ "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.
Probe
- Curl-Befehlszeile
curl -H "x-cam-apiToken:token******" -d @messages.json ${serverURL}/sendMessages
- Beispieldatei „messages.json“ beim Senden per Direktnachricht
message=[ {"message": "Hallo 1", "property":{"users": "user1@test.com, user2@test.com"}}, {"message": "Hallo 2", "property". „:{“users“: „user1@test.com,user2@test.com“}}, {“message“: „Hallo 3“, „property“: {“users“: „user1@test.com, user2 @test.com"}}, {"message": "Hallo 4", "property": {"users": "user1@test.com, user2@test.com"}}, ]
- Beispieldatei „messages.json“ beim Senden an alle Teilnehmer des Chatroom-Tests
message=[ {"send": "test", "message":"Test 1"} ]
createQuickCall
schnelle Webkonferenz Erstellen Sie eine URL.
Probe
- Erstellen Sie eine Kurzbesprechungs-URL.
let Response = waiting getAPIClient().createQuickCall( 1624368868714, // Frist für die Schnellbesprechung (UnixTime mm) „password!“, // Geben Sie das Kennwort für die Schnellbesprechung an );
Streit
abgelaufenes Datum |
|
Passwort |
|
updateChatRoom
Chatraum erstellen/aktualisieren
Probe
let chatRoom = { „id“: „1564831284702237059“, „name“ „Geheimes Treffen“ „createUserId“: „11u1pu9d32p8vuvjoZdd“, „adminUserId“: „11u1pu9d32p8vuvjoZdd“, „isMessageThread“:true, „isPublic“:false, „memberUids }, } let Response =wait getAPIClient().updateChatRoom(chatRoom); leterrors = Response['errors']; if (errors) { console.log(errors); return; } console.log(response["chatRoom" ]);
Streit
ChatRoom |
|
getConferenceMaster
Holen Sie sich die Hauptliste der Konferenzräume.
Probe
Holen Sie sich die Hauptliste der Konferenzräume
let Response =wait getAPIClient().getConferenceMaster(); leterrors = 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"); leterrors = Response['errors']; if (errors) { console.log(errors); return; } console.log(response["conferenceRoomStatus"] );
Streit
jjjjMMtt |
|