Miembro

Ruta `/{member-id}`

Muestra un objeto de usuario como miembro de un grupo o de la comunidad de Workplace.

Ruta `/community/members`

Devuelve una lista de todas las cuentas de usuario actuales. Requiere un permiso Administrar perfil laboral.

Filtro basado en `external_id`.

Para filtrar usuarios según el identificador externo, utiliza el parámetro external_ids y pasa una lista separada por comas de los identificadores externos de los usuarios deseados.

Ruta `/community/organization_members`

Devuelve una lista de usuarios. Requiere un permiso Leer miembros de grupo. De manera predeterminada, se muestran en la lista las cuentas de usuario activas. Se pueden mostrar las cuentas de usuario desactivadas usando el parámetro de URL inactive=1.

Lectura

Devuelve un único objeto usuario que representa al usuario de Workplace. Puede accederse a través del identificador de Workplace del miembro o la dirección de correo electrónico que utilizó el miembro cuando inició sesión en Workplace.

/{member_id}
/{email_address}

Permisos

Leer la información de un miembro requiere el permiso Leer perfil laboral o el permiso Administrar cuentas. Si una integración usa el permiso Administrar cuentas y se especificó para un determinado grupo, no podrá acceder a ciertos campos de miembros.

Campos

Nombre del campo	Descripción	Tipo
`id`	El identificador de la cuenta de usuario de esta persona.	`string`
`first_name`	El primer nombre de la persona.	`string`
`last_name`	El apellido de la persona.	`string`
`email`	La dirección de correo electrónico principal de la persona, es decir, la que usa como nombre de usuario en Workplace.	`string`
`title`	El título de la persona en Workplace, si se estableció a través de la API de administración de cuentas.	`string`
`organization`	La organización de la persona en Workplace, si se estableció a través de la API de administración de cuentas.	`string`
`division`	La división de la persona en Workplace, si se estableció a través de la API de administración de cuentas.	`string`
`department`	El departamento de la persona en Workplace, si se estableció a través de la API de administración de cuentas.	`string`
`primary_phone`	El número de teléfono principal de la persona. Mapas de la entrada `phoneNumbers`, que está marcada como `primary` en la API de administración de cuentas.	`string`
`primary_address`	La dirección principal de la persona. Mapas de la entrada `addresses`, que está marcada como `primary` en la API de administración de cuentas.	`string`
`picture`	La foto del perfil de la persona.	`url`
`link`	Un enlace al perfil de la persona.	`url`
`locale`	El idioma de la persona.	`string`
`name`	El nombre completo de la persona.	`string`
`name_format`	El nombre de la persona con el formato correcto para que sea compatible con los pedidos en chino, japonés y coreano.	`string`
`updated_time`	Hora de actualización.	`datetime`
`account_invite_time`	Tiempo de invitación de la cuenta en formato UTC.	`datetime`
`account_claim_time`	Tiempo de reclamación de la cuenta en formato UTC.	`datetime`
`account_deactivate_time`	Hora de desactivación de la cuenta en formato UTC	`datetime`
`external_id`	Un identificador del miembro definido por el cliente. Todos los miembros PUEDEN incluir un conjunto de valores "external_id" no vacío usando la API de administración de cuentas. Workplace nunca especificará el valor del atributo "external_id".	`string`
`start_date`	La fecha y hora en que la persona se unió a la empresa, si se estableció a través de la API de administración de cuentas.	`datetime`
`about`	La presentación de la persona.	`string`
`cost_center`	Identifica el nombre de centro de costos.	`string`
`impersonate_token`	Un token de acceso para miembros, que permite realizar una integración para hacer llamadas en nombre de un persona determinada. El permiso de suplantación de identidad se encuentra obsoleto. No lo uses para crear nuevas funcionalidades. Este permiso solo está disponible para integraciones personalizadas que estén actualmente activadas.	`string`
`claim_link`	Proporciona un enlace que puede seguir un usuario para reclamar su cuenta de Workplace (solo disponible para usuarios no reclamados).	`string`
`access_code`	Proporciona un código de acceso que puede seguir un usuario para reclamar su cuenta de Workplace (solo disponible para usuarios no reclamados).	`string`
`work_locale`	El idioma del usuario. Este es el idioma que usará Workplace para este usuario, excepto que exista otra forma de determinar el idioma del usuario (como la configuración de idioma de un navegador o de un dispositivo).	`string` Los valores permitidos son la concatenación del código de idioma de dos letras ISO 639-1 más un guion bajo y el código de país de dos letras ISO 3166-1. Por ejemplo, en_US especifica el idioma inglés y el país Estados Unidos.
`frontline`	Información sobre el estado de primera línea del usuario.	`object` (ver ejemplo a continuación)
`active`	Si la cuenta del usuario está activa.	`boolean`

Publicación

Consulta API de administración de cuentas (Graph).

Eliminación

Consulta API de administración de cuentas (Graph).

Actualización

Consulta API de administración de cuentas (Graph).

Perímetros

Nombre del perímetro	Descripción
`/events`	Eventos para esta persona No se incluye de manera predeterminada los eventos que la persona rechazó o no contestó.
`/feed`	La lista de publicaciones (incluidas las actualizaciones de estado) y los enlaces publicados por esta persona.
`/conversations`	Los mensajes de Workplace de una persona o página de bot. Requiere el permiso Leer todos los mensajes para ver la conversación de una persona.
`/managers`	El administrador o los administradores que se muestran de una persona.
`/reports`	Los informes que se muestran de una persona.
`/photos`	La foto del perfil del miembro.
`/groups`	Los grupos asociados a un miembro.
`/phones`	Los números de teléfono asociados a un miembro.
`/skills`	Las habilidades de un miembro.
`/badges`	Las insignias que se le otorgó al usuario.
`/logout`	Obligar a un usuario a cerrar sesión. Solo `POST`.
`/remove_profile_information`	Elimina la información de perfil de un usuario desactivado. Solo `POST`.

Ejemplos

Recuperar información sobre un miembro de la comunidad

Obtener el nombre y la dirección de correo electrónico de un determinado miembro

GET /{member_id}?fields=email,name HTTP/1.1
Host: graph.facebook.com

Obtener el identificador de un miembro a partir de su dirección de correo electrónico

GET /{email_address} HTTP/1.1
Host: graph.facebook.com

Publicar miembros empresariales según el identificador externo de los usuarios

GET /community/members?external_ids=12356,abc123 HTTP/1.1
Host: graph.facebook.com

Publicar los miembros empresariales, incluidas las cuentas desactivadas

GET /community/organization_members?inactive=1 HTTP/1.1
Host: graph.facebook.com

Obtener los eventos de un miembro:

GET graph.facebook.com
      /{member-id}/events

Recuperar información del administrador y de los informes de un usuario

Obtener informes de un determinado miembro

GET /{member_id}/reports HTTP/1.1
Host: graph.facebook.com

Obtener el administrador de un determinado miembro

GET /{member_id}/managers HTTP/1.1
Host: graph.facebook.com

Recuperar mensajes para un miembro

Obtener conversaciones para un miembro, incluidos los mensajes, el emisor y los adjuntos:

Requiere un token de integración personalizada con el permiso Leer todos los mensajes:

GET graph.facebook.com
      /{member-id}/conversations?fields=messages{message,attachments,from}

Obtener identificadores de conversaciones para un miembro según la conversación:

Requiere un token de integración personalizada con el permiso Leer todos los mensajes:

GET graph.facebook.com
      /{member-id}/conversations

Obtener mensajes para un identificador de conversación determinado para un usuario en particular:

Requiere un token de integración personalizada con el permiso Leer todos los mensajes:

GET graph.facebook.com
      /{thread-id}/messages?user={user-id}

Obtener conversaciones para una página de bot, incluidos los mensajes y los adjuntos:

GET graph.facebook.com
      /me/conversations?fields=messages{message,attachments}

Los puntos de alias /me de la página del bot cuando se utiliza un token de integración personalizada.

Eliminar un mensaje específico en la bandeja de entrada de un miembro utilizando un token de integración personalizada:

Requiere un token de integración personalizada con el permiso Eliminar mensajes de chat:

DELETE graph.facebook.com
      /{message-id}?user={user-id}

Eliminar un mensaje solo borra el mensaje de la vista del miembro que se especificó en la solicitud. Para eliminar un mensaje completo, se debe eliminar la vista de ese mensaje que tiene cada uno de los miembros.

Obtener la fecha y hora del momento en que se invitó a un miembro y se reclamó su cuenta:

Requiere un token de integración personalizada con el permiso Administrar cuentas:

GET graph.facebook.com
      /{member-id}?fields=account_invite_time,account_claim_time

Estos campos solo están presentes si se invitó al miembro o se reclamó su cuenta.

Obtener la fecha y hora del momento en que se desactivó la cuenta de un miembro:

Requiere un token de integración personalizada con el permiso Administrar cuentas:

GET graph.facebook.com
      /{member-id}?fields=account_deactivate_time

Estos campos solo están presentes si se desactivó la cuenta del miembro.

Obligar a un usuario a cerrar sesión en Workplace

Requiere de un token de acceso con el permiso Cerrar sesión:

POST graph.facebook.com
      /{member-id}/logout

Establecer una foto del perfil

Requiere un token de acceso con el permiso Administrar perfiles laborales. Admite la URL de archivo y la subida de archivos dentro de la solicitud.

POST graph.facebook.com
      /{member-id}/profile_pictures?
      image_url={...}&
      caption={...}

POST graph.facebook.com
      /{member-id}/profile_pictures?
      caption={...}
Content-Type: multipart/form-data;
Content-Disposition: form-data; name="image_data"; filename="/profile_picture.png

Agregar el teléfono de un miembro

Requiere un token de acceso con el permiso Administrar perfiles laborales.

POST graph.facebook.com
      /{member-id}/phones?
      type={...}&
      primary={...}&
      number={...}

Obtener las habilidades de un miembro

Requiere token de acceso con el permiso Leer el perfil laboral.

GET graph.facebook.com
      /{member-id}/skills

Agregar una habilidad

Requiere un token de acceso con el permiso Administrar perfil laboral.

POST graph.facebook.com
      /{member-id}/skills?name={...}

Eliminar una habilidad

Requiere un token de acceso con el permiso Administrar perfil laboral.

DELETE graph.facebook.com
      /{member-id}/skills?name={...}

Obtener las insignias de un miembro

Requiere token de acceso con el permiso Leer el perfil laboral.

GET graph.facebook.com
      /{member-id}/badges?fields=id,name,description,icon,category

Otorgar una insignia integrada a un usuario

Requiere un token de acceso con el permiso Administrar insignias. Consulte la documentación de la comunidad para obtener información sobre las insignias disponibles y sus identificadores.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_champion

Otorgar una insignia personalizada a un usuario

Requiere un token de acceso con el permiso Administrar insignias. Consulta la documentación de la comunidad para obtener información sobre las insignias disponibles y sus identificadores. Ten en cuenta que # en la URL debe tener codificación URL.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_custom#{badge_id}

Desactivar un miembro

Requiere token de acceso con el permiso Otorgar de cuentas de usuario.

POST graph.facebook.com
      /{member-id}?active=false

Eliminar un miembro

Requiere token de acceso con el permiso Otorgar de cuentas de usuario.

DELETE graph.facebook.com
      /{member-id}

Solo los miembros no reclamados pueden ser eliminados.

Obtener el estado de primera línea de un usuario

GET graph.facebook.com
      /{user-id}?fields=frontline
      
    {
      "frontline": {
        "is_frontline": true
      },
    "id": "100038142594104"
    }

Miembro

Ruta /{member-id}

Ruta /community/members

Filtro basado en external_id.

Ruta /community/organization_members

Lectura

Permisos

Campos

Publicación

Eliminación

Actualización

Perímetros

Ejemplos

Recuperar información sobre un miembro de la comunidad

Obtener el nombre y la dirección de correo electrónico de un determinado miembro

Obtener el identificador de un miembro a partir de su dirección de correo electrónico

Publicar miembros empresariales según el identificador externo de los usuarios

Publicar los miembros empresariales, incluidas las cuentas desactivadas

Obtener los eventos de un miembro:

Recuperar información del administrador y de los informes de un usuario

Obtener informes de un determinado miembro

Obtener el administrador de un determinado miembro

Recuperar mensajes para un miembro

Obtener conversaciones para un miembro, incluidos los mensajes, el emisor y los adjuntos:

Obtener identificadores de conversaciones para un miembro según la conversación:

Obtener mensajes para un identificador de conversación determinado para un usuario en particular:

Obtener conversaciones para una página de bot, incluidos los mensajes y los adjuntos:

Eliminar un mensaje específico en la bandeja de entrada de un miembro utilizando un token de integración personalizada:

Obtener la fecha y hora del momento en que se invitó a un miembro y se reclamó su cuenta:

Obtener la fecha y hora del momento en que se desactivó la cuenta de un miembro:

Obligar a un usuario a cerrar sesión en Workplace

Establecer una foto del perfil

Agregar el teléfono de un miembro

Obtener las habilidades de un miembro

Agregar una habilidad

Eliminar una habilidad

Obtener las insignias de un miembro

Otorgar una insignia integrada a un usuario

Otorgar una insignia personalizada a un usuario

Desactivar un miembro

Eliminar un miembro

Obtener el estado de primera línea de un usuario

Ruta `/{member-id}`

Ruta `/community/members`

Filtro basado en `external_id`.

Ruta `/community/organization_members`