Central de ajudaIntegrações

Para: Administradores

Adicione publicações e comentários com uma chave central.

Como Assistente Virtual, você pode adicionar publicações ao feed de um caso, responder com comentários e ler, editar ou excluir essas publicações diretamente do seu software.

Neste artigo11 seções

Antes de começar

Esta página explica como adicionar e ler os posts e comentários de um caso, utilizando uma chave de hub. Os caminhos estão indicados em https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Chamadas

ChamarO que faz
GET /postsLista as postagens relacionadas ao caso, com as mais recentes em primeiro lugar.
POST /postsAdiciona uma publicação.
GET /posts/<post_id>Lê uma publicação.
PUT /posts/<post_id>Modifica uma publicação, adicionando a chave necessária.
DELETE /posts/<post_id>Apaga qualquer post, incluindo os comentários associados a ele.
GET /posts/templatesLista os modelos de feed do seu perfil, preenchidos para este caso.
GET /posts/<post_id>/commentsLista os comentários de uma publicação, com o mais recente em primeiro lugar.
POST /posts/<post_id>/commentsComentários sobre uma publicação
GET /posts/<post_id>/comments/<comment_id>Lê um comentário
PUT /posts/<post_id>/comments/<comment_id>Ele altera o comentário que a chave escreveu.
DELETE /posts/<post_id>/comments/<comment_id>Apaga qualquer comentário.

Tudo o que está escrito nas postagens importantes aparece no caso. alimentaçãoAlimentação Linha do tempo das publicações sobre um caso, onde o escritório compartilha notícias e todos os envolvidos no caso podem comentar. Como o seu hub… Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual., Submeta o texto sob o nome da sua empresa, juntamente com o símbolo do Assistente Virtual. Para anexar arquivos, consulte… Carregue e anexe arquivos que tenham uma chave de hub associada a eles.. As chamadas de AI para criação de documentos técnicos são destinadas às pessoas que utilizam o portal. Uma chave é rejeitada com o código 403. BotNotAllowedException.

Adicionando uma postagem

CampoO que fazObrigatórioPadrão
messageO texto do post pode ter até 20.000 caracteres. As quebras de linha são mantidas.Sim—
permissionsOs “rolesFunção Um conjunto de permissões que define o que alguém pode ver e fazer em um caso, como funcionários ou clientes.” que podem visualizá-lo, como por exemplo ["role::staff"]. Deixe-o sem ser exibido para todos os usuários envolvidos no caso.NãoTodos
templateUm modelo de alimentação para carregar arquivos de: {"owner": "host", "template_id": "<asset_id>"}NãoNenhum
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."}'

Ele responde a 201 com o ID da publicação.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
  • Texto. Envie texto simples. O portal exibe os endereços da forma correta: **bold**, [a link](https://example.com) e endereços da web em formato normal. Os e-mails, por sua vez, exibem o texto tal como foi escrito.
  • Mencionações. Escreva <@user_id> Para mencionar alguém no caso, utilizando os IDs fornecidos. GET /team, Ou um código de designação, como por exemplo: <@clients.primary>, E esse espaço é preenchido com a pessoa correspondente. O portal mostra cada uma delas. @ E o nome deles também. Qualquer menção a alguém que não está envolvido no caso, ou a um código que não corresponde a ninguém, é ignorada. Uma mensagem deixada sem palavras, após a pessoa ser descartada, é rejeitada. 400 com… FieldRequiredException em message, E nada é salvo.
  • Quem consegue enxergar isso? Com permissions, Apenas as pessoas que ocupam esses cargos conseguem ver isso, assim como qualquer pessoa cujo papel é moderação de postagens, como acontece por padrão com os membros do pessoal do fórum.

Quem é informado?

Assim que a mensagem for adicionada:

  • Sem menções, todos os envolvidos no caso que possam ver esse texto serão informados. Com menções, apenas as pessoas mencionadas serão informadas.
  • Cada um recebe uma mensagem por e-mail ou por mensagem de texto, caso não tenha um endereço de e-mail confirmado. Os membros desativados, assim como aqueles que desligaram as notificações de postagens, não recebem essas mensagens.
  • Ao responder ao e-mail, é adicionado o comentário da pessoa que respondeu.
  • Os seus webhooks recebem add_post.

Os arquivos anexados posteriormente são contados no e-mail.

Publicando a partir de um modelo

GET /posts/templates Lista o seu feed publicado. Modelos/FormuláriosModelo Um formulário, postagem, assinatura eletrônica, nota ou tarefa reutilizável, armazenado na Biblioteca e copiado para as pastas., Os mais antigos primeiro, sendo cada um deles… asset_id, title E… message. Códigos de designação em message Já foram preenchidos os dados relacionados às pessoas envolvidas neste caso.

Para publicar um modelo, envie o message, seja ele como está ou após qualquer alteração, e também o template, juntamente com o asset_id, para incluir os arquivos do modelo no sistema. Um modelo não carrega suas próprias funções: você precisa enviar o permissions por conta própria.

Lendo posts

GET /posts recebe como parâmetros limit (padrão: 20; até 1000), start_key, além de páginas com nextLink e startKey, como acontece em qualquer lista. Cada post contém:

CampoO que contém
post_id, case_idSeus IDs
user_idQuem postou isso? O ID da Assistente Virtual é cu-. Os 14 caracteres do seu ID de hub são…
messageO texto, com as menções indicadas como <@user_id>
permissionsOs papéis que podem ser desempenhados, quando ela está limitada…
media, media_ctSeus arquivos, em quantidade e como estão organizados.
comments_ct, commenters, last_replySeus comentários: quantos deles foram escritos, e quando foi a última vez que eles foram postados.
systemtrue para um post, uma automação ou uma importação realizada.
languageA linguagem em que foi escrito… Quando ele registra algo.
created_on, updated_onQuando o conteúdo foi publicado e última vez alterado, no fuso horário UTC.

O sistema lê todos os posts relacionados ao caso, incluindo aqueles que são considerados “limitados”.

Editar e excluir

  • PUT /posts/<post_id> recebe message e permissions, e altera apenas aqueles que você envia. Uma chave pode ser usada apenas para alterar os posts criados pelo Assistente Virtual: os próprios posts do Assistente Virtual, bem como os posts de boas-vindas, registros de check-in e outros eventos importantes criados pelas automações. Ninguém é informado sobre isso; seus webhooks recebem modify_post quando o texto muda.
  • Para mudar quem pode ver uma publicação, envie a lista completa dos papéis disponíveis. Uma lista vazia será rejeitada. Para mostrar a publicação para todos novamente, envie "permissions": null; uma lista com todos os papéis, excluindo aqueles adicionados posteriormente.
  • DELETE /posts/<post_id> exclui qualquer post relacionado ao caso, incluindo os comentários e arquivos associados. Ninguém é informado sobre isso; os seus webhooks recebem delete_post.

Comentários

POST /posts/<post_id>/comments Leva/Recebe message, Com as mesmas regras que para uma publicação, e com respostas também. 201 com o comment_id. Todos aqueles que puderem ver o post são informados sobre ele, ou seja, apenas as pessoas a quem o post se refere. GET As listas são organizadas de forma que os elementos mais recentes apareçam primeiro. comment_id, user_id, message, media E os seus tempos também.

Uma chave só pode alterar seus próprios comentários, utilizando PUT e um novo message. Além disso, ela pode excluir qualquer comentário que desejar.

Webhooks

Os webhooks recebem todas as mudanças nos posts e comentários. As chaves correspondentes são: add_post, modify_post, delete_post, add_post_media e delete_post_media. Para os comentários, as chaves são as mesmas. A chave who.user_id indica o autor do post ou comentário. Portanto, as chaves também contêm o ID do Assistente Virtual. Ver Eventos e payloads de webhook.

Linguagem

Os posts e comentários não contêm nenhuma linguagem especifica; por isso, são exibidos como texto sem tradução. A exceção são os posts criados com um modelo que inclui uma linguagem definida: esses posts são marcados com a linguagem utilizada no modelo, e são traduzidos para leitores que utilizam outra linguagem. Veja Como os posts e comentários são traduzidos.

Se uma chamada for recusada

StatusmessagePor que
400SchemaFieldsExceptionO campo está faltando ou é inválido. Ou seja, o campo está vazio. message, Um vazio. permissions Uma lista ou um papel que seu hub não possui. errors É chamado de “nome”. Uma mudança que não nomeia nenhum campo é rejeitada da mesma maneira.
400SchemaFieldsException, com ItemCopyNotAllowedException em templateO modelo não foi publicado, não está disponível para o papel dos bots, ou seus arquivos ainda estão sendo processados.
403ItemAuthorOnlyExceptionA chave tentou alterar uma publicação ou comentário escrito por outra pessoa.
403CaseClosedExceptionO caso foi encerrado.
403BotNotAllowedExceptionUm dos chamados de IA é o chamado de “esboço”.
404ItemNotFoundExceptionO post ou comentário não existe, ou pertence a outro caso.

Para informações sobre o corpo do erro e os demais códigos de erro, consulte Como lidar com erros da API e códigos de status.

Artigos relacionados

Entenda o que a API pode fazer.Saiba o que uma chave de gerenciamento e uma chave central podem fazer, por que cada chave funciona como um Assistente Virtual e onde encontrar a lista completa de especificações técnicas.IntegraçõesFaça upload e anexe arquivos com uma chave de hub.Obtenha um endereço de upload, carregue um arquivo, anexe-o a uma publicação, nota, tarefa, formulário ou assinatura eletrônica e baixe os arquivos de um caso.IntegraçõesPesquise eventos e payloads de webhook.O que cada um dos dez eventos de feed envia, como a mensagem é criptografada e como descriptografá-la com sua chave secreta.IntegraçõesLidar com erros e códigos de status da APILeia o corpo da mensagem de erro, o que significam os códigos 400, 401, 403, 404, 500 e 503 e por que um item que sua chave não consegue ver responde ao erro 404.Integrações