Centrum pomocyIntegracje

Dla: Administratorzy

Odczytaj i zaktualizuj szczegóły sprawy za pomocą klucza centralnego

Przeczytaj szczegóły sprawy i zespołu, a następnie zmień szczegóły, które administrator może zmienić przy użyciu roli wirtualnego asystenta, np. etap lub pole niestandardowe.

W tym artykule8 sekcji

Zanim zaczniesz

Na tej stronie opisano jak czytać i modyfikować szczegóły jednego przypadku za pomocą klucza hub. Drogi są oznaczone symbolem https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Połączenia

DzwonićCo to robi
GET /caseCzytanie szczegółów sprawy
PUT /caseZmienia się szczegóły; klucz może się różnić.
GET /whoamiWskazuje, które szczegóły dotyczą kluczowych elementów, które mogą się zmienić w tym przypadku, oraz które sekcje są pokazane.
GET /teamWylicza osoby zaangażowane w rozwiązywanie tego przypadku.
GET /placeholdersProszę odczytać wartości, które kodów twoich szablonów zawierają w tym przypadku.

Co to za informacje, które „hub key” może przeczytać i zmienić? To zależy od roli „huba”. 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., boty. Standardowe informacje dotyczące sprawy są odczytywane automatycznie. Żadna z tych informacji nie może zostać zmieniona, dopóki administrator tego nie zrobi.

Pozwalając kluczowi zmienić szczegóły

W Ustawienia › Role, Zmienić rolę botów i… Walizka, kropka Uaktualnij wszystkie pola danych wskazane w rolce. A szczegóły mogą się zmienić… Klucz może się różnić. Tytuł, Opis, Data otwarcia, Status, Scena Lub pola dostarczone przez użytkownika. Aby pozwolić na czytanie danych z pola dostarczonego przez użytkownika, należy je zaznaczyć. Proszę przeczytać wszystkie pola określone w rolce.. Widzisz Zmienić to, co może zrobić dana rola..

GET /whoami Odpowiada na rolę klucza w tym przypadku. case_read_fields i case_write_fields, W szczegółach może być różne informacje, które się zmieniają. case_write_fields Zostaje pominięty, ponieważ może nie zmienić niczego. Pole domowe pokazuje to jako… meta_data.<field key>. Również odpowiada na to pytanie. case_modules, Sekcje, które występują w tym przypadku: sekcje twojego huba, bez żadnych ukrytych elementów w tym przypadku. Prośba dotycząca sekcji, która brakuje, jest odrzucona.

Czytanie przypadku

curl https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "host_id": "ca-7e6d5c4b3a2f10",
    "ref_id": "rear-end-2026",
    "title": "Jane Sample auto accident",
    "description": "Rear-end collision on Route 9. Waiting on the insurer's estimate.",
    "case_type": "general",
    "case_status": 1,
    "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
    "date_opened": "2026-03-05",
    "meta_data": {
      "schema": [{"schema": {"type": "object", "properties": {"policy_number": {"type": "string", "title": "Policy number"}}}}],
      "content": [{"policy_number": "PN-5521"}]
    },
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case"
  }
}
  • W podstawie danych klawisz ten odpowiada na pustą literę. case_id, ref_id (tak) ID tagaIdentyfikator tagu Trwała etykieta nadawana obudowie, np. rear-end-2026, wyświetlana również jako ID referencyjne i używana przy imporcie.), case_status, date_opened, title, description, case_type i case_stage. Jedna rzecz w tym przypadku została pominięta.
  • case_stage to identyfikator etapuScena Etap, przez który przechodzi sprawa, taki jak Przyjęcie lub Wysłanie żądania, który firma nazywa i opisuje, a który jest wyświetlany na stronie sprawy.; GET /v1/<hub id>/stages zawiera nazwy tych etapów.
  • meta_data.content przechowuje wartości polów dostępnych dla danej tabeli. Każdy obiekt reprezentowany jest w osobnym ekranie, według klucza pola. Jednak tylko te pola, których klucz może być odczytany, są uwzględniane. W podstawie nie czytuje żadnych danych, więc pierwszy ekran jest pusty. W przykładzie administrator pozwolił na odczytanie numeru polisy. meta_data.schema opisuje pola znajdujące się na każdym ekranie.
  • hidden_modules wyświetla sekcje, które są w tym przypadku ukryte, jeśli takowe istnieją.

Zmiana przypadku

PUT /case przyjmuje dowolny z tych poli jako dane w formacie JSON i zmienia tylko te pola, które zostały wysłane przez użytkownika.

PoleCo to robiWymaganyDomyślny
titleNazwa sprawy, którą pokazano wszystkim.NieBez zmian
descriptionOpis dla personelu: Wyślij "", aby go wyczyścić.NieBez zmian
date_openedData rozpoczęcia postępowania, np. 2026-03-15NieBez zmian
case_status0 Aby zamknąć tę sprawę, należy użyć klucza do zamknięcia. Klucz ten nie pozwala ponownie otworzyć tej sprawy.NieBez zmian
case_stageID sceny pochodzi z GET /v1/<hub id>/stages. Wyślij "", aby usunąć tę scenę z jej pozycji.NieBez zmian
meta_dataWartości polów dostarczanych przez użytkownika: lista z jednym obiektem na stronę pola, w kolejności, przy czym każdy obiekt zawiera wartości odpowiadające danym polom. Można zmienić tylko pierwszą stronę tej listy, a także tylko te pola, których wartości są dostarczane przez użytkownika. Aby wyczyścić dany pol, należy użyć "" lub null. Pola wymagane nie mogą być wyczyszczone.NieBez zmian
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_stage": "stage::20260927120000_8c1f0e2d3b4a59", "meta_data": [{"policy_number": "PN-5521"}]}'

Odpowiada na 200 przy użyciu identyfikatora przypadku. Jeśli jakikolwiek pola, które przesłane są, nie należy do tych wymaganych, to klucz może się zmienić, a jego wartość różni się od wartości z przypadku. W takim przypadku cała próba wykonania połączenia zostaje odrzucona z powodu błędu 403, a nic się nie zmienia. Pole reason określa pola, a pole meta_data.<field key> określa specjalne pole. Pole przesłane z wartością, która już występuje w przypadku, nie stanowi żadnej zmiany, więc ani nie jest odrzucane, ani nie jest zapisane. Połączenie, które nie wprowadza żadnych zmian, odpowiada na 204.

  • Przenoszenie otwartego przypadku do określonego etapu dodaje informację o tym etapie do historii przypadku. Jeśli twoje centrum zarządzania przypadkami ma taką funkcję, możesz skorzystać z niej. Zobacz „Dodawanie automatycznej informacji o etapie przypadku”. Nic innego nie jest publikowane lub wysyłane: zamknięcie przypadku lub zmiana jego szczegółów nie informuje żadnych osób.
  • Po zamknięciu sprawy, wszelkie zmiany wprowadzone za pomocą klucza dostępu są odrzucane, w tym również możliwość ponownego otwarcia sprawy. Aby to zrobić, należy korzystać z panelu administracyjnego lub klucza do zarządzania. Zobacz Zamknięcie lub ponowne otwarcie sprawy.
  • ID taga i typ przypadku nie mogą być zmieniane tutaj; typ można zmienić za pomocą klucza zarządzającego.

Zespół

GET /team wyświetla na jednym miejscu wszystkich osób związanych z tym przypadkiem – w tym także osoby korzystające z usług Asystenta Wirtualnego oraz osoby niepełnosprawne. W jednym przypadku może znajdować się maksymalnie 20 osób. Tak podał Asystent Wirtualny.

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": 1,
        "host_user_status": 1,
        "given_name": "Jane",
        "family_name": "Sample",
        "locale": "en",
        "zoneinfo": "America/New_York"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/team"
  }
}
  • case_role_id to rola danej osoby w tym przypadku, a case_designation to jej identyfikatorOznaczenie Etykieta określająca czyjeś obowiązki w danej sprawie, np. Główny prawnik, Pomocnik prawny lub Opiekun., np. primary.
  • host_user_status jest równy 0 dla osób niepełnosprawnych w twoim regionie.
  • Imiona każdej osoby, języklocale) oraz strefa czasowazoneinfo) Wraca się do tego punktu od razu. Adresy e-mail i numery telefonów nigdy nie wracają.
  • Klucz hub nie może dodawać ani usuwać osób z listy użytkowników. Te połączenia są odpowiadane przez mechanizm 403. HostAddCaseUserNotEnabledException i HostRemoveCaseUserNotEnabledException. Użyj klucza do zarządzania; patrz. Dodawanie i usuwanie elementów składających się z przypadków za pomocą klawisza „Manage”..

Wartości szablonu

GET /placeholders Odpowiedzi, pod… placeholders, W tym przypadku wartość, którą każdy kod w twoich szablonach zawiera, to np.: clients.primary.full_name, clients.primary.email, case_ref_id i company.phone. Kod odpowiadający żadnemu nazwie w przypadku tego przypadku jest pominięty. Gdy sekcja „Zespół” jest wyłączona lub ukryta w przypadku tego przypadku, wszystkie kody zespołów są pominięte, ale reszta nadal funkcjonuje. Zobacz. Wypełnij pola formularza z informacjami o przypadku..

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionPole jest nieprawidłowe – np. puste pole title, pole wymagane, które zostało wysłane jako puste, lub pole, który nie istnieje w twoim systemie; nazwa tego pola to errors.
403CaseFieldNotWritableExceptionPolje, które wyślijłeś, nie należy do tych, których nazwy mogą się zmieniać; reason określa je jako takie.
403CaseClosedExceptionSprawa została zamknięta.
403HostModuleDisabledExceptionDokładne informacje na temat tego przypadku są ukryte w tym „case’ie” lub zostały wyłączone dla twojego huba.
403CaseModulePermissionDeniedExceptionRola botów może uniemożliwić odczytanie szczegółów sprawy lub informacji dotyczących zespołu.
404CaseNotFoundExceptionTen przypadek nie istnieje, należy do innego hubu, lub jest usuwany.

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

Zrozum, co może zrobić APIDowiedz się, do czego służy klucz zarządzający i klucz centralny, dlaczego każdy klucz pełni funkcję wirtualnego asystenta i gdzie znajduje się pełna lista danych technicznych.IntegracjeZnajdź przypadki z kluczem centralnymWypisz sprawy w swoim hubie, otwarte lub zamknięte, wyszukaj je według identyfikatora tagu lub tytułu i znajdź identyfikator sprawy we własnym oprogramowaniu.IntegracjeZmień, co może zrobić dana rolaEdytuj uprawnienia roli, pola sprawy, które może ona odczytywać lub zmieniać, a także jej limity przesyłania, łącznie z wbudowanymi rolami.Bezpieczeństwo i konto · 5 minObsługa błędów API i kodów statusuPrzeczytaj treść błędu, co oznaczają kody 400, 401, 403, 404, 500 i 503 i dlaczego element, którego klucz dotyczy, nie widzi odpowiedzi 404.Integracje