Участник

Путь `/{member-id}`

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

Путь `/community/members`

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

Фильтрация по `external_id`

Чтобы отфильтровать пользователей по внешним идентификаторам, передайте в параметре external_ids разделенный запятыми список внешних идентификаторов нужных пользователей.

Путь `/community/organization_members`

Возвращает список пользователей. Требуется разрешение на чтение данных об участии в группах. По умолчанию возвращается список активных аккаунтов пользователей. Чтобы получить вместо них отключенные аккаунты пользователей, используйте в URL параметр inactive=1.

Чтение

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

/{member_id}
/{email_address}

Разрешения

Для чтения информации об участнике требуется разрешение на чтение рабочих профилей или управление аккаунтами. Если интеграция использует разрешение на управление аккаунтами и предназначена для работы с какими-то конкретными группами, она не сможет получить доступ к некоторым полям объекта Member.

Поля

Имя поля	Описание	Тип
`id`	ID аккаунта пользователя, принадлежащего этому человеку.	`string`
`first_name`	Имя человека.	`string`
`last_name`	Фамилия человека.	`string`
`email`	Основной электронный адрес человека, который также используется как его имя пользователя в Workplace.	`string`
`title`	Должность человека в Workplace, если она указана с помощью API Account Management.	`string`
`organization`	Организация человека в Workplace, если она указана с помощью API Account Management.	`string`
`division`	Подразделение человека в Workplace, если оно указано с помощью API Account Management.	`string`
`department`	Отдел человека в Workplace, если он указан с помощью API Account Management.	`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`
`updated_time`	Время обновления.	`datetime`
`account_invite_time`	Время приглашения в аккаунт, в формате UTC.	`datetime`
`account_claim_time`	Время утверждения аккаунта, в формате UTC.	`datetime`
`account_deactivate_time`	Время деактивации аккаунта в формате UTC.	`datetime`
`external_id`	Идентификатор участника, назначенный клиентом. Каждый участник МОЖЕТ иметь непустой идентификатор external_id, заданный с помощью API Account Management. Workplace никогда не назначает атрибут external_id.	`string`
`start_date`	Дата и время поступления человека на работу в компании, если они указаны с помощью API Account Management.	`datetime`
`about`	Биография человека.	`string`
`cost_center`	Название центра затрат.	`string`
`impersonate_token`	Маркер доступа участника, который позволяет интеграции совершать вызовы от имени определенного человека. Разрешение выдавать себя за другого пользователя устарело. Не используйте его ни в каких новых функциях. Это разрешение доступно только пользовательским интеграциям, для которых оно включено.	`string`
`claim_link`	Содержит ссылку, перейдя по которой, пользователь может утвердить свой аккаунт Workplace (только для неутвержденных пользователей).	`string`
`access_code`	Предоставляет код доступа, с помощью которого пользователь может утвердить свой аккаунт Workplace (только для неутвержденных пользователей).	`string`
`work_locale`	Локаль пользователя. Это локаль, которую Workplace будет использовать для этого пользователя в отсутствие другого способа определить локаль пользователя (например, через настройку языка браузера или устройства).	`string` Значение должно состоять из двухбуквенного кода языка по стандарту ISO 639-1, символа подчеркивания и двухбуквенного кода страны по стандарту ISO 3166-1. Например, en_US означает английский язык и США.
`frontline`	Информация о статусе неофисной работы пользователя.	`object` (см. пример ниже)
`active`	Признак активности аккаунта пользователя.	`boolean`

Публикация

См. документацию по API Account Management (Graph).

Удаление

См. API Account Management (Graph).

Обновление

См. документацию по API Account Management (Graph).

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

Имя границы	Описание
`/events`	События для этого человека. По умолчанию сюда не входят события, которые человек отклонил или на которые не ответил.
`/feed`	Лента публикаций (в том числе обновления статуса) и ссылок, опубликованных человеком.
`/conversations`	Сообщения человека или страницы бота в Workplace. Для просмотра переписок человека требуется разрешение на чтение всех сообщений.
`/managers`	Один или несколько руководителей человека.
`/reports`	Подчиненные человека.
`/photos`	Фото профиля участника.
`/groups`	Группы, связанные с участником.
`/phones`	Номера телефонов, связанные с участником.
`/skills`	Навыки участника.
`/badges`	Значки, которыми награжден пользователь.
`/logout`	Выход пользователя из Workplace. Только для запросов `POST`.
`/remove_profile_information`	Удаление информации профиля для отключенного пользователя. Только для запросов `POST`.

Примеры

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

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

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 /community/members?external_ids=12356,abc123 HTTP/1.1
Host: graph.facebook.com

Получение списка участников компании, в том числе отключенных аккаунтов

GET /community/organization_members?inactive=1 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 указывает на страницу бота.

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

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

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

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

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

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

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

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

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

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

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

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

Выход пользователя из Workplace

Требуется маркер доступа с разрешением на выход.

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

Добавление фото профиля

Требуется маркер доступа с разрешением на управление рабочими профилями. Запрос поддерживает как передачу URL файла, так и его загрузку.

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

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

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

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

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

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

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

Добавление навыка

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

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

Удаление навыка

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

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

Получение значков участника

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

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

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

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

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

Награждение человека пользовательским значком

Требуется маркер доступа с разрешением на управление значками. Список доступных значков и их ID см. в документации сообщества. Обратите внимание, что содержащийся в URL знак "#" должен быть в кодировке URL.

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

Отключение участника

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

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

Удаление участника

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

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

Удалить можно только неутвержденных участников.

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

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

Участник

Путь /{member-id}

Путь /community/members

Фильтрация по external_id

Путь /community/organization_members

Чтение

Разрешения

Поля

Публикация

Удаление

Обновление

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

Примеры

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

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

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

Получение списка участников компании по внешним идентификаторам пользователей

Получение списка участников компании, в том числе отключенных аккаунтов

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

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

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

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

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

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

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

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

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

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

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

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

Выход пользователя из Workplace

Добавление фото профиля

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

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

Добавление навыка

Удаление навыка

Получение значков участника

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

Награждение человека пользовательским значком

Отключение участника

Удаление участника

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

Путь `/{member-id}`

Путь `/community/members`

Фильтрация по `external_id`

Путь `/community/organization_members`