Dla: Administratorzy
Przesyłaj i dołączaj pliki za pomocą klucza Hub
Uzyskaj adres do przesyłania, prześlij plik, załącz go do wpisu, notatki, zadania, formularza lub podpisu elektronicznego i pobierz pliki sprawy.
W tym artykule10 sekcji
Zanim zaczniesz
Ta strona pokazuje, jak załadowywać pliki do danej sprawy, dodawać je do niej oraz pobierać te pliki za pomocą klucza hub. Żywioły plików znajdują się pod https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Jak to działa
Plik wymaga trzech kroków: najpierw należy uzyskać adres do przesłania pliku, następnie plik należy załączyć do danego elementu.
| Przedmiot | Adres do przesyłania | Przytwierdzać | Usunąć |
|---|---|---|---|
| I później | GET /posts/<post_id>/drive | PUT /posts/<post_id>/media | DELETE /posts/<post_id>/media |
| Uwaga | GET /notes/<note_id>/drive | PUT /notes/<note_id>/media | DELETE /notes/<note_id>/media |
| Zadanie | GET /tasks/<task_id>/drive | PUT /tasks/<task_id>/media | DELETE /tasks/<task_id>/media |
| Zadanie dziecka | GET /subtasks/<subtask_id>/drive | PUT /subtasks/<subtask_id>/media | DELETE /subtasks/<subtask_id>/media |
| Dokument w formie elektronicznej, podpisany elektronicznie lub notatka. | GET /<forms, signs or notes>/<id>/drive przy media_group=schemas | PUT /<forms, signs or notes>/<id>/schema/media | – |
- Klucz może przywiązywać pliki tylko do postów, które zostały utworzone przez Wirtualnego Asystenta. Może też przywiązywać pliki do dowolnych not, zadań lub podzadań.
- Aby przywiązać plik do komentarza, należy uzyskać adres tego pliku wraz z tagiem
/driveodpowiednim dla komentarza lub zadania. Następnie można użyć taguPUT /<posts, signs, tasks or subtasks>/<id>/comments/<comment_id>/media. Klucz może być przywiązany tylko do własnych komentarzy. - Formularz elektroniczny przechowuje tylko jeden dokument, a nie żadne inne pliki. Gdy już ma swój dokument, przyjmuje tylko ten dokument, jeśli pierwszy nie został skonwertowany do odpowiedniej formy.
1. Uzyskaj adres do przesyłania
| Parametr | Co to robi | Wymagany | Domyślny |
|---|---|---|---|
media_group | Typ pliku: docs, images, audios, videos lub files. W przypadku dokumentów typu formularzów, e-signów lub notatek – schemas. | Tak. | – |
media_extension | Rożnica pliku, np. pdf. Musi to być jeden z dostępnych typów rożnic; files może być używany do dowolnego typu rożnicy. | Tak. | – |
tag_id | Nazwa pliku jest zapisana w formie złożonej z liter, cyfr i kropek, np. repair-estimate | Tak. | – |
| Uprzejmy | Rozszerzenia |
|---|---|
docs i schemas | csv, doc, docx, odt, pdf, ppt, pptx, rtf, txt, xls, xlsx |
images | bmp, gif, jpeg, jpg, png, svg, tiff, webp |
audios | aac, aiff, amr, flac, m4a, mp3, oga, opus, wav, wma – a także mniej popularne formaty audio. |
videos | 3GP, AVI, FLV, M4V, MKV, MOV, MP4, MPEG, MPG, OGG, WebM, WMV – a także inne, rzadziej używane formaty wideo. |
files | Każdy |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/drive?media_group=docs&media_extension=pdf&tag_id=repair-estimate" \
-H "Authorization: Bearer YOUR_API_KEY"
Odpowiada na adres url, który należy przesłać, oraz na fields – pola formularza, które należy wysłać razem z plikiem. fields.key to miejsce, gdzie plik zostanie zapisan. Adres ten działa przez godzinę.
2. Prześlij plik
Wysłać multipart/form-data POŁOŻENIE na url, z każdym wpisem w fields Jeśli tak jest, to plik zostaje umieszczony na końcu listy. file. fields Zawiera pustą przestrzeń. Content-Type: Wypełnij tę pola z typem pliku, np. application/pdf, Zamiast wysyłania drugiego z nich. Ten telefon trafia do magazynu plików, a nie do API. Dlatego nie potrzebuje żadnego klucza.
curl -X POST "<url>" \
--form-string "key=<fields.key>" \
--form-string "Content-Type=application/pdf" \
--form-string "<every other entry of fields, as given>" \
-F "file=@repair-estimate.pdf"
Niech wpisy zawierający fields są przesyłane razem z --form-string, a nie z -F. Niektóre wpisy zaczynają się od <, który przez -F jest interpretowany jako plik.
Odpowiada na to. 201. Największym plikiem jest limit na tę kategorię dla asystenta wirtualnego – 5 000 MB w podstawie. Administrator może ten limit zmniejszyć. Ustawienia › Role. Plik przesyłany na ten adres zostaje odrzucony przez system przechowywania plików. Plik załączony do systemu, który nigdy nie został przyczepiony, zostaje usunięty po upływie trzech dni.
3. Przymocuj
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/media \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"media": [{"media_key": "<fields.key>"}]}'
{
"data": {
"items": [{"media_key": "hosts/ca-7e6d5c4b3a2f10/cases/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/media/docs/20261002154512_5f4e3d2c1b0a99/20261002154512_5f4e3d2c1b0a99.pdf", "media_id": "20261002154512_5f4e3d2c1b0a99"}],
"currentItemCount": 1
}
}
mediaobsługuje kilka plików jednocześnie. Każdy z nich musi być załączony z adresem tego samego elementu.- Pozbywanie się plików polega na dodawaniu ich do zawartości danego pliku. Nigdy nie zastępuje onych w zawartości pliku.
- Na tym postie można załączyć swoje webhooki.
add_post_mediaDla każdego pliku istnieje e-mail dotyczący tego pliku. E-mail ten zawiera informacje o liczbie plików, które dotyczy tego pliku.
Po przymocowaniu
Pliki są przetwarzane po ich załączeniu: obrazki są przerabiane w rozmiarze, dźwięk i wideo są przygotowywane do odtwarzania, a dokumenty są konwertowane na format PDF z obrazami stron. Pliki tego typu… files Są trzymane tak, jak są.
Każdy element z listy, np. GET /posts/<post_id>, zawiera informacje o swoich plikach pod nazwą media.<kind>.items.<media_id>.
| Pole | Co zawiera |
|---|---|
execution_status | RUNNING dopóki nie zostanie przetworzone, wtedy SUCCEEDED lub FAILED |
original | Plik został załadowany. |
pdf | Dokument przekształcony w format PDF, gdy jest gotowy. |
flat | Kopia z zabezpieczeniem elektronicznym, po tym, jak wszyscy się podpiszą. |
tag_id, content_type, media_size | Jego nazwa, typ i rozmiar w bajtach |
Dopóki jakikolwiek plik jest jeszcze w trakcie przetwarzania, element encoding ten pokazuje informacje na jego temat. Formularz lub e-sign nie może zostać publikowany, dopóki jego dokument nie będzie gotowy.
Pobieranie pliku
Pobierz plik z https://privcdn.caseactive.com/, a następnie jego original, pdf lub flat. Twój klucz należy umieścić w tym samym nagłówku co każdy inny element pliku.
curl "https://privcdn.caseactive.com/hosts/ca-7e6d5c4b3a2f10/cases/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/media/docs/20261002154512_5f4e3d2c1b0a99/20261002154512_5f4e3d2c1b0a99.pdf" \
-H "Authorization: Bearer YOUR_API_KEY" -o repair-estimate.pdf
Weryfikacje klucza odbywają się w przypadku każdego połączenia, wliczając również jego zakres IP. Klucz może też pobierać dane z dowolnego miejsca, w którym znajduje się rola Wirtualnego Asystenta.
Usuwanie pliku
DELETE /<item>/media Otrzymuje strukturę JSON zawierającą informacje o pliku. media_id i media_group, i odpowiedzi 200. Na tym postie, twoje webhooky otrzymują wiadomość. delete_post_media. Dokument w formie pliku, znaku elektronicznego lub notatki nie może zostać usunięty. W takiej sytuacji należy usunąć sam element dokumentu.
Przykład: plik PDF w nowym poście
POST /postswraz zmessagewpisu. Wpis jest natychmiast publikowany, z powiadomieniem na portalu. E-mail otrzymujemy po około 30 sekundach, a wtedy liczy się wszystkie załączone pliki. Dlatego należy je załączyć w tym czasie.GET /posts/<post_id>/drive?media_group=docs&media_extension=pdf&tag_id=repair-estimate.- Utwórz plik w folderze
url, przy użyciu nazwyfields. PUT /posts/<post_id>/mediazfields.key.- Proszę przeczytać plik
GET /posts/<post_id>tak długo, aż wartość w poluexecution_statusbędzie równaSUCCEEDEDlubFAILED.
Jeśli połączenie zostanie odrzucone
| Status | message | Dlaczego |
|---|---|---|
| 400 | SchemaFieldsException | Brakuje jakiegoś parametru lub ten jest nieprawidłowy – na przykład nieprzyjęty typ danych, albo tag tag_id z wolnymi literami. Nazwa tego elementu znajduje się w tagu errors. W miejscu media.<n>.media_key plik nie został załadowany; albo plik należał do innego elementu. W miejscu /schema/media plik nie został załadowany jako schemas. To samo dotyczy sytuacji, gdy element, który chcesz załączyć, w ogóle nie istnieje. W żadnym przypadku nic nie jest załączone. |
| 403 | ItemUpdateFailedException | Plik jest już przyłączony, albo formularz, e-sign lub notatka zawierają już odpowiedni dokument. |
| 403 | ItemAuthorOnlyException | Klucz chciał załączyć plik do wiadomości lub komentarza napisanego przez kogoś innego. |
| 403 | CaseClosedException | Sprawa została zamknięta. |
| 404 | ItemNotFoundException | Przedmiot ten nie istnieje, gdy próbuje się uzyskać adres do jego załadowania, lub plik, który chce się usunąć, w ogóle nie istnieje. |
Sam proces wczytywania plików odbywa się w formacie używanym przez samo magazyn plików: EntityTooLarge oznacza, że plik przekroczył limit, a AccessDenied oznacza, że adres pliku przestał być aktywny. Jeśli chodzi o kody błędów dostarczane przez API, patrz Obsługa błędów i kodów statusowych API.