Dla: Administratorzy
Twórz i aktualizuj sprawy za pomocą klucza zarządzania
Twórz, twórz, czytaj, aktualizuj i usuwaj sprawy swojego huba z poziomu własnego oprogramowania, łącznie z ich etapami i polami niestandardowymi.
W tym artykule10 sekcji
Zanim zaczniesz
Ta strona opisuje, jak można używać kluczy do zarządzania. Drogi prowadzą pod https://prd-api-manage.caseactive.com/v1/<hub id>.
Połączenia
| Dzwonić | Co to robi |
|---|---|
GET /cases | Lista przypadków z twojego centrum zarządzania, najnowsze na początku. |
POST /cases | Tworzy sytuację/stan. |
GET /cases/<case_id> | Czytanie jednego przypadku |
PUT /cases/<case_id> | Zmiana sposobu wyrazania litery lub sylaby |
DELETE /cases/<case_id> | Usuwa przypadek na zawsze. |
GET /stages | Wyświetla listę etapów w obiekcie, aby można było znaleźć ich identyfikatory. |
GET /schemas?schema_type=cases | Czy czytam pola specjalne w przypadku twojego klienta? |
Wypisywanie przypadków
| Parametr | Co to robi | Wymagany | Domyślny |
|---|---|---|---|
type | 1 odnosi się tylko do spraw w trakcie rozprawy, 0 natomiast do spraw już zamkniętych. Pomimo nazwy, filtruje się według statusu sprawy, a nie jej typu. | Nie | Oba |
limit | Ile przypadków może być przechowywanych na jednej stronie, maksymalnie 1000. | Nie | 20 |
start_key | startKey z poprzedniej strony | Nie | Strona pierwsza |
curl "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"items": [
{
"case_id": "cc-1a2b3c4d5e6f70",
"host_id": "ca-7e6d5c4b3a2f10",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_type": "general",
"case_status": 1,
"case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
"users": {
"cu-7e6d5c4b3a2f10": "role::bots",
"cu-4f1c2a9e8b7d60": "role::clients",
"cu-9d8c7b6a5f4e30": "role::staff"
},
"created_on": "2026-10-02T14:05:09+00:00"
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1"
}
}
usersKażda osoba w tym przypadku odpowiada za swoje czyny. rolaRola Zestaw uprawnień decydujący o tym, co dana osoba może zobaczyć i zrobić w danej sprawie, np. pracownicy lub klienci.. Wchodzi w skład urządzenia, którym kierujesz. 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., jakrole::bots.- Choć pozostaje jeszcze kilka przypadków, strona ta zawiera również
nextLink– pełny adres następnej strony – orazstartKey. Proszę wywołaćnextLinklub przesłaćstartKeyjakostart_key, aż pojawi się strona, która nie zawiera tych elementów. - Pojawiają się tu te przypadki, które zostały usunięte. Aby znaleźć dany przypadek według jego ID tagówIdentyfikator tagu Trwała etykieta nadawana obudowie, np. rear-end-2026, wyświetlana również jako ID referencyjne i używana przy imporcie., patrz Wyszukiwanie przypadków i użytkowników za pomocą klawisza „Manage”.
Pola przypadku
POST /cases i PUT /cases/<case_id> przyjmują te pola jako dane w formacie JSON. Pola, które nie są wymienione w liście, zostają pominięte.
| Pole | Co to robi | Wymagany | Domyślny |
|---|---|---|---|
ref_id | ID przypadku: litery, cyfry, kropki i przecinki – wszystko to pisane małymi literami. Żadne dwa przypadki w twoim systemie nie mogą mieć tego samego ID. ID ten jest ustawiany tylko przy tworzeniu nowego przypadku; nie można go zmienić. | Tak, w celu tworzenia. | – |
title | Nazwa sprawy, którą pokazano wszystkim. | Tak, w celu tworzenia. | – |
description | Opis dla personelu. Klienti tego nie widzą. W przypadku zmian, "" usuwa to element. | Nie | Żadnego. |
case_type | general, Lub jeden z twoich partnerów. Typy przypadkówTyp sprawy Kategoria przypadków, np. ogólnych, służąca do kierowania automatyzacji do odpowiednich przypadków., Wymowa jest następująca: Ustawienia › Pola. Po zmianie tego ustawienia, typ danego obiektu zostaje również przyjęty po usunięciu go z ustawień. | Nie | general |
case_status | 1 oznacza pozycję otwartą, 0 pozycję zamkniętą. | Nie | 1 |
case_stage | ID swojego scenariuszaScena 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., pochodzący z GET /stages. W przypadku zmian, "" usuwa ten scenariusz ze swojej sceny. | Nie | Żadnego etapu |
date_opened | Data rozpoczęcia postępowania, np. 2026-03-15 | Nie | Dziś, w czasie UTC |
hidden_modules | Sekcje, które należy ukryć w tym przypadku: case, convos, events, forms, signs, invoices, notes, tasks i team. Wyślij [], aby ponownie pokazać je wszystkie. | Nie | Żadnych ukrytych elementów. |
meta_data | Jego pola zwyczajowe; patrz poniżej. | Nie | Żadnego. |
Nie można dodawać osób do procesu tworzenia nowych spraw. Tylko asystent wirtualny może być dodany do nowej sprawy. Dodaj je później. POST /cases/permissions; patrzeć Dodawanie i usuwanie elementów składających się z przypadków za pomocą klawisza „Manage”..
Tworzenie sprawy
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ref_id": "rear-end-2026", "title": "Jane Sample auto accident", "case_type": "general", "date_opened": "2026-10-02"}'
Odpowiada na 201 przy użyciu identyfikatora nowego przypadku:
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases"}}
Nikt nie otrzymuje e-maili. Reguły dotyczące przydzielania spraw dla każdej sprawy, a także dla danego typu sprawy, polegają na tym, że do danej sprawy przyznaje się odpowiedniego personelu. Dlatego samodzielne dodanie jakiegoś członka do tej grupy jest odrzucane, ponieważ stanowi to duplikację już istniejącej osoby. Sprawa utworzona na jakimś etapie nie otrzymuje żadnych informacji dotyczących jej postępu.
Czytanie przypadku
GET /cases/<case_id> odpowiada na sprawę case_id, host_id, ref_id, title, description, case_type, case_status, case_stage, date_opened, hidden_modules, meta_data, users_ct Ile osób jest na tym programie – wliczając również asystentu wirtualnego. created_on i updated_on. Aby dowiedzieć się, kto jest za tym, użyj: GET /cases/permissions?case_id=<case_id>.
Zmiana przypadku
PUT /cases/<case_id> przyjmuje dowolne z polów typu „case”, ale nie ref_id. Zmienia tylko te pola, które zostały wysłane przez użytkownika. Odpowiada na 204 bez żadnych zmian.
- Przenoszenie otwartego przypadku do określonego etapu dodaje informację o tym etapie do historii przypadku. Jeśli twoje centrum zarządzania przypadkami posiada 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 typu nie informuje żadnych osób.
meta_datazastępuje każdy specjalny polo, który występuje w tekście.- Zamknięty przypadek można nadal zmienić, więc synchronizacja może go ponownie otworzyć za pomocą
"case_status": 1.
Etapy i pola niestandardowe
GET /stages wyświetla etapy, które administrator ustala pod kątem Ustawienia › Gradacja. Każdy etap ma odpowiednie oznaczenia: stage_id, name, description i order. Klucz może tylko czytać informacje o poszczególnych etapach, ale nie może ich zmieniać.
GET /schemas?schema_type=cases odpowiada na pola specjalne twojego hubu, umieszczone pod Ustawienia › Pola. Te pola przedstawiają się jako lista stron, z których każda zawiera klucze, etykiety i typy danych związanych z tym polami. meta_data jest przesyłany w formie listy, w której na każdej stronie znajduje się jeden element. Wszystkie elementy tej listy mają takie same wartości, podane w zależności od klucza danego pola.
{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}
Wartość musi pasować do typu danej pola, w przeciwnym razie pozwolenie na wykonanie polecenia zostanie odrzucone. wymagany jest sprawdzany tylko przez formularze w Panelu Administracyjnym i w lobby. Dlatego też pole, które tworzysz lub aktualizujesz tutaj, może pozostać puste.
Usuwanie sprawy
DELETE /cases/<case_id> odpowiada na 204. Taki przypadek natychmiast usunie twoje listy z systemu, a potem je zostanie zupełnie usunięte – wraz z postami, plikami, formularzami, e-signami, fakturami, wydarzeniami, zadaniami i notatkami. Nie można tego cofnąć, a nikomu o tym nie powiedziano. Identyfikator tagów zostaje ponownie używany po zakończeniu usunięcia.
Jeśli połączenie zostanie odrzucone
| Status | message | Dlaczego |
|---|---|---|
| 400 | SchemaFieldsException | W tym polu brakuje informacji lub są one nieprawidłowe; nazwa tego pola to errors. Nieznany typ przypadku lub etap w tym polu to FieldValidatorFailedException. |
| 400 | CaseReferenceIdExistsException | Inny przypadek również posiada tę identyfikatora „Tag”. Nawet przypadki, które są jeszcze usuwane, nadal posiadają ten identyfikator. reason reprezentuje case_id tego przypadku. |
| 404 | ItemNotFoundException | Ten przypadek nie istnieje, należy do innego hubu, lub jest usuwany. |
| 403 | ManageBillingInactiveException | Panel administracyjny twojego partnera zostało zamknięte po nieudanej transakcji płatności. |
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.