成员

路径 `/{member-id}`

表示一个已成为 Workplace 社群或小组成员的用户对象。

路径 `/community/members`

返回所有当前用户账户的列表。需要具备管理工作档案权限。

根据 `external_id` 进行筛选

如要根据外部编号筛选成员，请使用 external_ids 参数，并传递包含所需成员外部编号的逗号分隔清单。

路径 `/community/organization_members`

返回成员清单。需要具备读取小组成员权限。默认列出在线的用户账户。使用 inactive=1 网址参数则可显示停用的用户账户。

读取

返回表示一位 Workplace 用户的单个用户对象。可通过该成员的 Workplace 编号或该成员登录 Workplace 时所使用的邮箱进行访问。

/{member_id}
/{email_address}

权限

如要读取成员信息，需要具备读取工作档案或管理账户权限。如果集成使用管理账户权限，且集成范围设置为特定小组，该集成将无法访问某些成员字段。

字段

字段名称	描述	类型
`id`	成员的用户账户编号。	`string`
`first_name`	成员的名字。	`string`
`last_name`	成员的姓氏。	`string`
`email`	成员的首选邮箱，也可用作该成员的 Workplace 帐号。	`string`
`title`	成员在 Workplace 中的职位（如果已通过账户管理 API 进行设置）。	`string`
`organization`	成员在 Workplace 中所属的组织（如果已通过账户管理 API 进行设置）。	`string`
`division`	成员在 Workplace 中所属的分部（如果已通过账户管理 API 进行设置）。	`string`
`department`	成员在 Workplace 中所属部门的名称（如果已通过账户管理 API 进行设置）。	`string`
`primary_phone`	成员列出的首选手机号。与账户管理 API 上标记为 `primary` 的 `phoneNumbers` 条目相对应。	`string`
`primary_address`	成员列出的首选地址。与账户管理 API 上标记为 `primary` 的 `addresses` 条目相对应。	`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 进行设置。Workplace 绝不会指定 external_id 属性的值。	`string`
`start_date`	成员加入公司的日期和时间（如果已通过账户管理 API 进行设置）。	`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（图谱）

删除

请参阅账户管理 API（图谱）

更新

请参阅账户管理 API（图谱）

连线

连线名称	描述
`/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

通过成员的邮箱获取其编号

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}

按对话获取成员的对话编号：

需要具备读取所有消息权限的自定义集成口令：

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

获取特定成员的特定对话编号的消息：

需要具备读取所有消息权限的自定义集成口令：

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

设置头像

需要具备管理工作档案权限的访问口令。支持在请求中加入文件网址和上传文件。

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

向成员授予自定义徽章

需要具备管理徽章权限的访问口令。请参阅社群文档，了解有关列出可用徽章及其编号的信息。请注意，网址中的 # 必须经过网址编码。

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

读取

权限

字段

发布

删除

更新

连线

示例

检索社群成员的信息

获取特定成员的姓名和邮箱

通过成员的邮箱获取其编号

根据成员的外部编号列出公司成员

列出包括停用账户在内的公司成员

获取成员的活动：

检索成员主管和报告的相关信息

获取特定成员的报告

获取特定成员的主管

检索成员的消息

获取成员的对话，包括消息、发信人和附件：

按对话获取成员的对话编号：

获取特定成员的特定对话编号的消息：

获取智能助手页面的对话，包括消息和附件：

使用自定义集成口令删除成员收件箱中的特定消息：

获取成员获邀请并认领其账户的日期和时间：

获取成员账户的停用日期和时间：

使成员退出 Workplace

设置头像

添加成员的手机号码

获取成员的技能

添加技能

移除技能

获取成员的徽章

向成员授予内置徽章

向成员授予自定义徽章

停用成员

删除成员

获取成员的一线工作状态

路径 `/{member-id}`

路径 `/community/members`

根据 `external_id` 进行筛选

路径 `/community/organization_members`