Profile
Twarze, które pokazujesz Ty i Twoja firma.
Profile mają sześć metod publicznych dla samych profili: wyświetlanie, tworzenie, zmiana, archiwizowanie, przywracanie i usuwanie. Jedna kolejna ustawia, do których profili należy element, a trzy należą do Telefonu i dotyczą zasad odbierania i tożsamości firmowej profilu. Każda działa dla konta, którego klucza API używasz.
Wybór planu Profili, zaproszenie członka, wybór asystenta profilu i przypisanie numeru nie mają dziś metody publicznej. Te rzeczy robi się w dashboardzie.
Wyślij żądanie do metody ze swoim kluczem:
Odrzucone żądanie odpowiada ujemnym code i w data mówi dlaczego. Każda metoda przyjmuje też opcjonalne workspace_id, by działać w przestrzeni roboczej, którą posiadasz, innej niż domowa.
Odczyt profili
get_account_profiles wyświetla profile przestrzeni roboczej, od ostatnio zmienionych.
_idlubprofile_idzwraca jeden profil.filter_typezawęża listę:archiveddla zarchiwizowanych profili,shareddla profili udostępnionych Tobie,favoritesdla oznaczonych sercem. Pominięte, wyświetla każdy aktywny profil.account_typezawęża według rodzaju:personal,businesslubvirtual.folder_idwyświetla jeden folder dashboardu, albo__none__dla profili bez folderu.search,limit,skipibookmarkstronicują i przeszukują listę.
Tworzenie profilu
create_account_profile przyjmuje profile_name i account_type oraz opcjonalnie profile_signature (opis), obraz i awatar, a także email_account_id, by przypisać połączoną skrzynkę.
- Profil wirtualny przyjmuje też
virtual_character, opis, z którego rysowany jest jego portret, ivirtual_traits, po jednym wyborze dla wieku, płci, pochodzenia etnicznego i wyglądu. Jest odrzucany, chyba że plan Profili przestrzeni roboczej obejmuje profile wirtualne (Starter i wyżej) albo konto ma płatne członkostwo, a konto zostało zweryfikowane. - Profil osobisty konta osobistego lub profil firmowy konta firmowego zaczyna od własnego obrazu i awatara konta, gdy żadnego nie wyślesz.
- Przestrzeń robocza, która ma już tyle profili, na ile pozwala jej plan, odrzuca nowy z
code-62 ireasonplan_cap. Zachowuje profile, które ma. Profil główny, od którego zaczyna konto lub przestrzeń robocza, nigdy nie jest odrzucany.
Zmiana profilu
update_account_profile przyjmuje _id profilu i dowolne z pól, które chcesz zmienić: nazwę, opis, obraz i awatar, email_account_id, account_type, postać wirtualną i cechy oraz registered_apps i registered_mini_apps, które decydują o modułach dostających kartę przy każdym kontakcie w profilu (registered_apps to cała uporządkowana lista).
- Przełączenie profilu na wirtualny wymaga spełnienia tego samego progu co jego utworzenie.
- Profil, który został ci udostępniony, jest kopią: jego właściciel układa jego kanwę, więc zmiana
canvasna nim jest odrzucana.
Archiwizowanie, przywracanie i usuwanie
archive_account_profileprzyjmujeprofile_idi przenosi profil do Zarchiwizowano. Profil główny jest odrzucany. Jeśli profil był tym używanym w tej przestrzeni roboczej, przestrzeń robocza wraca do swojego profilu głównego.unarchive_account_profileprzywraca zarchiwizowany profil. Znów liczy się do limitu planu, więc pełna przestrzeń robocza go odrzuca. Profilu, który przyszedł z udostępnieniem zespołowym, nie można tak przywrócić.delete_account_profileusuwa zarchiwizowany profil na dobre, a razem z nim czaty, które z niego wychodzą. Przyjmuje tylko zarchiwizowany profil: najpierw zarchiwizuj, potem usuń.
Profil usunięty przez delete_account_profile znika, a z nim czaty do niego przypisane. Archiwizowanie to krok, którego użyj, gdy chcesz tylko usunąć profil z drogi.
Ustaw, do których profili należy element
update_entity_account_profiles przyjmuje _id elementu i niepustą listę account_profiles i ustawia, do których profili ten element należy. Działa na kontakcie, czacie, asystencie AI, agencie AI i mini aplikacji, a każdy inny rodzaj elementu odrzuca.
Linia telefoniczna profilu
Trzy metody Telefonu przyjmują profil. Są wyliczone razem z resztą metod Telefonu, a profil to sposób, w jaki znajdują jego numer.
get_profile_answering_rulesodczytuje zasady odbierania linii (godziny pracy, limit czasu dzwonienia, kto jest wywoływany, przekierowanie, poczta głosowa i nagrywanie) oraz to, na co pozwala obecny plan.update_profile_answering_rulesje zapisuje. Ustawienie, którego plan nie obejmuje, jest odrzucane, a nie pomijane.update_profile_business_identityzapisuje tożsamość firmową w profilu, który będzie właścicielem numeru.