Centro assistenzaIntegrazioni

Per: Amministratori

Aggiungi post e commenti con un tasto hub

Aggiungi post al feed di un caso, rispondi con commenti e leggili, modificali o eliminali dal tuo software, in qualità di Assistente Virtuale.

In questo articolo11 sezioni

Prima di iniziare

Questa pagina spiega come aggiungere e leggere i messaggi e i commenti relativi a un caso, utilizzando una chiave di accesso specifica. I percorsi per raggiungere tali contenuti sono indicati sotto https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Chiamate

ChiamataCosa fa
GET /postsElenca i post relativi al caso, con il più recente in primo piano.
POST /postsAggiunge una posta.
GET /posts/<post_id>Leggo un post.
PUT /posts/<post_id>Cambia il post: la chiave è stata aggiunta.
DELETE /posts/<post_id>Elimina qualsiasi messaggio, insieme ai relativi commenti.
GET /posts/templatesElenca i template del feed, già compilati per questo caso specifico.
GET /posts/<post_id>/commentsElenca i commenti relativi a una posta; i commenti più recenti vengono visualizzati per primo.
POST /posts/<post_id>/commentsCommenti su una pubblicazione
GET /posts/<post_id>/comments/<comment_id>Leggi un commento.
PUT /posts/<post_id>/comments/<comment_id>Cambia il commento scritto dalla chiave.
DELETE /posts/<post_id>/comments/<comment_id>Elimina qualsiasi commento presente nel testo.

Tutto ciò che appare nelle “case” dei post chiave viene visualizzato lì. alimentazioneAlimentazione La cronologia dei post relativi a un caso, in cui lo studio legale condivide notizie e tutti coloro che sono coinvolti nel caso possono commentare. Come il centro di controllo del tuo hub. Assistente virtualAssistente virtuale Un membro automatizzato del team che pubblica messaggi di benvenuto, check-in e post di aggiornamento per l'azienda; i suoi post sono contrassegnati da un badge di Assistente Virtuale., Scrivete il nome della vostra azienda sotto l’icona del “Assistente Virtuale”. Per allegare file, vedete… Caricate e allegate i file utilizzando una chiave Hub.. I messaggi inviati dall’AI riguardanti le pagine tecniche sono destinati alle persone che utilizzano il portale. In tali casi, viene rifiutato l’accesso con lo status 403. BotNotAllowedException.

Aggiunta di un post

CampoCosa faNecessarioPredefinito
messageIl testo del post può arrivare fino a 20.000 caratteri. Le righe vengono mantenute separate.Sì.–
permissionsI “ruoliRuolo Un insieme di autorizzazioni che determina cosa una persona può vedere e fare su un caso, ad esempio il personale o i clienti.” che possono visualizzarlo, come ad esempio ["role::staff"]. È possibile ignorare questi elementi per tutti coloro che sono coinvolti nel caso in questione.No.Tutti
templateUn modello di feed per trasferire i file da: {"owner": "host", "template_id": "<asset_id>"}No.Nessuno
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."}'

Risponde a 201 con l’ID della pubblicazione.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
  • Testo. Invia il testo semplice. Il portale lo visualizzerà. **bold**, [a link](https://example.com) E gli indirizzi web vengono visualizzati in modo formato corretto; gli email, invece, mostrano il testo così com’è scritto.
  • Menzionate. Scrivere <@user_id> Per menzionare qualcuno in relazione a questo caso, si possono utilizzare gli ID forniti da… GET /team, O un codice di designazione, come ad esempio… <@clients.primary>, Il portale mostra ogni singola persona che rientra in quella categoria. @ E anche il loro nome. Si evita di menzionare qualcuno che non è coinvolto nel caso, oppure una combinazione di cifre che non corrisponde a nulla. È rifiutato anche qualsiasi messaggio lasciato senza alcuna informazione. 400 con… FieldRequiredException in message, E niente viene salvato.
  • Chi lo vede… Con permissions, solo le persone che ricoprono tali ruoli possono vederlo. Inoltre, anche chiunque abbia il ruolo di moderatore dei post può vederlo, proprio come fanno i membri del personale, per default.

A chi viene detto

Non appena la posta viene aggiunta…

  • Senza alcuna menzione, tutti coloro che sono coinvolti nel caso vengono informati. Con delle menzioni, invece, vengono informate soltanto le persone specificamente indicate.
  • A ciascuno viene inviata una email, oppure si può inviare un messaggio di testo, nel caso non disponessero di un indirizzo email verificato. Inoltre, i membri disattivati e coloro che hanno disattivato le notifiche non ricevono alcuna notifica.
  • Nel rispondere all’e-mail, è possibile aggiungere la risposta come commento, da parte della persona che ha risposto.
  • I vostri webhook ricevono add_post.

I file allegati successivamente vengono contati nel messaggio di email.

Pubblicazione tramite modello

GET /posts/templates Elenca il feed pubblicato da te. ModelliModello Un feed riutilizzabile, un modulo, una firma elettronica, una nota o un'attività conservati nella Biblioteca e copiati sui casi., Prima quelli più vecchi, e poi tutti gli altri. asset_id, title E… message. Codici di designazione in message I dati relativi alle persone coinvolte in questo caso sono già stati inseriti nei documenti necessari.

Per inviare un file, basta inviare il contenuto di message, così com’è o dopo essere stato modificato, e anche template insieme a asset_id, per inserire i file del template. Un template non porta automaticamente le sue “role”: bisogna inserire permissions manualmente.

Lettura dei post

GET /posts prende limit (valore predefinito: 20; massimo: 1000), start_key, e pagine con nextLink e startKey, proprio come avviene per ogni elenco. Ogni post contiene:

CampoCosa contiene
post_id, case_idI loro ID
user_idChi l’ha pubblicato? L’ID della Virtual Assistant è cu-. Inoltre, il ID del tuo hub è composto da 14 caratteri.
messageIl testo, con le indicazioni <@user_id>
permissionsI ruoli che possono essere assunti, quando la situazione è limitata…
media, media_ctI suoi file… per quanto riguarda la loro quantità…
comments_ct, commenters, last_replyI suoi commenti: quanti ne ha scritti, e quando è stato l’ultimo di essi?
systemtrue per un post: automazione o importazione aggiunta.
languageIl linguaggio in cui è stato scritto… quando viene registrato.
created_on, updated_onQuando il contenuto è stato pubblicato e l’ultima modifica è stata apportata, è avvenuto nell’Orto Universale Coordinato.

Il sistema di lettura dei dati analizza ogni post relativo a questa vicenda, compresi anche quelli meno importanti.

Modifica ed eliminazione

  • PUT /posts/<post_id> riceve message e permissions, e modifica soltanto quei contenuti che tu stesso invii. Un “key” può essere modificato soltanto nei post creati dall’Assistente Virtuale: ovvero, i post relativi alla benvenuta, al check-in e ai traguardi raggiunti da parte delle automazioni. Nessuno viene informato di ciò; i tuoi webhook ricevono modify_post quando il testo viene modificato.
  • Per cambiare le persone che possono visualizzare un post, inviate l’intera lista dei ruoli disponibili. Una lista vuota viene rifiutata. Per far apparire il messaggio a tutti di nuovo, inviate "permissions": null; in questo caso, la lista include tutti i ruoli disponibili, senza quelli aggiunti in seguito.
  • DELETE /posts/<post_id> elimina tutti i messaggi relativi a quel caso, insieme ai commenti e ai file associati. Nessuno viene informato di ciò; i tuoi webhook ricevono soltanto delete_post.

Commenti

POST /posts/<post_id>/comments prende message, Con le stesse regole di una posta, e le risposte… 201 con il… comment_id. A tutti coloro che possono vedere il post viene detto, in relazione al post stesso, o soltanto alle persone di cui si parla nel post. GET Le voci sono elencate in ordine decrescente, partendo da quelle più recenti. comment_id, user_id, message, media E i loro tempi…

Una chiave può modificare soltanto i propri commenti, utilizzando i tag PUT e message. Inoltre, è possibile eliminare qualsiasi commento presente sulla chiave stessa.

Webhooks

I webhook ricevono ogni modifica apportata ai post e ai commenti. Le chiavi utilizzate per identificare tali modifiche sono: add_post, modify_post, delete_post, add_post_media e delete_post_media. Per i commenti, le chiavi sono le stesse. L’elemento who.user_id rappresenta l’autore del post o del commento. Quindi, le chiavi contengono anche l’ID dell’assistente virtuale: se questo elemento non viene fornito, il sistema considererà i post come nuovi. Per ulteriori informazioni, vedere Webhook events and payloads.

Lingua

I post e i commenti non contengono alcuna lingua specifica; quindi vengono visualizzati in forma scritta, senza alcuna traduzione. L’eccezione sono i post creati utilizzando un template che include una lingua specifica: in questo caso, il contenuto viene indicato con la lingua utilizzata dal template stesso, e viene tradotto per i lettori che utilizzano altre lingue. Per ulteriori informazioni, vedere Come vengono tradotti i post e i commenti.

Se una chiamata viene rifiutata

StatomessagePerché
400SchemaFieldsExceptionUn campo è mancante o non valido; ad esempio, potrebbe trattarsi di un campo vuoto. message, Una cosa vuota. permissions Un elenco o una funzione che il tuo hub non possiede. errors Si tratta di un cambiamento che non riguarda alcun campo specifico. Quindi, anche il tentativo di effettuare tale modifica viene rifiutato.
400SchemaFieldsException, con ItemCopyNotAllowedException a templateIl modello non è pubblicato, non è accessibile ai robot, oppure i suoi file sono ancora in fase di elaborazione.
403ItemAuthorOnlyExceptionLa chiave cercava di modificare un post o un commento scritto da qualcun altro.
403CaseClosedExceptionIl caso è chiuso.
403BotNotAllowedExceptionUna chiave che apre uno dei pulsanti utilizzati per il disegno automatico.
404ItemNotFoundExceptionIl post o il commento in questione non esiste, oppure appartiene a un altro caso.

Per informazioni sul corpo dell’errore e sugli altri codici, si veda Comunicare gli errori dell’API e i codici di stato.

Articoli correlati

Comprendere cosa può fare l'APIScopri quali funzioni possono svolgere un tasto di gestione e un tasto hub, perché ogni tasto funge da Assistente Virtuale e dove trovare l'elenco tecnico completo.IntegrazioniCarica e allega file con una chiave hubOttieni un indirizzo di caricamento, carica un file, allegalo a un post, una nota, un'attività, un modulo o firma elettronicamente e scarica i file di un caso.IntegrazioniConsulta gli eventi e i payload dei webhook.Cosa invia ciascuno dei dieci eventi del feed, come viene crittografato il messaggio e come decrittografarlo con la tua chiave segreta.IntegrazioniGestire gli errori e i codici di stato delle APILeggi il corpo dell'errore, cosa significano i codici 400, 401, 403, 404, 500 e 503 e perché un elemento che la tua chiave non riesce a vedere risponde al codice 404.Integrazioni