参考文档

成员

路径 /{member-id}

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

读取

返回表示 Workplace 用户的单个用户对象。可通过成员登录 Workplace 时所用的 Workplace 编号和邮箱访问。

  • /{member_id}
  • /{email_address}

权限

要读取成员的相关信息，需要拥有读取所有内容或管理帐户权限。

字段

字段名称说明类型

id

此用户的用户帐户编号。

string

first_name

用户的名字。

string

last_name

用户的姓氏。

string

email

用户的首选邮箱，也会用作该用户在 Workplace 中的帐号。

string

title

用户在 Workplace 中的职业。

string

department

如果是通过帐户管理 API 设置，则为用户在 Workplace 中的部门名称。

string

employee_number

分配给用户的数字标识符或字母数字标识符，通常根据雇佣顺序或用户与组织的关系而定。

string

primary_phone

用户登记的首选电话号码。对应帐户管理 API 中被标记为 primary 的 phoneNumbers 条目。

string

primary_address

用户登记的首选地址。对应帐户管理 API 中被标记为 primary 的 addresses 条目

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 更新或停用帐户。

连线

连线名称说明

/events

此用户的事件。在默认情况下，用户已拒绝或未回复的事件不包含在内。

/feed

用户发布的帖子（包括状态更新）和链接的动态。

/conversations

用户或智能助手公共主页的 Workplace 消息。需要拥有读取所有消息权限

/managers

用户登记的一位或多位管理者。

/reports

用户登记的报告。

/picture

成员的头像。

/groups

与成员相关的小组。

示例

检索与社群成员相关的信息


获取特定成员的名称和邮箱。

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


根据成员的邮箱获取其编号

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}


根据对话获取成员的对话编号：

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

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 化用为智能助手公共主页


获取成员受邀和认领其帐户的时间和日期：

需要拥有具备管理帐户权限的自定义集成口令：

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"
    }