Profiles
Die Gesichter, die du und dein Unternehmen zeigen.
Profile hat sechs öffentliche Methoden für die Profile selbst: auflisten, erstellen, ändern, archivieren, wiederherstellen und löschen. Eine weitere legt fest, zu welchen Profilen ein Element gehört, und drei gehören zu Phone und betreffen die Anrufregeln und die Geschäftsidentität eines Profils. Jede Methode handelt für das Konto, dessen API-Schlüssel du verwendest.
Einen Profile-Tarif wählen, ein Mitglied einladen, den Assistenten eines Profils wählen und eine Nummer zuweisen: Dafür gibt es heute keine öffentliche Methode. Das erledigst du im Dashboard.
Sende mit deinem Schlüssel eine Anfrage an eine Methode:
Eine abgelehnte Anfrage antwortet mit einem negativen code und nennt den Grund in data. Jede Methode akzeptiert außerdem ein optionales workspace_id, um in einem Workspace zu handeln, den du besitzt und der nicht dein Heim-Workspace ist.
Profile lesen
get_account_profiles listet die Profile des Workspace auf, das zuletzt geänderte zuerst.
_idoderprofile_idliefert ein einzelnes Profil.filter_typegrenzt die Liste ein:archivedfür archivierte Profile,sharedfür Profile, die mit dir geteilt wurden,favoritesfür die mit dem Herz markierten. Ohne Angabe werden alle aktiven Profile aufgelistet.account_typegrenzt nach Art ein:personal,businessodervirtual.folder_idlistet einen Dashboard-Ordner auf, oder__none__für die Profile ohne Ordner. Mitsearch,limit,skipundbookmarkdurchsuchst und blätterst du die Liste.
Ein Profil erstellen
create_account_profile erwartet einen profile_name und einen account_type, optional eine profile_signature (die Beschreibung), ein Bild und einen Avatar sowie eine email_account_id, um ein verbundenes Postfach zuzuweisen.
- Ein virtuelles Profil erwartet zusätzlich
virtual_character, die Beschreibung, aus der sein Porträt gezeichnet wird, undvirtual_traits, je eine Auswahl für Alter, Geschlecht, Ethnie und Aussehen. Es wird abgelehnt, es sei denn, der Profile-Tarif des Workspace enthält virtuelle Profile (Starter und höher) oder das Konto hat eine kostenpflichtige Mitgliedschaft, und das Konto ist verifiziert. - Ein persönliches Profil eines persönlichen Kontos oder ein Business-Profil eines Business-Kontos startet mit dem Bild und dem Avatar des Kontos, wenn du keine sendest.
- Ein Workspace, der bereits so viele Profile enthält, wie sein Tarif erlaubt, lehnt ein neues mit
code-62 undreasonplan_capab. Seine vorhandenen Profile bleiben erhalten. Das Hauptprofil, mit dem ein Konto oder Workspace startet, wird nie abgelehnt.
Ein Profil ändern
update_account_profile erwartet die _id des Profils und beliebige Felder, die du ändern möchtest: den Namen, die Beschreibung, das Bild und den Avatar, email_account_id, account_type, den virtuellen Charakter und die Merkmale sowie registered_apps und registered_mini_apps. Diese bestimmen die Module, die auf jedem Kontakt im Profil einen Tab erhalten (registered_apps ist die gesamte geordnete Liste).
- Ein Profil auf virtuell umzustellen, erfüllt dieselben Voraussetzungen wie das Erstellen eines solchen.
- Ein Profil, das mit dir geteilt wurde, ist eine Kopie: Sein Eigentümer ordnet die Arbeitsfläche an, deshalb wird eine Änderung an
canvasabgelehnt.
Archivieren, wiederherstellen und löschen
archive_account_profileerwartetprofile_idund verschiebt das Profil nach Archiviert. Das Hauptprofil wird abgelehnt. War das Profil in diesem Workspace gerade in Verwendung, kehrt der Workspace zu seinem Hauptprofil zurück.unarchive_account_profileholt ein archiviertes Profil zurück. Es zählt wieder zum Limit des Tarifs, ein voller Workspace lehnt es daher ab. Ein Profil, das mit einer Team-Freigabe kam, lässt sich so nicht wiederherstellen.delete_account_profilelöscht ein archiviertes Profil endgültig, samt der Chats, die daran hängen. Es akzeptiert nur ein archiviertes Profil: erst archivieren, dann löschen.
Ein mit delete_account_profile gelöschtes Profil ist weg, und die daran hängenden Chats ebenfalls. Archivieren ist der richtige Schritt, wenn du ein Profil nur aus dem Weg haben willst.
Festlegen, zu welchen Profilen ein Element gehört
update_entity_account_profiles erwartet die _id des Elements und eine nicht leere Liste account_profiles und legt fest, zu welchen Profilen das Element gehört. Es funktioniert bei einem Kontakt, einem Chat, einem KI-Assistenten, einem KI-Agenten und einer Mini-App und lehnt jede andere Art von Element ab.
Die Telefonleitung eines Profils
Drei Methoden von Phone erwarten ein Profil. Sie sind zusammen mit den übrigen Methoden von Phone aufgeführt, und über ein Profil finden sie dessen Nummer.
get_profile_answering_rulesliest die Anrufregeln einer Leitung (Geschäftszeiten, Klingel-Timeout, wer angerufen wird, Weiterleitung, Voicemail und Aufzeichnung) und was der aktuelle Tarif erlaubt.update_profile_answering_rulesspeichert sie. Eine Einstellung, die der Tarif nicht enthält, wird abgelehnt statt verworfen.update_profile_business_identityspeichert die Geschäftsidentität im Profil, dem die Nummer gehören wird.