Centro de ayudaIntegraciones

Para: Administradores

Cree y actualice casos con una clave de administración.

Lista, crea, lee, actualiza y elimina los casos de tu plataforma desde tu propio software, incluyendo su etapa y campos personalizados.

En este artículo10 secciones

Antes de empezar

Esta página aborda los casos en los que una llave de gestión puede tener efectos determinados. Los caminos se encuentran bajo https://prd-api-manage.caseactive.com/v1/<hub id>.

Llamadas

LlamarLo que hace
GET /casesLista los casos de tu centro de operaciones, con los más recientes en primer lugar.
POST /casesSe crea un caso.
GET /cases/<case_id>Lee un caso en particular.
PUT /cases/<case_id>Cambia el caso de las letras.
DELETE /cases/<case_id>Se elimina un caso de una vez por todas.
GET /stagesLista las etapas de tu centro de operaciones, para poder encontrar sus identificadores.
GET /schemas?schema_type=casesLee los campos personalizados del caso de su dispositivo.

Listado de casos

ParámetroLo que haceRequeridoPor defecto
type1 se refiere a los casos abiertos, y 0 a los casos cerrados. A pesar de su nombre, el filtro se basa en el estado del caso, no en el tipo de caso.No.Ambos
limit¿Cuántos casos puede almacenar una página, hasta 1000 en total?No.20
start_keyEl startKey de la página anteriorNo.Primera página
curl "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "host_id": "ca-7e6d5c4b3a2f10",
        "ref_id": "rear-end-2026",
        "title": "Jane Sample auto accident",
        "case_type": "general",
        "case_status": 1,
        "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
        "users": {
          "cu-7e6d5c4b3a2f10": "role::bots",
          "cu-4f1c2a9e8b7d60": "role::clients",
          "cu-9d8c7b6a5f4e30": "role::staff"
        },
        "created_on": "2026-10-02T14:05:09+00:00"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1"
  }
}
  • users Asigna a cada persona en el caso a su correspondiente lugar. Papel/rolloPapel Un conjunto de permisos que determina qué puede ver y hacer una persona en un caso, como por ejemplo, el personal o los clientes.. Incluye el centro de control de tu dispositivo. 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., como role::bots.
  • Aunque todavía hay más casos que se deben resolver, la página también contiene los valores nextLink, que representan la dirección completa de la página siguiente, y startKey. Llamar a nextLink, o enviar startKey como start_key, hasta que se encuentre una página que no contenga estos valores.
  • Los casos que son eliminados no se incluyen en la lista. Para encontrar un caso según su ID de etiquetaID de etiqueta Una etiqueta permanente que se le asigna a una caja, como por ejemplo rear-end-2026, que también se muestra como ID de referencia y se utiliza en las importaciones., consulte Búsqueda de casos y usuarios con clave de administración.

Campos de casos

POST /cases y PUT /cases/<case_id> consideran estos campos como datos en formato JSON. Los campos que no se mencionan en la lista son ignorados.

CampoLo que haceRequeridoPor defecto
ref_idLa identificación de caso es un conjunto de letras, números, guiones y barras, todos escritos en minúsculas. Ningún par de casos en tu hub puede compartir la misma identificación. Se establece solo al momento de crear el caso; no se puede cambiar posteriormente.Sí, se crea.—
titleEl nombre del caso, que se muestra a todos.Sí, se crea.—
descriptionSe trata de una descripción para el personal. Los clientes no la ven. En caso de cambio, "" la elimina.No.Ninguno.
case_typegeneral, O uno de los nodos de su red. Tipos de casosTipo de caso Una categoría para casos, como por ejemplo "general", que se utiliza para dirigir las automatizaciones a los casos adecuados., Se escribe como sigue: Configuraciones › Campos. Se ha producido un cambio: el tipo de dato del caso también se acepta, una vez que lo hayas eliminado de tus configuraciones.No.general
case_status1 para estados abiertos, 0 para estados cerrados.No.1
case_stageEl ID de su etapaEscenario Una etapa por la que pasa un caso, como la recepción o el envío de la solicitud, que la firma nombra y describe y que se muestra en la página del caso. proviene de GET /stages. En caso de cambio, "" retira esa etapa de su lugar.No.Sin etapa
date_openedLa fecha en que se inició el proceso judicial, por ejemplo: 2026-03-15No.Hoy, en UTC.
hidden_modulesSecciones que se deben ocultar en este caso: cualquiera de case, convos, events, forms, signs, invoices, notes, tasks y team. Envíe [] para mostrarlas todas nuevamente.No.Ninguno es oculto.
meta_dataSus campos personalizados… véase más abajo.No.Ninguno.

No se puede agregar personas al proceso de creación de casos; solo la Asistente Virtual puede ser agregada a un nuevo caso. Para agregarlas, utilice POST /cases/permissions. Consulte Como agregar y eliminar miembros de los casos, utilizando la función de gestión.

Crear un caso

curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ref_id": "rear-end-2026", "title": "Jane Sample auto accident", "case_type": "general", "date_opened": "2026-10-02"}'

Responde a 201 con el ID del nuevo caso.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases"}}

Nadie recibe correos electrónicos. Las reglas de asignación de casos establecen que, para cada caso y para cada tipo de caso, se asigna al personal adecuado para manejarlo. Por lo tanto, cualquier intento de asignar a otra persona ese caso se rechaza, ya que se consideraría una duplicación. Un caso creado en una etapa determinada no recibe ningún tipo de notificación o aviso.

Leyendo un caso

GET /cases/<case_id> Resuelve el caso. case_id, host_id, ref_id, title, description, case_type, case_status, case_stage, date_opened, hidden_modules, meta_data, users_ct ¿Cuántas personas participan en esto, incluyendo al Asistente Virtual? created_on y updated_on. Para saber quién está involucrado en esto, utilice… GET /cases/permissions?case_id=<case_id>.

Cambiar un caso

PUT /cases/<case_id> puede tomar cualquiera de los campos de caso, pero no ref_id. Solo modifica aquellos campos que usted especifique. Responde a 204 sin ningún otro contenido.

  • Al mover un caso abierto a una etapa diferente, se añade el evento correspondiente a esa etapa. En caso de que tu centro de control tenga esa función, verás ese evento. Añada un mensaje automáticamente cuando un caso alcance una determinada etapa.. No se publica ni se envía nada más: cerrar un caso o cambiar su tipo de tratamiento no informa a nadie.
  • meta_data reemplaza a todos los campos personalizados que el caso tenga.
  • Un caso cerrado todavía puede ser modificado. Por lo tanto, se puede volver a abrir el caso con "case_status": 1.

Etapas y campos personalizados

GET /stages enumera las etapas de tu centro de control. Estas etapas son configuradas por un administrador dentro de Configuraciones › Etapas. Cada etapa cuenta con sus respectivos valores stage_id, name, description y order. Un clave puede leer los valores de las etapas, pero no puede cambiarlos.

GET /schemas?schema_type=cases utiliza los campos personalizados del hub, definidos en Configuraciones › Campos, como una lista de páginas. Cada página contiene las claves, etiquetas y tipos de los campos correspondientes. Enviar meta_data como una lista, con un objeto por página, en el mismo orden. Cada objeto contendrá los valores correspondientes a cada campo.

{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}

Un valor debe ser adecuado para el tipo de campo en cuestión; de lo contrario, la llamada se rechaza. Necesario solo se verifica mediante las formas de casos que se encuentran en el Panel de Administración y en el Lobby. Por lo tanto, los campos obligatorios pueden quedar vacíos si se crean o actualizan desde allí.

Eliminar un caso

DELETE /cases/<case_id> responde a 204. Este caso de eliminación de listas ocurre de inmediato, y la lista se elimina para siempre, junto con todos los mensajes, archivos, formularios, facturas, eventos, tareas y notas que contiene. No es posible deshacer esta acción, y nadie es informado al respecto. La identificación de la etiqueta utilizada para marcar la lista vuelve a ser gratuita una vez que la eliminación se ha completado.

Si se rechaza una llamada

EstadomessagePor qué
400SchemaFieldsExceptionSe ha perdido o el campo no es válido; errors lo identifica como tal. Un tipo de caso o etapa desconocida se encuentra en FieldValidatorFailedException de ese campo.
400CaseReferenceIdExistsExceptionOtro caso ya tiene esa identificación de tipo “Tag”. Incluso hay casos que aún están siendo eliminados. reason se encarga de manejar los datos relacionados con ese caso, mediante su identificador case_id.
404ItemNotFoundExceptionEse caso no existe. Puede que pertenezca a otro centro de datos, o que esté siendo eliminado.
403ManageBillingInactiveExceptionEl panel de administración de tu centro de datos está bloqueado después de un pago fallido.

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

Agregue y elimine miembros del caso con una clave de administración.Asigna un rol y una designación a cada persona en los casos, envía el correo electrónico de invitación, verifica quién está asignado a un caso o retira a alguien de él.IntegracionesBuscar casos y usuarios con una clave de administraciónEncuentre casos, personas, miembros de casos, roles e importe filas por texto, con filtros, desde su propio software.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