Centrum pomocyIntegracje

Dla: Administratorzy

Dodawaj i aktualizuj użytkowników za pomocą klucza zarządzania

Wyświetl listę osób w swoim centrum, dodaj klientów, przeczytaj dane i sprawy poszczególnych osób, a także wyłącz lub ponownie włącz ich dostęp.

W tym artykule7 sekcji

Zanim zaczniesz

Ta strona obejmuje informacje dotyczące osób pracujących w twoim centrum. Drogi dostępu znajdują się pod https://prd-api-manage.caseactive.com/v1/<hub id>. Funkcja „Key” umożliwia dodawanie osób jako użytkowników, ale zmienia tylko ich możliwość logowania się do systemu. Nie może ona sprawić, aby ktoś stał się administratorami lub menedżerami, ani nie może zmieniać danych osoby po jej dodaniu do listy użytkowników.

Połączenia

DzwonićCo to robi
GET /users/relationsWyświetla listę osób znajdujących się w twoim centrum.
POST /users/relationsDodaje kogoś do listy.
GET /users/relations/<user_id>Czytanie tekstu przez jedną osobę
PUT /users/relations/<user_id>Wyłącza lub ponownie aktywuje kogoś
GET /users/relations/<user_id>/casesWylicza przypadki, w których dana osoba znajduje się w danej sytuacji.

Wypisywanie osób

ParametrCo to robiWymaganyDomyślny
type1 przeznaczone jest tylko dla osób aktywnych, a 0 – dla osób niepełnosprawnych. Pomimo nazwy, filtrowane są dane według statusu osoby, a nie jej typu użytkownika.NieOba
limitIle osób może znajdować się na jednej stronie – do 1000 osób.Nie20
start_keystartKey z poprzedniej stronyNieStrona pierwsza

Każda osoba posiada następujące informacje: user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type (admin, manage lub user), host_user_status (1 aktywne, 0 wyłączone), host_ref_id, host_default_role, host_staff_designation, host_cases_ct (liczba przypadków), host_granted_status (approve lub reject po usunięciu dostępu do ich profilu przez twojego „hub”) oraz created_on. Lista ta nie jest uporządkowana. Wśród tych informacji znajduje się Virtual AssistantAsystent wirtualny Automatyczny członek zespołu, który publikuje wiadomości powitalne, meldunki i wpisy dotyczące etapów rozwoju firmy. Jego wpisy są oznaczone odznaką wirtualnego asystenta. twojego „hub”, który ma host_user_type wynosi bot. Ponadto w liście znajdują się dwa przykładowe osoby, których profily są automatycznie tworzone przy każdym nowym „hubie”. Jedna z nich, Staff Demo, ma host_user_type staff. Jeśli pozostają jeszcze inne osoby, proszę zadzwonić na numer nextLink lub wysłać wiadomość na adres startKey jako start_key.

Dodawanie kogoś

PoleCo to robiWymaganyDomyślny
usernameAdres e-mail, albo numer telefonu z kodem kraju, np. +12035556677. Numer bez kodu kraju jest traktowany jako numer z USA.Tak.–
given_name, family_nameImię i nazwisko zachowano w formie wpisanej. Te słowa, które zostały napisane w małych literach lub w dużych literach, należy przepisywać każde po kolei: mary smith zostaje przepisane jako Mary Smith.Tak.–
localeJęzyk: ar, de, en, es, fr, id, it, ja, pl, pt, ru lub zhNieen
zoneinfoStrefa czasowa, np. America/New_YorkNieUS/Eastern
host_ref_idTwój własny identyfikator dla nich – np. numer klienta. Zawierać może litery, cyfry, kropki i przecinki. Litera pisana jest małą literą. Żadna dwie osoby nie mogą mieć tego samego identyfikatora.NieŻadnego.
host_default_roleRola ta zostaje przyznana jako pierwsza, gdy są one dodawane do jakiegoś obiektu, np. role::clients. Nie daje żadnych korzyści.Nierole::clients
host_staff_designationIch standardowe nazwy personelu to: primary, attorney, paralegal, case_manager, lead_attorney lub lead_paralegal.Nieprimary
birthdateData urodzenia, np. 1985-04-12NieŻadnego.
genderMale lub FemaleNieŻadnego.
address1, address2, locality, region, postal_codeAdres, druga linia, miasto, stan i kod pocztowyNieŻadnego.
countryKod krajowy składający się z dwóch liter, np. USNieŻadnego.
company, titleFirma i tytuł zajmowanego stanowiskaNieŻadnego.
host_meta_dataIch pola specjalne – po jednym obiekcie na stronę swoich użytkowników, w kolejności. Proszę czytać strony w taki sposób. GET /schemas?schema_type=users. Polje oznaczone jako „pole”. wymagany Można je pominąć: sprawdza je tylko moduł Edit User.NieŻadnego.
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"}'

Odpowiada na 201 za pomocą ich user_id.

{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
  • Każda kluczowa informacja stanowi użytkownika, który jest aktywny, niezależnie od tego, co wysyłasz.
  • Klucz nie może dać żadnych uprawnień do obsługi portali: tworzenie spraw, dodawanie osób do spraw lub usuwanie ich z nich. Przesyłanie wiadomości typu host_create_case, host_add_case_user czy host_remove_case_user jest odmówione, a żadna osoba nie zostaje dodana do portali. Administrator może je ustawić na wartość Edytuj użytkownika.
  • Jeśli adres lub numer już posiada konto u innej firmy, albo w ogóle żadne konto nie istnieje, osoba ta jest powiązana z tym kontem. W przeciwnym razie tworzy się nowe konto. W obu przypadkach nikt nie otrzymuje wiadomości e-mailowych ani SMS-ów. Otrzymują informacje od ciebie tylko wtedy, gdy dodasz je do swojego „case” wraz z zaproszeniem. Zobacz „Dodawanie i usuwanie członków case’u za pomocą przycisku zarządzania”.

Czytanie kogoś

GET /users/relations/<user_id> odpowiada na wszystkie informacje z listy, a także na datę urodzenia, płeć, adres, firmę i tytuł. Ponadto występują pola dostępne za pośrednictwem specjalnych opcji, informacje o tym, kiedy ostatni raz się logowały, itp. GET /users/relations/<user_id>/cases przedstawia listę spraw, w których są zaangażowane – w tym także tych zamkniętych spraw. Dla każdej sprawy podawane są informacje o case_id, title, case_ref_id (ID twojego huba, :: i ID tagu), a także case_status oraz case_role_id i case_designation.

Wyłączanie lub ponowne włączanie kogoś

PUT /users/relations/<user_id> Wykorzystuje jedno pole. host_user_status: 0 Aby je wyłączyć. 1 To sprawia, że można je ponownie włączyć. Odpowiada na to prośbę. 204.

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}'
  • Osoba niepełnosprawna ma wszędzie w twoim centrum usług odmówiono jej możliwości korzystania z usług, ale ona nadal pozostaje na swoich konto i kontynuuje korzystanie z usług dla innych firm. Zobacz Wyłącz lub włącz użytkownika.
  • Gdy zmienia się ich status, otrzymują e-maile lub wiadomości tekstowe, jeśli nie mają e-maili. W takich przypadkach informuje się ich o tym, że dostęp został zablokowany lub przywrócony. Poświadczenie statusu, który już posiadają, niczego nie zmienia i nie przesyła żadnych informacji.
  • Klucz może wyłączyć lub ponownie włączyć uprawnienia dla Menedżerów i Użytkowników, ale nie dla Administratorów, ani nie dla samego klucza.

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionBrakuje lub niesprawdzonego pola. Nazwy takich poli to errors. Na przykład FieldUsernameTypeException oznacza nazwę użytkownika, która nie jest adresem e-mail czy numerem telefonu. FieldPhoneTypeException oznacza numer telefonu, który nie jest poprawny. FieldNameTypeException oznacza nazwę osoby.
400FieldUsernameDupsExceptionKtoś, kto jest aktywny w twoim centrum, już posiada tę adres e-mail lub numer telefonu. reason posiada ich user_id.
400HostUserDisabledExceptionTa osoba znajduje się w twoim centrum zarządzania, ale jest niezdolna do działania. Zamiast tego, sprawdź, czy możesz ją ponownie aktywować. reason trzymają się swoich postanowień user_id.
400UserReferenceIdExistsExceptionKtoś inny już ma ten host_ref_id.
400HostUserTypeNotAllowedExceptionPróbowałeś wyłączyć uprawnienia administratora, albo sam klucz.
403BotRelationFieldNotAllowedExceptionWysłałeś informację o pozycji osoby podczas dodawania jej do listy, albo o jakiejkolwiek innej rzeczy. host_user_status podczas ich zmiany
404ItemNotFoundExceptionNikt w twoim regionie nie ma takich user_id

Informacje dotyczące kodu błędów oraz pozostałych kodów znajdują się w sekcji Obsługa błędów API i kodów statusowych.

Powiązane artykuły

Dodawaj i usuwaj członków sprawy za pomocą klucza zarządzaniaPrzydzielaj ludziom sprawy, określając ich rolę i stanowisko, wysyłaj e-maile z zaproszeniami, sprawdzaj, kto zajmuje się sprawą, lub zdejmuj kogoś ze sprawy.IntegracjeWyszukaj przypadki i użytkowników za pomocą klucza zarządzaniaZnajdź sprawy, osoby, członków sprawy, role i importuj wiersze według tekstu, używając filtrów, z własnego oprogramowania.IntegracjeWyłącz lub ponownie włącz użytkownikaZablokuj kogoś w swoim hubie bez usuwania go lub przywróć mu dostęp. W obu przypadkach zostanie o tym poinformowany e-mailem lub SMS-em.Twoi klienci · 1 min