Dla: Administratorzy
Dodawaj posty i komentarze za pomocą klucza centralnego
Dodawaj posty do kanału sprawy, odpowiadaj komentarzami, a także czytaj, edytuj lub usuwaj je z poziomu własnego oprogramowania jako wirtualny asystent.
W tym artykule11 sekcji
Zanim zaczniesz
Ta strona pokazuje, jak dodawać i czytać komentarze oraz posty w danej sprawie, przy użyciu klucza „hub”. Drogi do tych elementów znajdują się pod https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Połączenia
| Dzwonić | Co to robi |
|---|---|
GET /posts | Wyświetla listę postów z danego przypadku, w kolejności od najnowszych do najstarszych. |
POST /posts | Dodaje wpis. |
GET /posts/<post_id> | Czytam jeden post. |
PUT /posts/<post_id> | Zmienia postać, w której dodano klucz. |
DELETE /posts/<post_id> | Usuwa wszystkie wpisy wraz z komentarzami na nich. |
GET /posts/templates | Lista twoich szablon feed, uzupełnionych w tym przypadku. |
GET /posts/<post_id>/comments | Wyświetla komentarze do posta, w kolejności od najnowszego do najstarszego. |
POST /posts/<post_id>/comments | Komentarze do posta |
GET /posts/<post_id>/comments/<comment_id> | Czytam jeden z komentarzy. |
PUT /posts/<post_id>/comments/<comment_id> | Zmienia komentarz, który napisał klucz. |
DELETE /posts/<post_id>/comments/<comment_id> | Usuwa wszelkie komentarze. |
Wszystko, co znajduje się w kopercie, jest informacją kluczową. karmićKarmić Oś czasu wpisów dotyczących sprawy, w której firma dzieli się nowościami, a wszyscy zaangażowani w sprawę mogą je komentować. Jak twój partner… 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., Podpisuj się pod nazwą twojej firmy, a także użyj oznaczenia „Virtual Assistant”. Aby załączyć pliki, zobacz… Należy załadować i przywiązać pliki, których klucz jest w formie „hub key”.. Procedury tworzenia tekstów za pomocą sztucznej inteligencji są przeznaczone dla użytkowników portalu. Otrzymuje się odmowę z powodu braku uprawnień: 403. BotNotAllowedException.
Dodawanie posta
| Pole | Co to robi | Wymagany | Domyślny |
|---|---|---|---|
message | Tekst wiadomości może wynosić do 20 000 znaków. Pomiędzy wierszami zachowano odpowiednie rozłamy tekstu. | Tak. | – |
permissions | roleRola Zestaw uprawnień decydujący o tym, co dana osoba może zobaczyć i zrobić w danej sprawie, np. pracownicy lub klienci., które mogą mieć dostęp do tego danych, np. ["role::staff"]. Wyklucz te role dla wszystkich osób zajmujących się tym przypadkiem. | Nie | Wszyscy |
template | Źródło plików do przywracania: {"owner": "host", "template_id": "<asset_id>"} | Nie | Żadnego. |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"message": "Hi <@cu-4f1c2a9e8b7d60>, the insurer has acknowledged your claim. We expect their estimate within two weeks."}'
Odpowiada na pytanie 201 przy użyciu identyfikatora wiadomości:
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
- Tekst. Wysyłaj tekst prosty. Portal wyświetla teksty w formie
**bold**,[a link](https://example.com)oraz bezpośrednie adresy internetowe w odpowiednich formatach. E-maile natomiast wyświetlają tekst takim, jakiego się używa w rzeczywistości. - Wzmianki. Warto napisać
<@user_id>, aby wspomnieć o jakiejś osobie w tym przypadku, korzystając z identyfikatorów zGET /team, lub kodu określającego nazwę osoby, np.<@clients.primary>. Ten kod jest wypełniany danymi dotyczącymi danej osoby. Portal wyświetla każdą taką informację jako@wraz z imieniem tej osoby. Informacje o osobach, które nie znajdują się w tym przypadku, lub kody, których dane nie pasują do żadnej osoby, są pominięte. Przesłanie żadnego komunikatu po tym, jak informacje zostaną pominięte, jest odrzucane. KodFieldRequiredExceptionprzymessagenie przynosi żadnych rezultatów, a nic się nie zapamiętuje. - Kto to widzi… Z
permissions, Tylko osoby pełniące te rólki widzą to, a także wszystkie osoby, których zadaniem jest moderowanie postów. To samo dotyczy pracowników, którzy te funkcje pełnią automatycznie.
Komu powiedziano
Jak tylko wiadomość zostanie dodana:
- Bez żadnych wzmianek – wszyscy, którzy mogą to zobaczyć, o tym wiedzą. Z wzmiankami natomiast wie tylko ci, których imię i nazwisko zostało wymienione.
- Każdy otrzymuje wiadomość e-mail, albo SMS, jeśli nie ma aktywowanego konta e-mailowego. Ponadto otrzymuje też powiadomienie na portalu. Członkowie, których funkcje są wyłączone, oraz osoby, które wyłączyły powiadomienia, nie otrzymują takich informacji.
- W odpowiedzi na e-mail, dodaje się komentarz od osoby, która go wysłała.
- Twoje webhooky otrzymują
add_post.
Pozostające później pliki są liczone razem z e-mailem.
Publikowanie z szablonu
GET /posts/templates wyświetla listę publikowanych „feedów” „szablonów”Szablon Wielokrotnego użytku wpis, formularz, podpis elektroniczny, notatka lub zadanie przechowywane w bibliotece i kopiowane do spraw.. Szablony są uporządkowane według wieku – najstarszy szablon znajduje się na początku listy. W elementach asset_id, title i message podawane są informacje o poszczególnych szablonach. Kody identyfikacyjne w elementach message są już zawarte w danych dotyczących osób, które korzystają z tych szablonów.
Aby przesłać ten plik, należy wysłać message – w stanie aktualnym lub po zmianie jego treści. Ponadto należy wysłać template wraz z asset_id, aby przygotować pliki potrzebne do tworzenia szablonu. Szablon nie przesyła swoich roli: należy samodzielnie wysłać permissions.
Czytanie postów
GET /posts przyjmuje wartość limit (domyślnie 20, do 1000). Ponadto przyjmuje również wartość start_key. Każdy wpis zawiera informacje o nextLink i startKey, tak jak to jest w przypadku każdego listy. Każdy wpis zawiera również inne dane.
| Pole | Co zawiera |
|---|---|
post_id, case_id | Jego identyfikatory |
user_id | Kto to opublikował? Identyfikator Działania Wirtualnego to cu-, a 14 znaków stanowi identyfikator twojego centrum zarządzania. |
message | Jego tekst, z wzmiankami pod nazwą <@user_id> |
permissions | Rola, jaką może pełnić to element, gdy jest ograniczony… |
media, media_ct | Jego pliki, w formie i w ilości |
comments_ct, commenters, last_reply | Jego komentarze: ilu osób je napisało i kiedy pojawiły się one po raz ostatni. |
system | true – dla posta, który został dodany w ramach automatyzacji lub importu. |
language | Język, w którym został napisany tekst, gdy zapisuje informacje o jednej osobie. |
created_on, updated_on | Gdy został opublikowany i ostatni raz zmieniony, w UTC. |
Klucz umożliwia przejrzenie wszystkich postów dotyczących tej sprawy, w tym także tych krótkich.
Edytowanie i usuwanie
PUT /posts/<post_id>przyjmujemessageipermissions, a zmienia tylko te elementy, które wyślesz. Klucz może zmienić tylko te wpisy, które zostały utworzone przez Wirtualnego Asystenta – te własne wpisy, a także wpisy związane z powitaniem, sprawdzaniem stanu i osiągnięciami, które dodają twoje automatyki. Nikt nie jest informowany o tym; twoje webhooky otrzymująmodify_postw momencie, gdy tekst się zmienia.- Aby zmienić osoby, które mogą widzieć daną publikację, należy wysłać pełną listę rol. Pusta lista jest odrzucana. Aby pokazać listę roli dla wszystkich znowu, należy wysłać
"permissions": null; lista zawierająca wszystkie role, bez tych dodanych później. DELETE /posts/<post_id>usuwa wszystkie wpisy dotyczące tej sprawy, wraz z komentarzami i plikami. Nikt o tym nie wie; twoje webhooky otrzymują informacje odelete_post.
Uwagi
POST /posts/<post_id>/comments przyjmuje message, zgodnie z tych samymi zasadami co w przypadku postów. W rezultacie otrzymuje się 201, a następnie comment_id. Każdy, kto może zobaczyć ten post, będzie miał dostęp do informacji o tym postach, albo tylko do tych, o których mowa w postach. GET przedstawia te informacje w kolejności od najnowszych do najstarszych, wraz z comment_id, user_id, message, media oraz czasami, w których zostały one publikowane.
Klucz może zmienić tylko własne komentarze, za pomocą PUT i nowego message. Może również usunąć jakikolwiek komentarz.
Webhooki
Twoje webhooky otrzymują informacje o każdej zmianie w postach i komentarzach. Klucze, którymi posiadamy dostęp do tych danych, to: add_post, modify_post, delete_post, add_post_media i delete_post_media. Dla komentarzy też używamy tych samych kluczy. who.user_id w każdym z tych eventów oznacza autora postu lub komentarza. Dlatego też klucze te przenoszą informacje o identyfikatorze asystenta wirtualnego – sprawdź to, inaczej twoje system będzie traktować te posty jako nowe. Zobacz Wydarzenia i dane przesyłane przez webhooky.
Język
W postach i komentarzach nie występuje żadny język, więc są one wyświetlane w oryginalnym języku, bez żadnego tłumaczenia. Wyjątkiem są posty napisane za pomocą szablonów, które obsługują określony język. Tacy posty są oznaczone odpowiednim językiem, a dla czytelników używających innego języka są one przetłumaczone. Zobacz Jak tłumaczone są posty i komentarze.
Jeśli połączenie zostanie odrzucone
| Status | message | Dlaczego |
|---|---|---|
| 400 | SchemaFieldsException | Brakuje lub nieprawidłowo wygenerowanego pola. Na przykład puste message, pusta lista permissions lub role, których w swoim hubie nie ma. Nazwy pola errors są generowane w taki sposób. Zmiany, które nie odnoszą się do żadnego pola, są odrzucane w ten sam sposób. |
| 400 | SchemaFieldsException, przy czym ItemCopyNotAllowedException znajduje się w obrębie template | Šablona nie została opublikowana, nie jest dostępna dla botów, lub jej pliki nadal są przetwarzane. |
| 403 | ItemAuthorOnlyException | Klucz chciał zmienić treść posta lub komentarza, który napisał ktoś inny. |
| 403 | CaseClosedException | Sprawa została zamknięta. |
| 403 | BotNotAllowedException | Klucz odpowiada jednemu z kroków tworzenia modeli za pomocą sztucznej inteligencji. |
| 404 | ItemNotFoundException | Takie wiadomość lub komentarz nie istnieje, albo należy do innego przypadku. |
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.