成員

路徑 `/{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`	成員存取權杖，可讓整合工具代表特定用戶發出呼叫。 Impersonate 為已廢棄的權限。請勿使用此權限建置新功能。此權限僅適用於目前已啟用此權限的自訂整合工具。	`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`	用戶或 Bot 頁面的 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}

取得 Bot 頁面的對話，包括訊息和附件：

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

使用自訂整合權杖時，/me 別名會指向 Bot 的頁面

使用自訂整合權杖來刪除成員收件匣中的特定訊息：

需要具有刪除聊天室訊息權限的自訂整合權杖

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

讀取

權限

欄位

發佈

刪除

更新

關係連線

範例

擷取社群成員的相關資訊

取得給定成員的姓名和電子郵件地址。

從成員的電子郵件地址取得成員的編號

根據用戶的外部編號列出公司成員

列出公司成員，包括已停用的帳號

取得成員的事件：

擷取用戶的主管和部屬相關資訊

取得給定成員的部屬

取得給定成員的主管

擷取成員的訊息

取得成員的對話，包括訊息、傳送者和附件：

依照對話串取得成員的對話串編號：

針對給定的用戶取得給定對話串編號的訊息：

取得 Bot 頁面的對話，包括訊息和附件：

使用自訂整合權杖來刪除成員收件匣中的特定訊息：

取得成員受邀及領取帳號的日期和時間：

取得成員帳號已停用的日期和時間：

將用戶登出 Workplace

設定大頭貼照

加入成員的電話

取得成員的技能

新增技能

移除技能

取得成員的徽章

授予內建徽章給用戶

授予自訂徽章給用戶

停用成員

刪除成員

取得用戶的第一線狀態

路徑 `/{member-id}`

路徑 `/community/members`

依照 `external_id` 篩選

路徑 `/community/organization_members`