Centro de ayudaIntegraciones

Para: Administradores

Agregue publicaciones y comentarios con una clave central.

Como asistente virtual, puedes añadir publicaciones al feed de un caso, responder con comentarios y leerlos, editarlos o eliminarlos desde tu propio software.

En este artículo11 secciones

Antes de empezar

Esta página describe cómo agregar y leer los mensajes y comentarios de un caso, utilizando una clave de hub. Los caminos se encuentran debajo de https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Llamadas

LlamarLo que hace
GET /postsLista los mensajes relacionados con el caso, empezando por el más reciente.
POST /postsAñade un mensaje.
GET /posts/<post_id>Lee una publicación.
PUT /posts/<post_id>Cambia la publicación; la clave se ha agregado.
DELETE /posts/<post_id>Elimina cualquier publicación, junto con sus comentarios.
GET /posts/templatesLista los plantillas de feed que se pueden utilizar en este caso.
GET /posts/<post_id>/commentsLista los comentarios de una publicación, ordenados por orden de llegada.
POST /posts/<post_id>/commentsComentarios sobre una publicación
GET /posts/<post_id>/comments/<comment_id>Lee un comentario.
PUT /posts/<post_id>/comments/<comment_id>Cambia el comentario que escribió la llave.
DELETE /posts/<post_id>/comments/<comment_id>Borra cualquier comentario.

Todo lo que aparece en el feedAlimentar La cronología de las publicaciones sobre un caso, donde la firma comparte noticias y todos los involucrados en el caso pueden comentar. del caso, se encuentra bajo la categoría Asistente VirtualAsistente virtual Un miembro del equipo automatizado que publica mensajes de bienvenida, registros de asistencia y actualizaciones de la empresa; sus publicaciones llevan una insignia de Asistente Virtual., en nombre de su empresa, junto con el símbolo del Asistente Virtual. Para adjuntar archivos, consulte Subir y adjuntar archivos utilizando una clave de hub. Las páginas técnicas creadas por la IA están destinadas a las personas que utilizan el portal. Se rechaza la solicitud de un “key” con el código 403 BotNotAllowedException.

Agregar una publicación

CampoLo que haceRequeridoPor defecto
messageEl texto del mensaje puede tener hasta 20,000 caracteres. Se mantienen las pausas entre líneas.Sí.—
permissionsLos rolesPapel Un conjunto de permisos que determina qué puede ver y hacer una persona en un caso, como por ejemplo, el personal o los clientes. que pueden verlo, como por ejemplo ["role::staff"]. Deje de indicarlos para todos los participantes en el caso.No.Todos
templateUn plantilla de alimentación para cargar archivos desde: {"owner": "host", "template_id": "<asset_id>"}No.Ninguno.
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."}'

Responde a 201 con el ID del mensaje.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
  • Texto. Envíe texto sin formato. El portal lo mostrará. **bold**, [a link](https://example.com) Y las direcciones web se presentan en formato correcto. Los correos electrónicos muestran el texto tal como está escrito.
  • Menciones. Escribir <@user_id> Para mencionar a alguien en el caso, se deben utilizar las identificaciones de esa persona. GET /team, O un código de designación, como por ejemplo: <@clients.primary>, Y ese espacio se llena con la persona que corresponde a cada uno de ellos. El portal muestra a cada uno de ellos como… @ Y también su nombre. Se omite cualquier mención de alguien que no esté involucrado en el caso, o de un código que no coincida con ningún registro existente. Se rechaza cualquier mensaje que se envíe después de que se haya dejado de lado esa persona. 400 con… FieldRequiredException en/por message, Y nada se salva.
  • Quienes lo ven son… Con permissions, solo las personas que ocupan esos roles pueden verlo. También puede ser visto por cualquier persona cuya función sea la de moderar los mensajes, al igual que lo hace el personal de forma predeterminada.

A quién se le dice

Tan pronto como el mensaje sea agregado:

  • Sin ninguna mención, se informa a todos los involucrados en el caso, quienes puedan verlo. Con las menciones, solo se informa a las personas que realmente están involucradas en el asunto.
  • A cada uno se le envía un correo electrónico, o se le envía un mensaje de texto, si no tienen cuenta de correo electrónico confirmada. Además, reciben una notificación por parte del portal. Los miembros que están desactivados, así como aquellos que han desactivado las notificaciones de publicaciones, no reciben esta notificación.
  • Al responder al correo electrónico, se agrega la respuesta como un comentario, por parte de la persona que lo envió.
  • Sus webhooks reciben add_post.

Los archivos adjuntos se contabilizan en la correo electrónica.

Publicación desde una plantilla

GET /posts/templates Lista de los feeds que han sido publicados por usted. PlantillasPlantilla Un formulario, formulario, firma electrónica, nota o tarea reutilizable que se guarda en la biblioteca y se copia en los expedientes., Los más antiguos primero, y cada uno de ellos… asset_id, title y message. Códigos de designación en message Ya se han completado los datos relacionados con las personas involucradas en este caso.

Para publicar uno de ellos, envíelo por favor. message, Ya sea como está ahora o después de haberse cambiado. template Con su… asset_id Se trata de traer los archivos del plantilla. Una plantilla no lleva consigo sus roles: hay que enviarlos por separado. permissions A ti mismo.

Leyendo publicaciones

GET /posts toma como parámetros limit (por defecto: 20; hasta 1000), start_key, y también las páginas con nextLink y startKey, tal como ocurre en cualquier lista. Cada entrada contiene:

CampoLo que contiene
post_id, case_idSus identificadores
user_id¿Quién lo publicó? La identificación de la Asistente Virtual es cu-. Los 14 caracteres de tu ID son los siguientes:
messageSu texto, con las menciones indicadas como <@user_id>
permissionsLos roles que podrían surgir, cuando esté limitado.
media, media_ctSus archivos, por tipo, y cuántos son.
comments_ct, commenters, last_replySus comentarios: ¿cuántos los escribieron y cuándo fue el último de ellos?
systemtrue Para una publicación, se utiliza automatización o procesos de importación.
languageEl idioma en el que se escribió esto es…
created_on, updated_onCuando se publicó y se realizó la última modificación, en UTC.

La persona encargada lee cada publicación relacionada con el caso, incluyendo aquellas que son de carácter limitado.

Edición y eliminación

  • PUT /posts/<post_id> toma message y permissions, y solo modifica los elementos que usted envía. Un “key” puede cambiar únicamente aquellos contenidos que el Asistente Virtual crea por sí mismo, así como aquellos contenidos relacionados con bienvenidas, registros de llegada y otros eventos importantes que sus automatizaciones generan. Nadie recibe ninguna notificación al respecto; sus webhooks reciben modify_post cuando el texto cambia.
  • Para cambiar quién puede ver un mensaje, envíe la lista completa de los roles disponibles. Una lista vacía no será aceptada. Para mostrar los roles nuevamente a todos, envíe "permissions": null; una lista que incluya todos los roles, excluyendo aquellos que se hayan agregado posteriormente.
  • DELETE /posts/<post_id> elimina cualquier publicación relacionada con el caso, junto con sus comentarios y archivos correspondientes. Nadie es informado de esto; los webhooks reciben delete_post como respuesta.

Comentarios

POST /posts/<post_id>/comments toma message, siguiendo las mismas reglas que para una publicación. Luego, responde con 201, utilizando comment_id como respuesta. A todos aquellos que puedan ver la publicación, se les informa de ello; pero solo a las personas a quienes la publicación se refiere. GET enumera los elementos en orden ascendente, junto con comment_id, user_id, message, media y sus respectivos tiempos.

Un clave solo puede cambiar sus propios comentarios, utilizando PUT y un nuevo message. También puede eliminar cualquier comentario que desee.

Webhooks

Los webhooks reciben cada cambio que se produce en los mensajes y comentarios. Los valores clave involucrados son: add_post, modify_post, delete_post, add_post_media y delete_post_media. Para los comentarios, los mismos valores clave son utilizados. El valor who.user_id corresponde al autor del mensaje o comentario. Por lo tanto, los valores clave también contienen la identificación del Asistente Virtual. Si no se verifica esto, tu sistema considerará que los mensajes son nuevos. Consulte Eventos y contenido de los webhooks.

Idioma

Los mensajes y comentarios de las publicaciones no contienen ningún tipo de idioma; por lo tanto, se muestran en su forma original, sin ser traducidos. Las publicaciones creadas utilizando un plantilla que incluye algún idioma son una excepción: en ese caso, se indica el idioma utilizado en la publicación, y esta se traduce para que los lectores que usan otro idioma puedan leerla. Consulte Comprenda cómo se traducen las publicaciones y los comentarios.

Si se rechaza una llamada

EstadomessagePor qué
400SchemaFieldsExceptionSe ha perdido o el campo es inválido; por ejemplo, puede tratarse de un campo vacío. message, Un espacio vacío. permissions Un listado o una función que tu centro de control no tiene. errors Se le llama de alguna manera. Un cambio que no se refiere a ningún campo, también será rechazado de la misma manera.
400SchemaFieldsException, con ItemCopyNotAllowedException en templateEl plantilla no está publicada, no está disponible para las herramientas automáticas, o sus archivos aún están siendo procesados.
403ItemAuthorOnlyExceptionLa llave intentaba cambiar un mensaje o comentario escrito por otra persona.
403CaseClosedExceptionEl caso está cerrado.
403BotNotAllowedExceptionUn botón que hace referencia a uno de los llamados de redacción automática.
404ItemNotFoundExceptionEl mensaje o comentario no existe, o pertenece a otro caso.

Para información sobre el cuerpo de error y los demás códigos, vea Como manejar los errores de la API y los códigos de estado.

Artículos relacionados

Entienda lo que la API puede hacerDescubre qué funciones pueden alcanzar una clave de administración y una clave de concentrador, por qué cada clave actúa como asistente virtual y dónde encontrar la lista técnica completa.IntegracionesCarga y adjunta archivos con una clave de hub.Obtén una dirección de carga, sube un archivo, adjúntalo a una publicación, nota, tarea, formulario o firma electrónica, y descarga los archivos de un caso.IntegracionesConsulta los eventos y cargas útiles de los webhooks.Qué envía cada uno de los diez eventos de la fuente, cómo se cifra el mensaje y cómo descifrarlo con su clave secreta.IntegracionesGestionar errores de API y códigos de estadoLea el cuerpo del error, qué significan los códigos 400, 401, 403, 404, 500 y 503, y por qué un elemento que su clave no puede ver responde con el código 404.Integraciones