Dla: Administratorzy
Obsługa błędów API i kodów statusu
Przeczytaj treść błędu, co oznaczają kody 400, 401, 403, 404, 500 i 503 i dlaczego element, którego klucz dotyczy, nie widzi odpowiedzi 404.
W tym artykule5 sekcji
Ta strona opisuje, jak obie te aplikacje raportują przeciętne połączenia, zarówno te z kluczem „manage”, jak i z kluczem „hub”.
Treść błędu
Każdy odrzucony telefon ma za sobą kod statusu oraz strukturę tekstową w formacie JSON.
{
"error": {
"code": 400,
"message": "CaseReferenceIdExistsException",
"error_type": "ClientException",
"reason": {"case_id": "cc-1a2b3c4d5e6f70", "host_id": "ca-7e6d5c4b3a2f10"}
}
}
| Pole | Co zawiera |
|---|---|
code | Kod statusu ponownie |
message | Nazwa błędu, np. CaseReferenceIdExistsException. Należy sprawić, aby kod działał zgodnie z tym nazwą błędu; ta nazwa nie zmienia się w zależności od języka użytkownika. |
error_type | Typ błędu: ClientException – w przypadku odmowy zgody, ApiException – w przypadku nieprawidłowego żądania, SessionException – w przypadku braku klucza, ModelException – w przypadku odrzucenia klucza lub odmowy ze strony magazynu danych, TransientException – w przypadku problemów, które wymagają ponownego próbowania, InternalError – w przypadku błędów w funkcji CaseActive. |
reason | Więcej szczegółów, jeśli kiedykolwiek istnieją: identyfikatory nagrań, które się przeszkadzają, albo problem z pierwszym polem. Często te pola są puste. |
errors | Dla żądań nieprawidłowych, jedna informacja na poziomie danych dla każdego pola. |
Błędy polowe
Zgoda składana bez żadnego pola lub z błędnym polem powoduje otrzymanie komunikatu 400 SchemaFieldsException. Dla każdego pola istnieje wpis o nazwie errors. Nazwa pola to location, a kropki służą do oznaczenia, że pole znajduje się wewnątrz innego pola. Nazwa problemu to message.
{
"error": {
"code": 400,
"message": "SchemaFieldsException",
"error_type": "ApiException",
"reason": "FieldRequiredException",
"errors": [
{"domain": "json", "location": "ref_id", "locationId": "ref_id", "locationType": "schema", "message": "FieldRequiredException", "reason": "FieldRequiredException"}
]
}
}
domain to json dla parametrów ciała, a query dla parametrów adresu. Częste błędy w polach:
message | Co jest nie tak? |
|---|---|
FieldRequiredException | Brakuje go, albo jest pusto w miejscach, gdzie go nie ma. |
FieldValidatorFailedException | Jego wartość nie jest dozwolona – na przykład rolka, typ przypadku lub etap, który nie istnieje w twoim hubie. |
FieldMinLengthException, FieldMaxLengthException | To jest zbyt krótka lub zbyt długa opowieść. |
FieldLimitTooLargeException | Wynik limit wynosi ponad 1000, co oznacza, że strona może przechowywać tylko tyle informacji. |
FieldEmailTypeException, FieldPhoneTypeException | Nie adres e-mail, ani numer telefonu z kodem kraju. |
FieldNameTypeException | Imię, które nie może mieć określonych znaków/tekstu. |
FieldPathSlugTypeException | ID lub referencja typu „Tag”, który zawiera znaki innych niż litery, cyfry, kropki i przecinki. |
FieldDateTypeException | To nie jest żaden termin, np. 2026-03-15 |
Te dane, których API nie zna, są ignorowane, a nie odrzucane. Dlatego należy sprawdzić poprawność pisowni tych danych w porównaniu z referencjami.
Kody statusu
| Status | Co to znaczy | Co robić |
|---|---|---|
| 400 | Zgoda jest nieprawidłowa, lub zmiana nie jest dozwolona. Wystąpił błąd w polu, lub doszło do odmowy, określonej w message. Przykład takiej odmowy to CaseReferenceIdExistsException. | Proszę skorygować błędy przed ponownym wysłaniem. |
| 401 | Sam klucz został odrzucony. Zobacz Autentyfikowanie żądań API za pomocą klucza. | Przestań i sprawdź klucz. |
| 403 | Klucz może nie funkcjonować w takich przypadkach: połączenie z kluczem nie może zostać przyjęte (BotNotAllowedException), hub jest zamknięty (ManageBillingInactiveException w przypadku klucza, BillingReadOnlyException w przypadku klucza hubu po przeczytaniu portalu w tryb tylko dla czytania), przypadek jest zamknięty (CaseClosedException), lub zmiana, która koliduje z inną zmianą wykonaną w tym samym momencie (ItemUpdateFailedException i inne). | Należy znaleźć przyczynę problemu. W przypadku konfliktu należy ponownie przeczytać tekst i spróbować ponownie. |
| 404 | Przedmiot nie istnieje, należy do innego hubu, jest usuwany, lub twoja kluczowa struktura nie może go zobaczyć. | Sprawdź identyfikator. |
| 500 | InternalError: błąd w kodzie CaseActive. Twórcy tego oprogramowania muszą go naprawić. | Próbuję ponownie później. Jeśli problem nadal trwa, skontaktuj się z obsługą. |
| 503 | TransientException: Hub był w tym momencie zbyt zajęty. | Powtórzenie po krótkim czasie oczekiwania. Czas oczekiwania za każdym razem jest dłuższy. |
Telefonia trwająca ponad 30 sekund kończy się po prostu przerwą w transporcie danych z sieci, bez żadnego obiektu typu JSON. Importy unikają tego problemu, pracując w tle.
Dlaczego przedmiot, o którym wiesz, istnieje, odpowiada na błąd 404
A „hub key” funkcjonuje jako klucz do kontrolowania „hub”. 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., I widzi tylko to, co może zobaczyć rola wirtualnego asystenta. Elementy ukryte przed tą rolą odpowiadają na błąd 404 – to samo co elementy, które w ogóle nie istnieją. Dlatego API tego elementu nie ujawnia go. Dziś edycja lub usuwanie publikowanej faktury, a także edycja publikowanego e-signa – elementów, których rola nie może widzieć – nadal odpowiada na błąd 403. PublishAlreadyPublishedException. Lista tego typu elementów jest przygotowywana bez żadnego wyraźnego określenia. Aby dowiedzieć się, jakie możliwości daje ta lista, należy przeczytać jej treść. role::bots z kluczem do zarządzania; patrz Proszę odczytywać role przy użyciu klawisza „Manage”..
Można bezpiecznie spróbować ponownie
- 503, oraz wszystkie elementy typu
TransientException, po krótkim czasie oczekiwania. - 400
TransactionCanceledException– to wynik sytuacji, która występuje w momencie pełnego obciążenia. NatomiastCaseUserLimitOrTransactionExceptionpo sprawdzeniu stanu nie jest już pełny. - 500, trochę później.
Nie próbuj więcej różnych kódów typu 400 – 401, 403 czy 404. Będą one ponownie odrzucane.