Pour: Administrateurs
Ajouter des publications et des commentaires avec une clé de hub
Ajoutez des publications au flux d'un dossier, répondez par des commentaires et lisez, modifiez ou supprimez-les depuis votre propre logiciel, en tant qu'assistant virtuel.
Dans cet article11 sections
Avant de commencer
Cette page traite de la manière d’ajouter et de lire les messages et les commentaires d’un cas, en utilisant une clé de hub. Les chemins menant à ces informations se trouvent sous https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Appels
| Appel | Ce que cela fait |
|---|---|
GET /posts | Liste des messages concernant l’affaire, avec les messages les plus récents en premier. |
POST /posts | Ajoute une publication. |
GET /posts/<post_id> | Lise une publication. |
PUT /posts/<post_id> | Changement d’un poste où la clé est ajoutée. |
DELETE /posts/<post_id> | Supprime toute publication, y compris les commentaires associés. |
GET /posts/templates | Les listes des modèles de flux d’information de votre compte sont remplis pour ce cas particulier. |
GET /posts/<post_id>/comments | Affiche les commentaires d’une publication, en commençant par le plus récent. |
POST /posts/<post_id>/comments | Commentaires sur une publication |
GET /posts/<post_id>/comments/<comment_id> | Lise un commentaire. |
PUT /posts/<post_id>/comments/<comment_id> | Il modifie le commentaire écrit par la clé. |
DELETE /posts/<post_id>/comments/<comment_id> | Supprime tout commentaire. |
Tout ce qui est publié dans le feedAlimentation Chronologie des publications relatives à une affaire, où le cabinet partage des informations et où toutes les personnes impliquées dans l'affaire peuvent commenter. de la clé correspond à l’identité Assistante virtuelleAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel. de votre hub. Ces informations sont affichées sous le nom de votre entreprise, avec le badge de l’Assistante virtuelle. Pour ajouter des fichiers, veuillez consulter la section Enregistrer et soumettre des fichiers avec une clé hub. Les demandes liées à la rédaction technique sont destinées aux utilisateurs du portail : une clé est refusée en raison d’une erreur 403 BotNotAllowedException.
Ajouter un message
| Champ | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
message | Le texte de l’article peut atteindre jusqu’à 20 000 caractères. Les sauts de ligne sont conservés. | Oui. | — |
permissions | Les rôlesRôle Un ensemble d'autorisations qui détermine ce qu'une personne peut voir et faire sur un dossier, qu'il s'agisse de membres du personnel ou de clients. qui peuvent avoir accès à ce contenu, comme ["role::staff"]. Mettez cette option à côté pour tous ceux qui participent au cas en question. | Non. | Tout le monde |
template | Un modèle de flux de données permettant de transférer des fichiers depuis : {"owner": "host", "template_id": "<asset_id>"} | Non. | Aucun. |
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."}'
Cela répond à la question 201 en indiquant l’identifiant de l’article.
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
- Texte. Envoyez du texte simple. Le portail affiche les éléments
**bold**,[a link](https://example.com)ainsi que les adresses web sous une forme formatée ; les e-mails, quant à eux, affichent le texte tel qu’il a été écrit. - Mensurations. Écrivez
<@user_id>pour mentionner quelqu’un dans le cas en question, en utilisant les IDs fournis parGET /team, ou un code de désignation tel que<@clients.primary>. Ce dernier est rempli avec le nom correspondant à cette personne. Le portail affiche chaque personne sous la forme@, ainsi que son prénom. Les mentions de personnes qui ne font pas partie du cas, ou de codes qui ne correspondent à aucune personne, sont ignorées. Les messages sans aucun texte, une fois ignorés, sont rejetés. Un code 400 est utilisé pour les messages avecFieldRequiredExceptiondansmessage. Aucun message n’est enregistré. - Qui peut le voir ? Avec
permissions, Seuls les personnes occupant ces postes, ainsi que ceux qui modèrent les messages, peuvent le voir. C’est également le cas pour le personnel, car ils ont automatiquement cette fonction.
Qui est informé
Dès que le colis est ajouté :
- Sans aucune mention, tout le monde concerné par cette affaire est informé. Lorsqu’il y a des mentions, seules les personnes mentionnées sont informées.
- Chacun reçoit une notification par e-mail, ou par message texte, s’il n’a pas de compte e-mail confirmé. Les membres désactivés, ainsi que ceux qui ont désactivé les notifications par e-mail, ne reçoivent pas de notifications.
- En répondant à l’e-mail, il est possible d’ajouter la réponse en tant que commentaire, par la personne qui a répondu.
- Vos webhooks reçoivent
add_post.
Les fichiers joints par la suite sont comptés dans l’e-mail.
Publication à partir d'un modèle
GET /posts/templates liste les modèlesModèle Un flux RSS, un formulaire, une signature électronique, une note ou une tâche réutilisable, conservé dans la bibliothèque et copié dans les dossiers. de votre flux publié. Ces modèles sont classés par ordre de vieillissement, avec pour chaque modèle des informations concernant asset_id, title et message. Les codes de désignation indiqués dans message correspondent déjà aux personnes concernées dans ce cas.
Pour poster un fichier, envoyez message, tel qu’il est ou après avoir apporté les modifications nécessaires. Envoyez également template, accompagné de asset_id, afin d’inclure les fichiers du modèle dans l’envoi. Un modèle ne transfère pas automatiquement ses rôles : il vous suffit d’envoyer permissions vous-même.
Articles de lecture
GET /posts prend limit (valeur par défaut : 20, jusqu’à 1000), ainsi que start_key. Les pages contiennent également des éléments nextLink et startKey, comme c’est le cas pour chaque liste. Chaque poste contient :
| Champ | Ce qu'il contient |
|---|---|
post_id, case_id | leurs identifiants |
user_id | Qui l’a posté ? L’identifiant de l’assistante virtuelle est cu-. Votre identifiant complet se compose de 14 caractères. |
message | Son texte, avec les mentions <@user_id> |
permissions | Les rôles qui peuvent être joués, lorsque cela est limité… |
media, media_ct | Ses fichiers, par catégorie, et combien il y en a. |
comments_ct, commenters, last_reply | Ses commentaires : combien y en avait-il, qui les a écrits, et quand les derniers ont été postés. |
system | true Pour une publication, il s’agit d’une automatisation ou d’une action d’importation. |
language | Le langage dans lequel il a été écrit, lorsqu’il relate une information… |
created_on, updated_on | Lorsque cette information a été publiée et dernièrement modifiée, cela s’est produit dans le fuseau horaire UTC. |
La personne chargée de cette tâche lit tous les messages liés à l’affaire, y compris ceux qui sont peu importants.
Modification et suppression
PUT /posts/<post_id>prendmessageetpermissions, et ne modifie que les éléments que vous lui envoyez. Un “key” ne peut changer que les messages créés par l’assistant virtuel : ses propres messages, ainsi que les messages de bienvenue, d’information sur les étapes importantes, etc., créés par vos automatisations. Personne n’est informé de ces modifications ; vos webhooks reçoiventmodify_postlorsque le texte change.- Pour changer les personnes qui peuvent voir un poste, envoyez la liste complète des rôles associés. Une liste vide sera rejetée. Pour montrer le poste à tous à nouveau, envoyez
"permissions": null; une liste de tous les rôles, sans ceux ajoutés par la suite. DELETE /posts/<post_id>supprime toutes les publications concernant cette affaire, y compris les commentaires et les fichiers associés. Personne n’est informé de cela ; vos webhooks reçoivent simplementdelete_post.
Commentaires
POST /posts/<post_id>/comments prend message, en suivant les mêmes règles que pour une publication. Il renvoie ensuite 201 avec comment_id. Tout le monde qui peut voir cette publication est informé de cela, mais uniquement par les personnes mentionnées dans la publication. GET liste ces personnes par ordre croissant de récente, avec des informations concernant les comment_id, user_id, message, media, ainsi que leurs dates d’existence.
Une clé ne peut modifier que ses propres commentaires, en utilisant PUT et un nouveau message. Elle peut également supprimer tous les commentaires.
Webhooks
Vos webhooks reçoivent toutes les modifications apportées aux posts et aux commentaires. Les champs clés associés sont : add_post, modify_post, delete_post, add_post_media et delete_post_media. Pour les commentaires, il y a également ces cinq champs. Le champ who.user_id correspond à l’auteur du post ou du commentaire. Ces champs contiennent donc l’identifiant de l’assistant virtuel. Si vous ne vérifiez pas cela, votre système considérera ces posts comme nouveaux. Voir Événements webhook et contenu du payload.
Langue
Les messages et commentaires ne contiennent aucune langue spécifique ; ils sont donc affichés tels quels, sans être traduits. Les messages rédigés à l’aide d’un modèle qui inclut une langue donnée sont une exception : ils sont indiqués avec la langue utilisée dans le modèle, et sont donc traduits pour les lecteurs qui utilisent une autre langue. Voir Comment les messages et commentaires sont traduits.
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 400 | SchemaFieldsException | Un champ est manquant ou est invalide, par exemple, un champ vide. message, Un vide. permissions Une liste ou un rôle que votre hub ne possède pas. errors On l’appelle ainsi. Un changement qui ne concerne aucun champ est rejeté de la même manière. |
| 400 | SchemaFieldsException, avec ItemCopyNotAllowedException à template | Le modèle n’est pas publié, il n’est pas accessible aux bots, ou ses fichiers sont encore en cours de traitement. |
| 403 | ItemAuthorOnlyException | La clé voulait modifier un post ou un commentaire écrit par quelqu’un d’autre. |
| 403 | CaseClosedException | L’affaire est close. |
| 403 | BotNotAllowedException | Un clé correspond à l’un des appels de rédaction automatique. |
| 404 | ItemNotFoundException | Le post ou le commentaire en question n’existe pas, ou appartient à un autre cas. |
Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.