Membro

Caminho /{member-id}

Representa um objeto de usuário como membro de uma comunidade ou de um grupo do Workplace.

Caminho /community/members

Retorna uma lista de todas as contas de usuário atuais. Requer a permissão Gerenciar perfil profissional.

Filtro com base no external_id

Para filtrar usuários com base na identificação externa, use o parâmetro external_ids e transmita uma lista separada por vírgulas com as identificações externas dos usuários desejados.

Caminho /community/organization_members

Retorna a lista de usuários. Requer a permissão Ler os membros do grupo. Por padrão, as contas de usuário ativas serão exibidas. Para listar as contas de usuário desativadas, use o parâmetro de URL inactive=1.

Leitura

Retorna um objeto de usuário único que representa um usuário do Workplace. Isso pode ser acessado por meio da identificação do Workplace do membro ou do endereço de email usado pelo membro ao entrar no Workplace.

  • /{member_id}
  • /{email_address}

Permissões

Para ler informações sobre um membro, é preciso ter a permissão Ler perfil profissional ou Gerenciar contas. Se uma integração estiver usando a permissão Gerenciar contas e tiver grupos específicos como escopo, não será possível acessar alguns campos do membro.

Campos

Nome do campoDescriçãoTipo

id

Representa a identificação da conta de usuário da pessoa.

string

first_name

É o nome da pessoa.

string

last_name

É o sobrenome da pessoa.

string

email

É o endereço de email principal da pessoa, também usado como nome de usuário no Workplace.

string

title

É o cargo da pessoa no Workplace (se definido por meio da API de Gerenciamento de Contas).

string

organization

É a organização da pessoa no Workplace (se definida por meio da API de Gerenciamento de Contas).

string

division

É a divisão da pessoa no Workplace (se definida por meio da API de Gerenciamento de Contas).

string

department

É o nome do departamento da pessoa no Workplace (se definido por meio da API de Gerenciamento de Contas).

string

primary_phone

É o número de telefone principal da pessoa. Mapeia para a entrada phoneNumbers, que é marcada como primary na API de Gerenciamento de Contas.

string

primary_address

É o endereço principal da pessoa. Mapeia para a entrada addresses, que é marcada como primary na API de Gerenciamento de Contas.

string

picture

É a foto do perfil da pessoa.

url

link

É um link para o perfil da pessoa.

url

locale

É a localidade da pessoa.

string

name

É o nome completo da pessoa.

string

name_format

É o nome da pessoa formatado para lidar de maneira adequada com a ordenação em chinês, japonês ou coreano.

string

updated_time

É a hora atualizada.

datetime

account_invite_time

É a hora do convite da conta no formato UTC.

datetime

account_claim_time

É a hora da obtenção da conta no formato UTC.

datetime

account_deactivate_time

É a hora de desativação da conta no formato UTC.

datetime

external_id

É um identificador do membro definido pelo cliente. Cada membro PODE incluir um valor de external_id não vazio usando a API de Gerenciamento de Contas. O valor do atributo external_id nunca será especificado pelo Workplace.

string

start_date

Representa a data e a hora em que a pessoa entrou na empresa (se definido por meio da API de Gerenciamento de Contas).

datetime

about

É a biografia da pessoa.

string

cost_center

Identifica o nome de um centro de custo.

string

impersonate_token

É um token de acesso do membro que permite a uma integração fazer chamadas em nome de uma pessoa específica.

A permissão "Passar-se por" está obsoleta. Não crie novos recursos usando essa permissão. Ela só está disponível para integrações personalizadas que têm o recurso habilitado no momento.

string

claim_link

Fornece um link que pode ser usado pelo usuário para obter a conta do Workplace (disponível apenas para usuários não obtidos).

string

access_code

Fornece um código de acesso que pode ser usado pelo usuário para obter a conta do Workplace (disponível apenas para usuários não obtidos).

string

work_locale

É a localidade do usuário. Essa informação será usada pelo Workplace até que haja outra maneira de determinar a localidade do usuário (como configurações de idioma do navegador ou do dispositivo).

string. Os valores válidos são a concatenação do código ISO 639-1 de duas letras do idioma com um sublinhado e com o código ISO 3166-1 de duas letras do país. Por exemplo, en_US especifica o idioma inglês e o país EUA.

frontline

São informações sobre o status de linha de frente do usuário.

object. Veja o exemplo abaixo.

active

Indica se a conta do usuário está ativa.

boolean

Publicação

Consulte Account Management API (Graph).

Atualização

Consulte Account Management API (Graph).

Bordas

Nome da bordaDescrição

/events

Representa os eventos da pessoa. Por padrão, não inclui eventos que a pessoa recusou ou não respondeu.

/feed

Mostra o feed de publicações (incluindo atualizações de status) e os links publicados pela pessoa.

/conversations

Representa as mensagens do Workplace de uma pessoa ou de uma página de bot. Requer a permissão Ler todas as mensagens para ver as conversas de uma pessoa.

/managers

Indica o gerente ou os gerentes da pessoa.

/reports

Mostra os subordinados da pessoa.

/photos

São as fotos do perfil do membro.

/groups

São os grupos associados ao membro.

/phones

São os números de telefone associados ao membro.

/skills

São as competências do membro.

/badges

São os selos conquistados pelo usuário.

/logout

Indica a desconexão do usuário do Workplace. Somente POST.

/remove_profile_information

Remove as informações de perfil de um usuário desativado. Somente POST.

Exemplos

Como recuperar informações sobre um membro da comunidade


Obtenha o nome e o endereço de email de um determinado membro

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


Obtenha o ID de um membro usando o endereço de email dele

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


Liste os membros da empresa com base na identificação externa dos usuários

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


Liste os membros da empresa, incluindo contas desativadas

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


Obtenha os eventos de um membro

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

Como recuperar informações sobre o gerente e os subordinados do usuário


Obtenha os subordinados de um determinado membro

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


Obtenha o gerente de um determinado membro

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

Como recuperar mensagens de um membro


Obtenha conversas de um membro, incluindo informações como mensagens, remetentes e anexos

Isso requer um token de integração personalizado com a permissão Ler todas as mensagens:

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


Obtenha as identificações de conversas de um membro por conversas

Isso requer um token de integração personalizado com a permissão Ler todas as mensagens:

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


Obtenha mensagens associadas a uma determinada identificação de conversa de um usuário específico

Isso requer um token de integração personalizado com a permissão Ler todas as mensagens:

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


Obtenha conversas de uma página de bot, incluindo mensagens e anexos

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

O alias /me redireciona para a página do bot ao usar um token de integração personalizado.

Exclua uma mensagem específica na caixa de entrada de um membro usando um token de integração personalizado

Isso requer um token de integração personalizado com a permissão Excluir mensagens de bate-papo:

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

A exclusão só remove a mensagem da visualização do membro que foi especificado na solicitação. Para fazer a exclusão total, é preciso excluir a mensagem da visualização de cada membro.


Obtenha a data e a hora em que um membro foi convidado e obteve a conta

Isso requer um token de integração personalizado com a permissão Gerenciar contas:

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

Estes campos só estarão presentes se o membro tiver sido convidado ou obtido a conta.


Obtenha a data e a hora em que a conta de um membro foi desativada:

Isso requer um token de integração personalizado com a permissão Gerenciar contas:

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

Estes campos só estarão presentes se a conta do membro tiver sido desativada.


Desconecte um usuário do Workplace

Isso requer um token de acesso com a permissão Desconectar:

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


Defina uma foto do perfil

Isso requer um token de acesso com a permissão Gerenciar perfil profissional. Além disso, é compatível com a URL e com o carregamento de arquivo na solicitação.

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


Adicione o telefone de um membro

Isso requer um token de acesso com a permissão Gerenciar perfil profissional.

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


Obtenha as competências de um membro

Isso requer um token de acesso com a permissão Ler perfil profissional.

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


Adicione uma competência

Isso requer um token de acesso com a permissão Gerenciar perfil profissional.

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


Remova uma competência

Isso requer um token de acesso com a permissão Gerenciar perfil profissional.

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


Obtenha os selos de um membro

Isso requer um token de acesso com a permissão Ler perfil profissional.

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


Conceda um selo integrado a um usuário

Isso requer um token de acesso com a permissão Gerenciar selos. Consulte a documentação da comunidade para ver os selos disponíveis e as identificações correspondentes.

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


Conceda um selo personalizado a um usuário

Isso requer um token de acesso com a permissão Gerenciar selos. Consulte a documentação da comunidade para ver os selos disponíveis e as identificações correspondentes. O símbolo # precisa ser codificado em URL.

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


Desative um membro

Isso requer um token de acesso com a permissão Provisionar contas de usuários.

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


Exclua um membro

Isso requer um token de acesso com a permissão Provisionar contas de usuários.

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

Só é possível excluir membros não obtidos.

Obtenha o status de linha de frente do usuário

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