Справка

Участник

Путь /{member-id}

Представляет объект пользователя как участника сообщества или группы Workplace.

Чтение

Возвращает отдельный объект User, представляющий пользователя Workplace. Для доступа можно использовать Workplace ID пользователя или адрес электронной почты, используемый участником для входа в Workplace.

  • /{member_id}
  • /{email_address}

Разрешения

Для чтения информации об участнике требуется разрешение на чтение всего контента или управление аккаунтами.

Поля

Имя поляОписаниеТип

id

ID аккаунта пользователя, принадлежащего этому человеку.

string

first_name

Имя человека.

string

last_name

Фамилия человека.

string

email

Основной электронный адрес человека, который также используется как его имя пользователя в Workplace.

string

title

Должность человека в Workplace.

string

department

Отдел человека в Workplace, если он указан с помощью API Account Management.

string

employee_number

Цифровой или буквенно-цифровой идентификатор пользователя. Обычно назначается в соответствии с очередностью принятия на работу или связью с организацией.

string

primary_phone

Основной номер телефона человека. Соответствует записи phoneNumbers, помеченной как primary в API Account Management.

string

primary_address

Основной адрес человека. Соответствует записи addresses, помеченной как primary в API Account Management.

string

picture

Фото профиля человека.

url

link

Ссылка на профиль человека.

url

locale

Локаль человека.

string

name

Полное имя человека.

string

name_format

Имя человека, отформатированное для правильной обработки порядка слов на китайском, японском и корейском языках.

string

account_invite_time

Время приглашения в аккаунт, в формате UTC.

datetime

account_claim_time

Время утверждения аккаунта, в формате UTC.

datetime

impersonate_token

Маркер доступа участника, который позволяет интеграции выполнять вызовы от имени определенного человека. Требуется разрешение выдавать себя за другого человека.

Разрешение выдавать себя за другого человека устарело. Не реализуйте на его основе никаких новых функций. Это разрешение больше нельзя добавлять в пользовательские интеграции.

string

about

Контент поля биографии в профиле пользователя.

string

frontline

Информация о статусе неофисной работы пользователя.

object (см. пример ниже)

Публикация

Публикация через этот узел не поддерживается.

Удаление

Удаление через этот узел не поддерживается.

Обновление

Обновление через этот узел не поддерживается. Обновлять и деактивировать аккаунты можно через API Account Management.

Границы контекста

Имя границыОписание

/events

События для этого человека. По умолчанию сюда не входят события, которые человек отклонил или на которые не ответил.

/feed

Лента публикаций (в том числе обновления статуса) и ссылок, опубликованных человеком.

/conversations

Сообщения человека или страницы бота в Workplace. Требуется разрешение на чтение всех сообщений.

/managers

Один или несколько руководителей человека.

/reports

Подчиненные человека.

/picture

Фото профиля участника.

/groups

Группы, связанные с участником.

Примеры

Получение информации об участнике сообщества


Получение имени и электронного адреса участника

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


Получение ID участника по его электронному адресу

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


Получение событий участника

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

Получение информации о руководителе и подчиненных пользователя


Получение списка подчиненных участника

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


Получение руководителя участника

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

Получение сообщений участника


Получение переписок для участника, в том числе сообщений, имени отправителя и вложений

Требуется маркер пользовательской интеграции с разрешением на чтение всех сообщений.

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


Получение ID цепочек переписок для участника по цепочке

Требуется маркер пользовательской интеграции с разрешением на чтение всех сообщений.

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


Получение сообщений пользователя по ID цепочки

Требуется маркер пользовательской интеграции с разрешением на чтение всех сообщений.

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


Получение переписок для страницы бота, в том числе сообщений и вложений

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

При использовании маркера пользовательской интеграции псевдоним /me указывает на страницу бота.


Получение даты и времени приглашения пользователя в аккаунт и его утверждения

Требуется маркер пользовательской интеграции с разрешением на управление аккаунтами.

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

Эти поля присутствуют, только если пользователь был приглашен в аккаунт или утвердил его.

Удаление определенного сообщения в папке "Входящие" участника с использованием маркера пользовательской интеграции

Требуется маркер пользовательской интеграции с разрешением на удаление сообщений чата.

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

Сообщение удаляется только из представления участника, указанного в запросе. Чтобы сообщение удалилось полностью, необходимо удалить его представление у каждого пользователя.

Получение статуса неофисной работы пользователя

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