Dla: Administratorzy
Przeczytaj role za pomocą klucza zarządzania
Wypisz role swojego centrum i przeczytaj uprawnienia jednej roli, tak aby Twoje oprogramowanie mogło przydzielać do spraw osoby z odpowiednią rolą.
W tym artykule5 sekcji
Zanim zaczniesz
Ta strona obejmuje informacje dotyczące czytania danych z urządzenia, którym korzystasz. roleRola Zestaw uprawnień decydujący o tym, co dana osoba może zobaczyć i zrobić w danej sprawie, np. pracownicy lub klienci., Identyfikatory osób, których przesyłasz podczas umieszczania kogoś w sprawie. Dostępne są pod: https://prd-api-manage.caseactive.com/v1/<hub id>. Klucz może tylko odczytywać roli, ale nie może ich tworzyć, zmieniać ani usuwać.
Połączenia
| Dzwonić | Co to robi |
|---|---|
GET /roles | Lista ról obecnych w centrum komunikacji |
GET /roles/<role_id> | Czyta się jedną rolę, wraz z odpowiednimi uprawnieniami, które przysługują jej. |
GET /roles przyjmuje jako parametry limit (domyślnie 20) oraz start_key, a także startKey z poprzedniej strony. Hub może mieć maksymalnie 20 ról. Dlatego jeden wywołanie z użyciem limit=20 pozwala na obsłużenie wszystkich roli.
Identyfikatory ról
ID roli wynosi role::, a jej nazwa to role::senior-paralegal. Każdy hub ma trzy wbudowane role.
| Identyfikator roli | Dla kogo to jest |
|---|---|
role::clients | Klientów |
role::staff | Twoja drużyna |
role::bots | Twój partner/partnerka Wirtualny asystentAsystent 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., Każdy klucz API pełni tę rolę. Nie dawaj go żadnej osobie. |
Jaką rolę pełni
GET /roles odpowiada na role_id, name, role_type (system dla trzech wejściowych roli, custom dla swojej roli). Ponadto description, color i users_ct oznaczają liczbę miejsc, które może zajmować w poszczególnych przypadkach.
{
"data": {
"items": [
{"role_id": "role::clients", "name": "clients", "role_type": "system", "color": "#10B981", "users_ct": 214},
{"role_id": "role::senior-paralegal", "name": "senior-paralegal", "role_type": "custom", "description": "Paralegals who run intake", "color": "#6366F1", "users_ct": 9}
],
"currentItemCount": 2,
"selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles"
}
}
GET /roles/<role_id> dodaje:
| Pole | Co zawiera |
|---|---|
permissions | Jaka rolę może pełnić każda z tych sekcji w danym przypadku: case, convos, events, posts, forms, signs, invoices, notes, tasks i team. Każda z tych sekcji zawiera nazwy takie jak list_posts (patrz je), put_post (dodaj lub edytuj własne dane), delete_post, put_comment i moderator (zarządzanie danymi wszystkich użytkowników). |
case_read_fields, case_write_fields | Opisuje rolę, jaką pełni, oraz te role, które mogą się zmienić. |
user_read_fields, user_write_fields | Dokładne informacje o innych osób zaangażowanych w tę sprawę mogą się różnić, a także może się zmienić ich rola w tym procesie. |
file_size | Największy plik, który może zostać załadowany do tej roli, w megabajtach, według rodzaju: audios, docs, files, images, schemas i videos |
Lista zawiera informacje o rolach, ale niektóre z nich są pominięte w odpowiedzi.
W podstawie. role::staff i role::bots Może zarządzać wszystkim w ramach jednego przypadku. role::clients Można zobaczyć całą strukturę danego projektu, a także wszystkie sekcje. Można również dodawać własne informacje, formularze, elementy graficzne i zadania. Ponadto można wypłacać faktury. Struktura projektu może się zmienić. Co daje każda z uprawnień, znajduje się w informacjach dodatkowych. Sprawdź wszystkie uprawnienia do pełnienia poszczególnych ról..
Jeśli połączenie zostanie odrzucone
| Status | message | Dlaczego |
|---|---|---|
| 404 | ItemNotFoundException | Twój partner nie ma żadnego udziału w tym identyfikatorze. |
| 403 | BotNotAllowedException | Próbowałeś utworzyć, zmienić lub usunąć jakąś rolę. |