Centrum pomocyIntegracje

Dla: Administratorzy

Znajdź przypadki z kluczem centralnym

Wypisz 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.

W tym artykule7 sekcji

Zanim zaczniesz

Ta strona opisuje sposoby, w jakie klucz centrali wykorzystuje się do znajdowania określonych przypadków. Drogi dostępu znajdują się pod https://prd-api-app.caseactive.com/v1/<hub id>.

Połączenia

DzwonićCo to robi
GET /casesLista otwartych lub zamkniętych spraw w twoim centrum zarządzania.
GET /cases/searchWyszukiwanie przypadków według identyfikatora taga lub tytułu
GET /whoamiProszę sprawdzić ustawienia twojego hubu, np. typy obiektów i strony dotyczące danych polowych.
GET /rolesLista ról obecnych w centrum komunikacji
GET /stagesLista etapów obecnego stanu twojego centrum.
GET /schemasProszę sprawdzić stan danych swojego klienta oraz użytkowników, a także pól dostosowanych do ich potrzeb.

Klucz „hub” funkcjonuje jako 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. w całym systemie. Dzięki temu wszystkie połączenia docierają do każdego przypadku, który znajduje się w obrębie systemu. W tym celu użyto dwóch przykładów przypadków.

Klucz hub nie może tworzyć przypadków: POST /cases odpowiada na próbny numer 403 HostCreateCaseNotEnabledException. Aby tworzyć przypadki za pomocą swojego oprogramowania, użyj klucza do zarządzania przypadkami; patrz Tworzenie i aktualizowanie przypadków za pomocą klucza do zarządzania.

Wypisywanie przypadków

ParametrCo to robiWymaganyDomyślny
status1 – dla spraw w trakcie rozprawy, 0 – dla spraw zamkniętych.Nie1
limitIle przypadków może być przechowywanych na jednej stronie, maksymalnie 1000.Nie20
start_keystartKey z poprzedniej stronyNieStrona pierwsza
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
        "title": "Jane Sample auto accident",
        "team": {
          "cu-7e6d5c4b3a2f10": "role::bots",
          "cu-4f1c2a9e8b7d60": "role::clients",
          "cu-9d8c7b6a5f4e30": "role::staff"
        }
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1"
  }
}
  • Pozbawienia są sortowane w porządku ID taguIdentyfikator tagu Trwała etykieta nadawana obudowie, np. rear-end-2026, wyświetlana również jako ID referencyjne i używana przy imporcie., od Z do A, a nie według daty.
  • case_ref_id to identyfikator twojego huba, dwa kropki oraz identyfikator tagu tego huba.
  • team Przypisuje każdemu osobie w przypadku odpowiednią rolęRola Zestaw uprawnień decydujący o tym, co dana osoba może zobaczyć i zrobić w danej sprawie, np. pracownicy lub klienci., bez podawania nazwisk. Jeśli chodzi o nazwiska, należy zapoznać się z informacjami dotyczącymi zespołu danego przypadku; patrz Wczytuj i aktualizuj informacje o przypadku za pomocą klucza hub.
  • Choć pozostaje jeszcze kilka przypadków, strona ta zawiera również nextLink – pełny adres następnej strony – oraz startKey. Proszę wywołać nextLink lub przesłać startKey jako start_key, aż pojawi się strona, która nie zawiera tych elementów.
  • Przypadki, które zostają usunięte, są pominięte. Dlatego strona może mieć mniej niż limit przypadków, choć wciąż istnieje więcej takich przypadków. Należy patrzeć na liczbę nextLink, a nie na liczbę całkowitą.
  • Tytuł i status danej sprawy mogą się zmieniać o kilka sekund.

Przeszukiwanie przypadków

GET /cases/search pasuje do słów znajdujących się w dowolnym miejscu identyfikatora tagów danego przypadku. Może również odnosić się do początku każdego słowa w tytule. Pozwala na wykrywanie niewielkich błędów w tekście. Nie sprawdza natomiast opisów.

ParametrCo to robiWymaganyDomyślny
querySłowa, które należy szukać. Wysłać * dla każdego przypadku.Tak.–
status1 – dla spraw w trakcie rozprawy, 0 – dla spraw zamkniętych.Nie1
limitIle wyników może znajdować się na jednej stronie, maksymalnie 250.Nie20
pageKtóra strona wyników, numer 1Nie1
sort_byTakie pola i kierunki jak created_on:desc. Potrzebne są też wartości dla created_on, date_opened, last_activity, updated_on, users_ct i case_status.NieNajlepszy wybór na początek
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "found": 1,
    "page": 1,
    "hits": [
      {
        "document": {
          "case_id": "cc-1a2b3c4d5e6f70",
          "ref_id": "rear-end-2026",
          "title": "Jane Sample auto accident",
          "case_status": 1,
          "case_type": "general",
          "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
          "date_opened": 1772668800,
          "created_on": 1791043509,
          "last_activity": 1791050112,
          "users_ct": 3
        }
      }
    ],
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026"
  }
}
  • Każdy z tych uderzeń… document Zawiera identyfikator sprawy, bezwzględny identyfikator tagów, tytuł, status. typ przypadkuTyp sprawy Kategoria przypadków, np. ogólnych, służąca do kierowania automatyzacji do odpowiednich przypadków., etapScena 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., Ile osób jest na tym urządzeniu, a także kiedy to nastąpiło, w sekundach systemu Unix w czasie UTC.
  • found wskazuje, ile przypadków pasują do określonej kryterii. Przejrzyj je za pomocą page. Nie ma żadnego wyrażenia typu nextLink.
  • Dokumenty można przeszukiwać w ciągu kilku sekund po jakimkolwiek zmianach.

Znalezienie sprawy według jej identyfikatora tagu

Nie istnieje możliwość precyzyjnego wyszukiwania według identyfikatora tagów. Należy więc wykonać wyszukiwanie, a następnie przechować wynik wyszukiwania. document.ref_id To właśnie jest twoja identyfikator tag. W poszukiwaniach znajdują się również bliskie odpowiedniki tego identyfikatora. rear-end-2025. Wyszukiwanie w status=1, potem status=0, Aby pokrywać różne przypadki – tak otwarte, jak i zamknięte.

Gdy uzyskasz identyfikator sprawy, każda wiadomość dotycząca tej sprawy będzie wykorzystywać ten identyfikator. Zobacz informacje w sekcji „Czytanie i aktualizowanie danych o sprawie za pomocą klucza hub”.

Ustawienia Twojego centrum

DzwonićNa co odpowiada
GET /whoamiID użytkownika klucza, nazwa twojego centrum, typy kaset, które obsługuje, oraz sekcje, na których może pracować. host_default_schemas, Jego karta i strony dotyczące użytkownika
GET /rolesKażda rola, w tym również rola Wirtualnego Asystenta, zawiera elementy role::bots, role_id, name, description, color i reads_notes. Rola ta potrafi czytać notatki.
GET /stagesKażdy etap, od początku do końca, z stage_id, name, description i order
GET /schemasdefault_schemas, strony zawierające dane klienta oraz pola dostępne dla użytkownika. Każda z tych stron zawiera klauzule, etykiety i typy poszczególnych pól.

Żadna z tych stron nie odpowiada na wszystkie pytania naraz.

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionBrakuje lub parametr jest nieprawidłowy – na przykład pusty query lub status, które nie wynosi 0 ani 1. Nazwa parametru to errors.
400InvalidStartKeyExceptionstart_key pochodzi z innego listy.
400SearchParameterExceptionWyszukiwanie odrzuca takie parametry, jak sort_by w przypadku pola tekstowego, lub parametr limit przekraczający wartość 250. Parametr reason określa, który element chcemy znaleźć.
403HostCreateCaseNotEnabledExceptionA Hub Key próbował stworzyć jakieś wyjaśnienie.

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.IntegracjeOdczytaj i zaktualizuj szczegóły sprawy za pomocą klucza centralnegoPrzeczytaj 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.IntegracjeTwórz i aktualizuj sprawy za pomocą klucza zarządzaniaTwórz, twórz, czytaj, aktualizuj i usuwaj sprawy swojego huba z poziomu własnego oprogramowania, łącznie z ich etapami i polami niestandardowymi.IntegracjeObsł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