Centro de ayudaIntegraciones

Para: Administradores

Lea y actualice los detalles del caso con una clave central.

Lee los detalles del caso y del equipo, y cambia los detalles que un administrador permite que cambie el rol del asistente virtual, como la etapa o un campo personalizado.

En este artĆ­culo8 secciones

Antes de empezar

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

Llamadas

LlamarLo que hace
GET /caseLee los detalles del caso.
PUT /caseCambia los detalles; la clave puede cambiar.
GET /whoamiIndica qué detalles son relevantes para que el código pueda leerse y cambiarse en este caso, así como qué secciones del código son visibles.
GET /teamLista a las personas relacionadas con el caso.
GET /placeholdersLee los valores que los códigos de sus plantillas rellenan en este caso.

Qué bien puede leer y cambiar lo que el hub lee, según el rol del hub en cuestión. 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., bots. Por defecto, lee los detalles estÔndar del caso. No se pueden cambiar ninguno de esos detalles hasta que un administrador lo permita.

Dejar que la clave cambie los detalles

En Configuraciones › Roles, edita el rol del bot. Bajo Caso, marque la opción Actualizar todos los campos de caso especificados en el rol. Los detalles relacionados con las claves pueden cambiar: TĆ­tulo, Descripción, Fecha de apertura, Estado, Escenario o campos personalizados. Para permitir que el bot lea campos personalizados, marque esa opción en Leer todos los campos de caso especificados en el rol. Consulte Cambiar las funciones que puede realizar un rol.

GET /whoami desempeña el papel clave en este caso. case_read_fields y case_write_fields indican los detalles que puede leer y modificar. case_write_fields se omite, ya que probablemente no cambie nada. Un campo personalizado se indica como meta_data.<field key>. También case_modules indica las secciones que se muestran en el caso: las secciones de tu centro de control, menos aquellas ocultas en este caso. Se rechaza cualquier llamada a una sección que no esté presente en el caso.

Leyendo un caso

curl https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "host_id": "ca-7e6d5c4b3a2f10",
    "ref_id": "rear-end-2026",
    "title": "Jane Sample auto accident",
    "description": "Rear-end collision on Route 9. Waiting on the insurer's estimate.",
    "case_type": "general",
    "case_status": 1,
    "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
    "date_opened": "2026-03-05",
    "meta_data": {
      "schema": [{"schema": {"type": "object", "properties": {"policy_number": {"type": "string", "title": "Policy number"}}}}],
      "content": [{"policy_number": "PN-5521"}]
    },
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case"
  }
}
  • Por defecto, la clave se lee de forma automĆ”tica. case_id, ref_id (the 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.), case_status, date_opened, title, description, case_type y case_stage. Se ha omitido un detalle importante en el caso.
  • case_stage es el ID de una 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.. GET /v1/<hub id>/stages enumera los nombres de dichas etapas.
  • meta_data.content contiene los valores de los campos personalizados. Un objeto por cada pĆ”gina de campo, segĆŗn la clave del campo. Pero solo se leen los campos que la clave puede leer. Por defecto, no se leen ningĆŗn valor; por lo tanto, la primera pĆ”gina queda vacĆ­a. En el ejemplo, un administrador ha permitido que se lea el nĆŗmero de la polĆ­tica. meta_data.schema describe los campos de cada pĆ”gina.
  • hidden_modules enumera las secciones que estĆ”n ocultas en este caso, si es que existen tales secciones.

Cambiar un caso

PUT /case toma cualquiera de estos campos como JSON, y solo modifica aquellos que usted envĆ­e.

CampoLo que haceRequeridoPor defecto
titleEl nombre del caso, que se muestra a todos.No.Sin cambios.
descriptionDescripción para el personal. Envíe "" para eliminarla.No.Sin cambios.
date_openedLa fecha en que se inició el proceso judicial, por ejemplo: 2026-03-15No.Sin cambios.
case_status0 Para cerrar el caso. Una llave de hub no puede volver a abrirlo.No.Sin cambios.
case_stageLa ID de la etapa es GET /v1/<hub id>/stages. EnvĆ­e "" para retirar el caso de esa etapa.No.Sin cambios.
meta_dataValores de campos personalizados: una lista con un objeto por pÔgina de campo, en orden. Cada objeto contiene los valores correspondientes al campo en cuestión. Solo se puede modificar la primera pÔgina, y solo los campos que usted mismo seleccione. Para eliminar un campo, utilice "" o null. Un campo obligatorio no puede ser eliminado.No.Sin cambios.
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_stage": "stage::20260927120000_8c1f0e2d3b4a59", "meta_data": [{"policy_number": "PN-5521"}]}'

Responde a 200 con el ID del caso en cuestión. Si algún campo que se envía no es uno de los campos clave, entonces el valor puede cambiar. En ese caso, toda la solicitud serÔ rechazada con el código 403, y nada cambiarÔ. reason identifica los campos; uno de ellos es personalizado, como meta_data.<field key>. Un campo que se envía con un valor que ya existe en el caso no representa un cambio, por lo que ni se rechaza ni se modifica ese campo. Una solicitud que no introduce ningún cambio responde a 204.

  • Al mover un caso abierto a una etapa diferente, se aƱade el evento correspondiente a esa etapa. Si tu centro de control tiene una función similar, entonces… 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 sus detalles no informa a nadie.
  • Una vez que un caso se cierra, se rechaza cualquier cambio que se realice mediante una clave de acceso. Incluso la reapertura del caso tambiĆ©n se niega. Para reabrirlo, utilice el panel de administración o una clave de gestión adecuada. Consulte Cerrar o reabrir un caso.
  • El ID del tag y el tipo de caso no pueden cambiarse aquĆ­. Solo una clave de administración puede modificar ese tipo.

El equipo

GET /team enumera a todos los miembros del caso, incluyendo al Asistente Virtual y a aquellos que son discapacitados. Un caso puede contener hasta 20 personas en total. El Asistente Virtual realizó el conteo.

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": 1,
        "host_user_status": 1,
        "given_name": "Jane",
        "family_name": "Sample",
        "locale": "en",
        "zoneinfo": "America/New_York"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/team"
  }
}
  • case_role_id representa el rol de la persona en este caso. case_designation, por su parte, corresponde a su designaciónDesignación Una denominación para el puesto que desempeƱa una persona en un caso, como Abogado Principal, Asistente Legal o Tutor., como por ejemplo primary.
  • host_user_status es igual a 0 para aquellas personas que estĆ”n discapacitadas en tu Ć”rea.
  • Los nombres de cada persona, el idioma que hablan…locale) Y la zona horaria.zoneinfo) Vuelve de forma predeterminada. Las direcciones de correo electrónico y los nĆŗmeros de telĆ©fono nunca funcionan asĆ­.
  • Una llave de hub no puede agregar ni eliminar personas. Esas llamadas son respondidas por los nĆŗmeros 403 HostAddCaseUserNotEnabledException y HostRemoveCaseUserNotEnabledException. Se debe utilizar una llave de gestión para realizar tales operaciones; vĆ©ase Agregar y eliminar miembros del caso con una llave de gestión.

Valores de plantilla

En GET /placeholders, debajo de placeholders, se indica el valor que cada código de los templates debe rellenar en este caso. Por ejemplo, clients.primary.full_name, clients.primary.email, case_ref_id y company.phone. Se omite el código correspondiente a aquellos casos en los que no hay nadie que ocupe ese puesto. Cuando la sección relacionada con los equipos estÔ desactivada o oculta en el caso, todos los códigos de equipo se omiten; pero el resto sigue apareciendo. Consulte Prellena los campos del formulario con los detalles del caso.

Si se rechaza una llamada

EstadomessagePor quƩ
400SchemaFieldsExceptionEl campo es invƔlido. Puede tratarse de un title vacƭo, de un campo personalizado que no se ha enviado, o de una etapa que no existe en el centro de control del usuario. errors indica el nombre del campo.
403CaseFieldNotWritableExceptionEl campo que envió no es uno de los campos clave. reason lo denomina así.
403CaseClosedExceptionEl caso estĆ” cerrado.
403HostModuleDisabledExceptionLos detalles del caso o el equipo involucrado estÔn ocultos en este caso. También se puede desactivar esa información para que no sea visible en tu centro de control.
403CaseModulePermissionDeniedExceptionEs posible que los bots no puedan leer los detalles del caso o de los miembros del equipo.
404CaseNotFoundExceptionEse caso no existe. Puede que pertenezca a otro centro de datos, o que estƩ siendo eliminado.

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.IntegracionesEncuentra casos con una clave centralEnumere los casos en su plataforma, abiertos o cerrados, búsquelos por ID de etiqueta o título, y encuentre el ID de un caso desde su propio software.IntegracionesCambiar lo que un rol puede hacerEdita los permisos de un rol, los campos del caso que puede leer o modificar, y sus límites de carga, incluidos los roles integrados.Seguridad y cuenta · 5 minGestionar 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