HilfezentrumIntegrationen

Für: Administratoren

Benutzer mit einem Verwaltungsschlüssel hinzufügen und aktualisieren

Erstellen Sie eine Liste der Mitarbeiter Ihres Hubs, fügen Sie Kunden hinzu, lesen Sie die Details und Fälle einzelner Personen und deaktivieren oder aktivieren Sie deren Zugriff.

In diesem Artikel7 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt die Anforderungen an die Personen in Ihrem Hub. Die Wege sind unter https://prd-api-manage.caseactive.com/v1/<hub id> angegeben. Ein Schlüssel ermöglicht es, Personen als Benutzer einzutragen. Es wird nur geändert, wenn diese Personen zugleich Administrator oder Manager sein können. Es ist nicht möglich, jemanden außerdem in eine andere Position zu versetzen oder seine Daten nach dem Hinzufügen zu ändern.

Anrufe

AnrufWas es tut
GET /users/relationsListet die Personen in Ihrem Hub auf.
POST /users/relationsJemanden hinzufügen
GET /users/relations/<user_id>Eine Person liest etwas vor.
PUT /users/relations/<user_id>Eine Person wird deaktiviert oder wieder aktiviert.
GET /users/relations/<user_id>/casesListet die Fälle auf, in denen eine Person involviert ist.

Personen auflisten

ParameterWas es tutErforderlichStandard
type1 ist nur für aktive Personen gedacht, 0 hingegen für Menschen mit Behinderungen. Trotz des Namens wird dabei der Status der Person berücksichtigt – nicht der Benutzertyp.Nein.Beide
limitWie viele Personen eine Seite aufnehmen kann – bis zu 1000 Personen.Nein.20
start_keyDer startKey aus der vorherigen SeiteNein.Erste Seite

Jeder Mensch kommt mit… user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type )admin, manage Oder user), host_user_status )1 aktiv 0 Behinderte host_ref_id, host_default_role, host_staff_designation, host_cases_ct (Ihre Anzahl der Fälle) host_granted_status )approve, Oder reject Sobald sie den Zugriff des Hauptprofiles auf ihr Profil entfernen… created_on. Die Liste ist nicht in einer bestimmten Reihenfolge angeordnet. Sie enthält die Adressen Ihrer Zielgeräte. 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., Wessen? host_user_type ist bot, Und die beiden „Beispielpersonen“, mit denen jeder neue Hub beginnt. Einer von ihnen ist Staff Demo. host_user_type staff. Während es immer noch mehr Menschen gibt, rufen Sie an. nextLink, Oder senden Sie es einfach. startKey wie start_key.

Jemanden hinzufügen

FeldWas es tutErforderlichStandard
usernameIhre E-Mail-Adresse oder ihr Mobiltelefonnummer inklusive der Landeskodierung – beispielsweise +12035556677. Eine Nummer ohne Landeskodierung wird als eine US-amerikanische Nummer interpretiert.Ja.–
given_name, family_nameVorname und Nachname werden so behalten, wie sie eingegeben wurden. Wenn einer der Namen in Kleinbuchstaben oder in Großbuchstaben geschrieben wird, dann werden die Wörter Wort für Wort in Großbuchstaben dargestellt: mary smith wird als „Mary Smith“ gespeichert.Ja.–
localeSprache: ar, de, en, es, fr, id, it, ja, pl, pt, ru oder zhNein.en
zoneinfoZeitzone, beispielsweise America/New_YorkNein.US/Eastern
host_ref_idEine eindeutige Identifikationsnummer für sie – beispielsweise eine Kundennummer. Dabei können Buchstaben, Zahlen, Bindestriche und Senkflecken verwendet werden. Die Nummer sollte in Kleinbuchstaben geschrieben werden. Keine zwei Personen dürfen dieselbe Identifikationsnummer haben.Nein.Keine.
host_default_roleDie Rolle wird zuerst ausgewählt, wenn sie zu einem Fall hinzugefügt werden – beispielsweise role::clients. Sie gibt jedoch nichts her.Nein.role::clients
host_staff_designationIhre üblichen Bezeichnungen für das Personal sind: primary, attorney, paralegal, case_manager, lead_attorney oder lead_paralegal.Nein.primary
birthdateGeburtsdatum, beispielsweise 1985-04-12Nein.Keine.
genderMale oder FemaleNein.Keine.
address1, address2, locality, region, postal_codeAdresse, zweite Zeile, Stadt, Bundesstaat und PostleitzahlNein.Keine.
countryZweibuchstabiger Ländercode, wie zum Beispiel USNein.Keine.
company, titleFirma und BerufstitelNein.Keine.
host_meta_dataIhre benutzerdefinierten Felder – ein Objekt pro Seite der Benutzerdaten – werden in dieser Reihenfolge angezeigt. Die Seiten können mit GET /schemas?schema_type=users eingesehen werden. Ein Feld, das mit Erforderlich markiert ist, kann weggelassen werden: Nur die Funktion „Edit User“ prüft dieses Feld.Nein.Keine.
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'

Es beantwortet die Frage mit ihren entsprechenden Werten: 201 mit user_id.

{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
  • Jeder, der eine Schlüssel hinzufügt, ist ein Benutzer – und dieser Benutzer ist aktiv. Was auch immer man sendet…
  • Eine Schlüsselkarte kann niemandem die Fähigkeit zum Erstellen von Fällen verleihen – also das Hinzufügen von Personen zu den Fällen oder deren Entfernung. Die Versendung von host_create_case, host_add_case_user oder host_remove_case_user wird abgelehnt; außerdem werden keine Personen hinzugefügt. Ein Administrator kann diese Personen auf die Position Benutzer bearbeiten setzen.
  • Wenn die Adresse oder die Nummer bereits von einer anderen Firma verwendet wird – oder gar nicht verwendet wird –, dann wird die Person mit dieser Adresse bzw. Nummer verbunden. Andernfalls wird eine neue Kontonummer erstellt. In beiden Fällen wird niemand per E-Mail oder SMS kontaktiert. Sie werden nur informiert, wenn Sie sie zu einem Fall hinzufügen. Weitere Informationen finden Sie in „Hinzufügen und Entfernen von Mitgliedern eines Falls mit der Management-Funktion“.

Jemanden lesen

GET /users/relations/<user_id> Die Antworten beinhalten alle Informationen aus der Liste – außerdem die Geburtsdatum, das Geschlecht, die Adresse, die Position im Unternehmen sowie weitere benutzbare Felder. Zudem werden auch die Optionen für Benachrichtigungen sowie der letzte Zeitpunkt des letzten Besuchs angezeigt. GET /users/relations/<user_id>/cases Die Liste enthält alle Fälle, an denen sie beteiligt sind – einschließlich der abgeschlossenen Fälle. Für jeden Fall wird außerdem angegeben: case_id, title, case_ref_id Ihre ID des Zentrums/Stützpunkts. :: und die Tag-ID) sowie case_status, Und ihre… case_role_id Und… case_designation Es geht voran.

jemanden deaktivieren oder wieder aktivieren

PUT /users/relations/<user_id> nimmt einen Feldwert an. host_user_status und 0 dienen dazu, diese Felder deaktivieren zu können. 1 wiederum dient dazu, diese Felder erneut aktivieren zu können. Das Ergebnis wird durch 204 angezeigt.

curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"host_user_status": 0}'
  • Eine Person mit Behinderung wird überall in Ihrem Zentrum abgewiesen – sie kann ihre Dienste nicht nutzen. Stattdessen bleibt ihr Account bei anderen Unternehmen bestehen. Siehe dazu Wie man einen Benutzer deaktiviert oder wieder aktiviert.
  • Wenn sich ihr Status ändert, werden ihnen per E-Mail oder SMS mitgeteilt, dass ihr Zugang gesperrt oder wiederhergestellt wurde. Die bereits vorhandene Statusinformationen ändern nichts und bringen auch keine weiteren Informationen mit sich.
  • Eine Schlüsselwahl kann die Berechtigungen von Administratoren und Benutzern deaktivieren oder wieder aktivieren – doch sie kann die Berechtigungen der Admins nicht ändern. Auch die Schlüsselwahl selbst kann keine Änderungen an den eigenen Berechtigungen vornehmen.

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptionEs fehlt ein Feld oder das Feld ist ungültig. errors bezeichnet solche Fälle: Beispielsweise FieldUsernameTypeException für einen Benutzernamen, der kein E-Mail-Adresse oder Telefonnummer ist. FieldPhoneTypeException bezieht sich auf eine Telefonnummer, die nicht gültig ist. FieldNameTypeException bezieht sich auf einen Namen.
400FieldUsernameDupsExceptionJemand, der aktiv in Ihrem Netzwerk ist, besitzt bereits diese E-Mail-Adresse oder die entsprechende Nummer. reason Sie halten es für richtig. user_id.
400HostUserDisabledExceptionDiese Person befindet sich in Ihrem Hub – allerdings ist sie behindert. Aktivieren Sie sie stattdessen wieder. reason hält ihre user_id fest.
400UserReferenceIdExistsExceptionJemand anderer hat dieses host_ref_id bereits.
400HostUserTypeNotAllowedExceptionSie haben versucht, einen Administrator zu deaktivieren – oder die Schlüssel selbst zu blockieren.
403BotRelationFieldNotAllowedExceptionSie senden die „Case Power“-Meldung, wenn Sie jemanden hinzufügen – oder irgendetwas anderes tun, außer host_user_status, wenn Sie etwas ändern.
404ItemNotFoundExceptionNiemand in deinem Zuhause hat diese user_id.

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

Verwandte Artikel

Fallmitglieder mit einem Verwaltungsschlüssel hinzufügen und entfernenWeisen Sie Personen Fälle mit einer Rolle und Bezeichnung zu, versenden Sie die Einladungs-E-Mail, lesen Sie nach, wer an einem Fall arbeitet, oder entfernen Sie jemanden.IntegrationenSuchen Sie Fälle und Benutzer mit einem Verwaltungsschlüssel.Suchen Sie nach Fällen, Personen, Fallbeteiligten, Rollen und importieren Sie Zeilen anhand von Text, mit Filtern, aus Ihrer eigenen Software.IntegrationenEinen Benutzer deaktivieren oder wieder aktivierenSie können jemanden von Ihrem Hub aussperren, ohne ihn zu löschen, oder ihm wieder Zugriff gewähren. Die Benachrichtigung erfolgt in jedem Fall per E-Mail oder SMS.Ihre Kunden · 1 min