Centro de ayudaIntegraciones

Para: Administradores

Agregue y actualice usuarios con una clave de administración.

Enumera a las personas de tu centro, agrega clientes, lee los detalles y casos de alguien, y desactiva o reactiva su acceso.

En este artículo7 secciones

Antes de empezar

Esta página contiene información sobre las llamadas que se realizan a las personas que forman parte de tu centro de operaciones. Los caminos están indicados en https://prd-api-manage.caseactive.com/v1/<hub id>. La función “Key” permite agregar personas como usuarios, pero solo cambia si pueden iniciar sesión. No es posible convertir a nadie en administrador o gerente, ni cambiar sus datos después de agregarlo.

Llamadas

LlamarLo que hace
GET /users/relationsLista de las personas que se encuentran en tu centro.
POST /users/relationsAñade a alguien.
GET /users/relations/<user_id>Lee a una sola persona.
PUT /users/relations/<user_id>Desactiva o vuelve a activar a alguien.
GET /users/relations/<user_id>/casesLista de los casos en los que una persona se encuentra.

Listado de personas

ParámetroLo que haceRequeridoPor defecto
type1 está destinado únicamente a personas activas. 0, por su parte, está destinado a personas con discapacidad. A pesar de su nombre, el filtro se basa en el estado de las personas, no en el tipo de usuario.No.Ambos
limit¿Cuántas personas pueden aparecer en una página, hasta 1000 personas.No.20
start_keyEl startKey de la página anteriorNo.Primera página

Cada persona viene con… user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type (admin, manage O user), host_user_status (1 Activo, 0 Discapacitados). host_ref_id, host_default_role, host_staff_designation, host_cases_ct (el número de casos que tienen) host_granted_status (approve, O reject una vez que han eliminado el acceso de tu centro de datos a su perfil… created_on. La lista no está ordenada en ningún modo específico. Incluye los nodos de su red. 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., de quién host_user_type Es bot, Y las dos personas que son muestras de ese nuevo grupo de personas con quienes comienza todo. Una de ellas es Staff Demo. host_user_type staff. Mientras haya más personas presentes, llame. nextLink, O envíelo. startKey como start_key.

Agregar a alguien

CampoLo que haceRequeridoPor defecto
usernameSu dirección de correo electrónico, o su número de teléfono, junto con el código del país correspondiente, por ejemplo: +12035556677. Un número sin código de país se interpreta como un número de los Estados Unidos.Sí.—
given_name, family_nameEl nombre y apellido deben mantenerse en formato de texto tipo. Aquellos que están escritos en minúsculas o en mayúsculas, se convierten en palabras mayúsculas, palabra por palabra: mary smith se guarda como Mary Smith.Sí.—
localeIdioma: ar, de, en, es, fr, id, it, ja, pl, pt, ru o zhNo.en
zoneinfoZona horaria, como America/New_YorkNo.US/Eastern
host_ref_idSe trata de una identificación propia para ellos, como un número de cliente. Puede consistir en letras, números, guiones y barras. Todas estas características deben escribirse en minúsculas. Ninguna dos personas pueden compartir el mismo identificador.No.Ninguno.
host_default_roleEl rol se asigna primero cuando se agregan a un caso, como en el caso de role::clients. Pero esto no otorga ningún beneficio.No.role::clients
host_staff_designationSus designaciones habituales para el personal son: primary, attorney, paralegal, case_manager, lead_attorney o lead_paralegal.No.primary
birthdateFecha de nacimiento, por ejemplo: 1985-04-12No.Ninguno.
genderMale o FemaleNo.Ninguno.
address1, address2, locality, region, postal_codeDirección, segunda línea, ciudad, estado y código postalNo.Ninguno.
countryCódigo de país de dos letras, como USNo.Ninguno.
company, titleEmpresa y cargoNo.Ninguno.
host_meta_dataSus campos personalizados se organizan de forma ordenada, con un objeto por página de los campos del usuario. Para leer las páginas, utilice GET /schemas?schema_type=users. Un campo marcado como Necesario puede quedar sin indicación: solo el campo “Editar Usuario” lo verifica.No.Ninguno.
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'

Responde a 201 con sus user_id.

{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
  • Todos los que se agregan como claves son usuarios, activos, sin importar lo que se envíe.
  • Un clave no puede otorgar a nadie los poderes relacionados con el portal: crear casos, agregar personas a los casos o eliminarlas. El envío de host_create_case, host_add_case_user o host_remove_case_user se rechaza, y nadie se añade al portal. Un administrador puede configurar esto en Editar usuario.
  • Si la dirección o número ya tiene una cuenta, ya sea con otra empresa o sin ninguna, esa persona se vincula a esa cuenta. De lo contrario, se crea una nueva cuenta. En ambos casos, nadie recibe correos electrónicos ni mensajes de texto. Ellos reciben notificaciones tuyas cuando los agregas a un caso, junto con la invitación para participar en ese caso. Para más información, vea Como agregar y eliminar miembros de un caso, utilizando la función de administración.

Leyendo a alguien

GET /users/relations/<user_id> Las respuestas abarcan todo lo que está en la lista, además de la fecha de nacimiento, el género, la dirección, la empresa y el cargo del usuario. También incluyen campos personalizados, opciones de notificación, y la fecha en que el usuario ingresó por última vez. GET /users/relations/<user_id>/cases Lista los casos en los que se encuentran, incluyendo aquellos que ya han sido resueltos. Para cada caso, se indica… case_id, title, case_ref_id (Y la identificación de tu centro de conexión, :: y el ID del tag). case_status, y sus case_role_id y case_designation Estoy trabajando en ello.

Incapacitar o rehabilitar a alguien

PUT /users/relations/<user_id> Toma un campo. host_user_status: 0 Para desactivarlos. 1 Es necesario volver a habilitarlos. Eso es suficiente para resolver el problema. 204.

curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"host_user_status": 0}'
  • A las personas con discapacidad se les niega el acceso a sus propios casos en tu centro de servicios. En cambio, su cuenta permanece activa para que puedan utilizarla en otras firmas. Consulta Desactivar o volver a activar un usuario.
  • Cuando cambia su estado, se le envía un correo electrónico o un mensaje de texto, si no tiene correo electrónico. En estos mensajes se indica que su acceso ha sido desactivado o restaurado. Enviar el estado actual no cambia nada, ni aporta ninguna información útil.
  • Un clave puede desactivar o reinstalar a los administradores y usuarios, pero no a los administradores en sí mismos.

Si se rechaza una llamada

EstadomessagePor qué
400SchemaFieldsExceptionFaltan o los campos son inválidos. Los nombres de los campos son errors. Por ejemplo, FieldUsernameTypeException se utiliza para un nombre de usuario que no es una dirección de correo electrónico o número de teléfono. FieldPhoneTypeException se utiliza para un número de teléfono que no es válido. FieldNameTypeException se utiliza para un nombre.
400FieldUsernameDupsExceptionAlguien que está activo en tu red ya tiene esa dirección de correo electrónico o número de teléfono. reason posee los datos de user_id.
400HostUserDisabledExceptionEsa persona está en tu hub, pero está deshabilitada. Por favor, habilítala de nuevo. reason mantiene su user_id activo.
400UserReferenceIdExistsExceptionAlguien más ya tiene ese host_ref_id.
400HostUserTypeNotAllowedExceptionIntentaste desactivar a un administrador, o simplemente inhabilitar la clave en sí.
403BotRelationFieldNotAllowedExceptionUsted envió energía cuando agregó a alguien, o cualquier otra cosa. host_user_status Cuando los cambiamos.
404ItemNotFoundExceptionNadie en tu área tiene ese user_id.

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.IntegracionesDeshabilitar o volver a habilitar un usuarioBloquea a alguien de tu plataforma sin eliminarlo, o vuelve a darle acceso. En ambos casos, se le notificará por correo electrónico o mensaje de texto.Sus clientes · 1 min