這份文件已更新。
中文(香港) 的翻譯尚未完成。

英文更新時間：2025年8月10日

Workplace from Meta 將逐步停用。您可在 2025 年 8 月 31 日前繼續使用 Workplace。請前往我們的幫助中心了解詳情。

成員

路徑 `/{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`	顧客指定的成員識別碼。每位成員都可以使用帳戶管理 API 來設定一個非空白 external_id 值組合。external_id 屬性的值永遠不會由 Workplace 指定。	`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（Graph）

刪除

請參閱帳戶管理 API（Graph）

更新

請參閱帳戶管理 API（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

根據成員的電郵地址取得其編號

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`