HilfezentrumIntegrationen

Für: Administratoren

Füge Beiträge und Kommentare mit einem Hub-Schlüssel hinzu.

Fügen Sie Beiträge zum Feed eines Falls hinzu, antworten Sie mit Kommentaren und lesen, bearbeiten oder löschen Sie diese über Ihre eigene Software als virtueller Assistent.

In diesem Artikel11 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt, wie man Beiträge und Kommentare eines Falls mit einem Hub-Key hinzufügen und lesen kann. Die Wege sind unter https://prd-api-app.caseactive.com/v1/<hub id>/<case id> angegeben.

Anrufe

AnrufWas es tut
GET /postsListet die Beiträge des Falls auf – mit dem neuesten Beitrag zuerst.
POST /postsFügt einen Beitrag hinzu.
GET /posts/<post_id>Liest einen Beitrag
PUT /posts/<post_id>Eine Änderung an einer Nachricht vorgenommen – die Schlüssel wurde hinzugefügt.
DELETE /posts/<post_id>Löscht alle Beiträge sowie die dazugehörigen Kommentare.
GET /posts/templatesListet die für diesen Fall vorgesehenen Feed-Dateien auf.
GET /posts/<post_id>/commentsListet die Kommentare eines Beitrags auf – neueste Kommentare zuerst.
POST /posts/<post_id>/commentsKommentare zu einem Beitrag
GET /posts/<post_id>/comments/<comment_id>Liest einen Kommentar
PUT /posts/<post_id>/comments/<comment_id>Er ändert den Kommentar, den die Schlüssel geschrieben hat.
DELETE /posts/<post_id>/comments/<comment_id>Löscht alle Kommentare.

Alles, was in den „Key Posts“ erscheint, befindet sich auch im Fall. FütternFutter Die Chronologie der Beiträge zu einem Fall, in der die Kanzlei Neuigkeiten teilt und jeder, der an dem Fall beteiligt ist, Kommentare abgeben kann. Wie der Hub deines Netzwerks. Virtuelle Assistentin/Virtueller AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen., Unter dem Namen Ihrer Firma – zusammen mit dem Symbol des virtuellen Assistenten. Um Dateien hinzuzufügen, siehe… Laden Sie die Dateien mit einem Hub-Key hoch und fügen Sie diese anschließend hinzu.. Die durch die KI erstellten Dokumente beziehen sich auf technische Seiten. Diese Dokumente sind für die Nutzer des Portals bestimmt. Es wird jedoch eine Abfrage abgegeben, und als Antwort wird „403“ zurückgegeben. BotNotAllowedException.

Einen Beitrag hinzufügen

FeldWas es tutErforderlichStandard
messageDer Text des Beitrags kann bis zu 20.000 Zeichen lang sein. Die Zeilenumbrüche werden beibehalten.Ja.–
permissionsDie RollenRolle Ein Satz von Berechtigungen, der festlegt, was jemand in einem Fall sehen und tun kann, z. B. Mitarbeiter oder Klienten., die dieses Datum sehen können, wie zum Beispiel ["role::staff"]. Lassen Sie dieses Datum für alle Personen, die an dem Fall beteiligt sind, weg.Nein.Jeder
templateEin Feed-Template, mit dem Dateien von {"owner": "host", "template_id": "<asset_id>"} heruntergeladen werden können.Nein.Keine.
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hi <@cu-4f1c2a9e8b7d60>, the insurer has acknowledged your claim. We expect their estimate within two weeks."}'

Es wird die 201 mit der ID des Beitrags beantwortet.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
  • Text. Senden Sie einfaches Textdaten. Das Portal zeigt **bold**, [a link](https://example.com) sowie unformatierte Webadressen an. E-Mails zeigen den eingegebenen Text an.
  • Erwähnungen. Schreiben Sie <@user_id>, um jemanden in Bezug auf den Fall zu erwähnen. Dabei verwenden Sie die IDs aus GET /team oder einen Bezeichnungsschlüssel wie <@clients.primary>. Dieser Schlüssel wird mit dem entsprechenden Namen ausgedrückt. Das Portal zeigt jedenfalls als @ den Namen sowie den Vornamen der Person an. Erwähnungen von Personen, die nicht im Fall beteiligt sind, oder von Codes, die keine Personen beziehen, werden ignoriert. Eine Nachricht, die ohne jegliche Worte hinterlässt, wird abgelehnt. Bei einem Code FieldRequiredException am Code message wird eine Fehlermeldung angezeigt. Alles andere wird nicht gespeichert.
  • Wer sieht sie schon? Mit permissions, Nur die Personen, die in diesen Positionen tätig sind, sowie alle, deren Aufgabe es ist, Beiträge zu moderieren – genau wie das Standardverhalten des Personals – können dies erkennen.

Wem wird gesagt

Sobald die Post hinzugefügt wird:

  • Ohne Erwähnung der Personen, die das Dokument sehen könnten, wird allen Beteiligten mitgeteilt. Bei Erwähnung der Personen werden nur die genannten Personen betroffen sein.
  • Jeder erhält die Nachricht per E-Mail oder per SMS – falls er keine E-Mail-Adresse hat. Zudem erhält jeder eine Benachrichtigung über das Portal. Mitglieder, deren Benachrichtigungen deaktiviert sind, erhalten keine solchen Benachrichtigungen.
  • Bei der Antwort auf die E-Mail wird diese als Kommentar von der Person, die geantwortet hat, hinzugefügt.
  • Ihre Webhooks erhalten add_post.

Die anschließend beigefügten Dateien werden in der E-Mail mitgezählt.

Beitrag aus einer Vorlage

GET /posts/templates Listet Ihre veröffentlichten Inhalte auf. VorlagenVorlage Ein wiederverwendbarer Feed-Beitrag, ein Formular, eine elektronische Signatur, eine Notiz oder eine Aufgabe, die in der Bibliothek aufbewahrt und in Fälle kopiert wird., Alle sind in der Reihenfolge des Alters geordnet – der Älteste zuerst. asset_id, title Und… message. Bezeichnungscodes message Die Stellen sind bereits mit den Personen bezüglich dieses Falls gefüllt worden.

Um einen neuen Post zu erstellen, senden Sie dazu message – so wie er ist oder nach Änderungen. Zusätzlich sollten Sie auch template senden, zusammen mit asset_id, um die Dateien des Templates bereitzustellen. Ein Template bringt seine eigenen Rollen nicht mit sich; diese müssen Sie selbst übergeben, indem Sie permissions senden.

Beiträge lesen

GET /posts nimmt limit (Standardwert: 20, maximal: 1000) sowie start_key entgegen. Zudem werden Seiten mit nextLink und startKey verarbeitet – wie es bei jeder Liste der Fall ist. Jede Nachricht enthält:

FeldWas es enthält
post_id, case_idIhre IDs
user_idWer hat das gepostet? Die ID der virtuellen Assistentin ist cu-. Die 14 Zeichen der Ihrer ID sind ebenfalls angegeben.
messageDer Text enthält auch Angaben in Form von <@user_id>.
permissionsDie Rollen, die dabei auftreten können, wenn es begrenzt ist…
media, media_ctIhre Dateien – in welcher Art und Zahl sie sind…
comments_ct, commenters, last_replyIhre Kommentare: Wie viele davon wurden geschrieben – und wann das letzte Kommentar wurde verfasst?
systemtrue – Für eine Posten, die durch eine Automatisierung oder Import hinzugefügt wurden.
languageDie Sprache, in der das Werk geschrieben wurde, ist dabei diejenige, mit der die Informationen festgehalten werden.
created_on, updated_onAls der Text veröffentlicht wurde und zuletzt geändert wurde, war es im UTC-Zeitbereich.

Die Schlüsselperson liest alle Beiträge zum Fall durch – auch die weniger wichtigen Beiträge.

Bearbeiten und Löschen

  • PUT /posts/<post_id> nimmt message und permissions entgegen und ändert nur diejenigen Inhalte, die Sie übermitteln. Ein Schlüssel kann nur die Inhalte ändern, die vom virtuellen Assistenten erstellt wurden – also seine eigenen Inhalte sowie die Inhalte, die durch Ihre Automatismen hinzugefügt werden. Niemand wird darüber informiert; Ihre Webhooks erhalten modify_post, sobald sich der Text ändert.
  • Um zu ändern, wer eine Nachricht sehen kann, senden Sie die vollständige Liste der Rollen. Eine leere Liste wird abgelehnt. Um die Nachricht wieder allen zugänglich zu machen, senden Sie "permissions": null. Eine Liste aller Rollen – ohne die später hinzugefügten Rollen – wird ebenfalls gesendet.
  • DELETE /posts/<post_id> löscht alle Beiträge zum Fall samt den dazugehörigen Kommentaren und Dateien. Niemand wird darüber informiert. Ihre Webhooks erhalten delete_post.

Kommentare

POST /posts/<post_id>/comments nimmt message entgegen – nach denselben Regeln wie bei einer Beitragseinstellung. Dabei wird 201 mit comment_id beantwortet. Alle Personen, die den Beitrag sehen können, erhalten diese Informationen – genauso wie die Personen, die im Beitrag erwähnt werden. GET listet diese Personen in der Reihenfolge des Datum auf: comment_id, user_id, message, media sowie deren Zeitpunkte.

Eine Schlüsselzeichenfolge kann nur ihre eigenen Kommentare ändern – dabei wird ein altes PUT durch ein neues message ersetzt. Zudem kann jeder Kommentar gelöscht werden.

Webhooks

Ihre Webhooks erhalten jede Änderung an Beiträgen und Kommentaren. Die Schlüsselwörter, die dabei verwendet werden, sind: add_post, modify_post, delete_post, add_post_media und delete_post_media. Für Kommentare gelten ebenfalls diese fünf Schlüsselwörter. Der Wert von who.user_id bezieht sich auf den Autor des Beitrags oder Kommentars. Der Schlüsselwörter enthält außerdem die ID der virtuellen Assistentin – überprüfen Sie das bitte. Andernfalls wird Ihr System die Beiträge wieder als neue Beiträge betrachten. Weitere Informationen finden Sie in Webhook-Ereignisse und -Inhalte.

Sprache

Die Beiträge und Kommentare werden in keiner Sprache dargestellt. Deshalb werden sie einfach als geschrieben angezeigt – ohne Übersetzung. Ein Beitrag, der mit einem Template erstellt wurde, in dem eine bestimmte Sprache verwendet wird, ist eine Ausnahme: Er wird dabei mit der Sprache des Templates versehen und für Leser, die eine andere Sprache verwenden, übersetzt. Siehe dazu Wie Beiträge und Kommentare übersetzt werden.

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptionEin Feld ist fehlend oder ungültig – beispielsweise ein leeres Feld. message, Leer/ungestellt permissions Eine Liste oder eine Rolle, die Ihr Hub nicht hat. errors Es wird eine Änderung vorgenommen – allerdings wird dabei kein Feld benannt. Der Aufruf, der auf diese Änderung reagiert, wird auf dieselbe Weise abgelehnt.
400SchemaFieldsException, wobei ItemCopyNotAllowedException bei template liegt.Das Template ist nicht veröffentlicht, steht der Rolle der Bots nicht offen – oder seine Dateien werden noch bearbeitet.
403ItemAuthorOnlyExceptionDer Schlüssel versuchte, einen Beitrag oder einen Kommentar zu ändern, den jemand anderes geschrieben hatte.
403CaseClosedExceptionDer Fall ist abgeschlossen.
403BotNotAllowedExceptionEin Schlüssel, der zu einer der AI-Drafting-Operationen führt.
404ItemNotFoundExceptionDer Beitrag oder der Kommentar existiert nicht – oder er gehört zu einem anderen Fall.

Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.

Verwandte Artikel

Verstehen Sie, was die API leisten kann.Erfahren Sie, welche Funktionen eine Verwaltungstaste und eine Hub-Taste jeweils haben, warum jede Taste als virtueller Assistent fungiert und wo Sie die vollständige technische Auflistung finden.IntegrationenDateien mit einem Hub-Schlüssel hochladen und anhängenEine Upload-Adresse abrufen, eine Datei hochladen, diese an einen Beitrag, eine Notiz, eine Aufgabe, ein Formular oder eine elektronische Signatur anhängen und die Akten eines Falls herunterladen.IntegrationenWebhook-Ereignisse und Nutzdaten nachschlagenWas jedes der zehn Feed-Ereignisse sendet, wie die Nachricht verschlüsselt wird und wie Sie sie mit Ihrem Geheimnis entschlüsseln können.IntegrationenAPI-Fehler und Statuscodes behandelnLesen Sie den Fehlertext, was 400, 401, 403, 404, 500 und 503 bedeuten und warum ein Element, dessen Schlüssel nicht angezeigt werden kann, 404.Integrationen