我們即將停用 Workplace from Meta。在 2025 年 8 月 31 日之前,您將可繼續使用 Workplace。請參閱我們的使用說明以瞭解詳情。

社團

路徑 /{group-id}

代表 Workplace 社團。/{group-id} 節點將傳回單一社團。

跨公司社團

存取跨公司社團時應考慮以下特定注意事項:

  • 社團內容可以由安裝在跨公司社團所屬公司中的任何整合應用程式讀取
  • 跨公司社團與一般社團一起列在社群或社團中
    • 目的欄位可用於識別跨公司社團。此值可設為 WORK_MULTI_COMPANY
  • 也可查詢社團成員,但如果應用程式是來自與用戶不同的公司,將只看得到 idnamepicture
  • 管理社團權限的整合可新增及移除跨公司社團成員
    • 整合只能新增及移除為安裝整合的社群成員的用戶
    • 整合只能在其中一個社團管理員是安裝整合的社群成員時才能新增及移除用戶
  • 在以下任一情況下,與管理社團內容權限的整合可以刪除跨公司社團中包含的內容:
    • 內容屬於應用程式社群的成員或
    • 應用程式社群的成員是社團管理員
  • 目前無法發佈到跨公司社團
  • 可以在社團範圍設定中選擇跨公司社團進行整合
  • 不能在跨公司社團中提及 Bot(機器人程式)

讀取

您可以透過對 /{group-id} 發出圖形 API GET 要求,以讀取關於社團的資訊。

權限

要讀取社團節點,需要有讀取社團內容權限。

欄位

欄位名稱說明資料類型

id

社團編號。

string

cover

社團封面相片相關資訊。

CoverPhoto

cover_url

包含社團封面相片圖像的網址。

string

description

社團的簡要說明。

string

icon

社團圖示的網址。

url

is_workplace_default

指出社團是否為預設的 Workplace 社團(唯讀)。

boolean

is_community

指出社團是否也是社群且能包含其他社團(唯讀)。

boolean

name

社團名稱。

string

owner

建立此社團的成員

User

privacy

社團的隱私設定。可能值:

  • CLOSED
  • OPEN
  • SECRET

string

updated_time

社團上次更新的時間。更新包括社團屬性的任何變更,以及貼文和留言的變更。

datetime

archived

指出社團是否已封存。

boolean

post_requires_admin_approval

指出社團的貼文是否需要管理員批准。

boolean

purpose

指出社團目的

enum {WORK_ANNOUNCEMENT, WORK_FEEDBACK, WORK_TEAMWORK, WORK_SOCIAL, WORK_MULTI_COMPANY}


已停用:WORK_FOR_SALE, WORK_TEAM

post_permissions

指出貼文是否需要管理員批准。

enum {NONE, ADMIN_ONLY}

join_setting

指出新成員如何加入社團。

enum {NONE, ANYONE, ADMIN_ONLY}

sorting_setting

指出 /feed 關係連線傳回的貼文順序,預設為 CHRONOLOGICAL

enum {RECENT_ACTIVITY, CHRONOLOGICAL}

is_official_group

指出社團是否為官方 Workplace 社團。官方社團圖示會指出在產品的官方社團名稱旁。

boolean

發佈

您無法使用這個關係連線發佈內容。若要建立社團,請發佈至 /community/groups 關係連線。

刪除

您無法使用此節點刪除社團。移除社團最後一個成員將自動刪除該社團。

更新

您可以透過向 /{group-id} 發出圖形 API POST 要求並在要求內文中傳送要更新的欄位的值來更新社團。

權限

更新社團節點需要管理社團的權限。

關係連線

關係連線名稱說明

/admins

Workplace 社團的管理員。Workplace 支援新增及刪除管理員。請參閱以下範例。

/albums

Workplace 社團中的相簿。

/auto_membership_rules

自動新增成員至社團的規則。

/docs

Workplace 社團中的文件。

/events

Workplace 社團中的活動。

/feed

Workplace 社團中的貼文,依動態消息排列。

/files

分享到 Workplace 社團的檔案。

/member_requests

啟用成員加入審查的社團的待處理成員加入要求。

/members

Workplace 社團的成員。此關係連線曝光:

  • administrator:此用戶為社團管理員時顯示
  • joined:此用戶加入社團時顯示
  • moderator:此用戶為社團版主時顯示
  • added_by:顯示將此用戶加入社團的用戶

/moderators

Workplace 社團的版主。

/pinned_posts

已釘選至社團的貼文

/groups

列出任何子社團(僅適用於也是社群的社團)

範例

取得社團編號、名稱、封存狀態和隱私:

GET graph.facebook.com
  /{group-id}?fields=id,name,archived,privacy

封存社團:

POST graph.facebook.com
  /{group-id}?archive=true

取得具有名稱、編號和加入日期的社團成員:

GET graph.facebook.com
  /{group-id}/members?fields=name,id,joined

在一次呼叫中取得社團的管理員和版主:

GET graph.facebook.com
  /{group-id}?fields=admins,moderators

取得社團文件:

GET graph.facebook.com
  /{group-id}/docs

取得社團貼文:

GET graph.facebook.com
  /{group-id}/feed

依上次更新的順序取得社團貼文:

GET graph.facebook.com
  /{group-id}/feed?sorting_setting=RECENT_ACTIVITY

參數

sorting_setting

設定為 RECENT_ACTIVITY 時,允許依上次更新時間對貼文進行排序,而不是依建立時間。預設行為可以透過使用 CHRONOLOGICAL 作為值來明確設定。更新可能包括對貼文的編輯以及已新增的留言或心情。

取得社團貼文,包括影片、圖像、檔案或票選活動等其他附件:

GET graph.facebook.com
  /{group-id}/feed?fields=attachments

票選活動選項是根據每個選項的投票數以遞減排序。

取得社團成員清單以及他們的加入日期:

GET graph.facebook.com
  /{group-id}/members?fields=name,joined

透過編號將成員加入社團:

POST graph.facebook.com
  /{group-id}/members/{member-id}

透過電子郵件將成員加入社團:

POST graph.facebook.com
  /{group-id}/members?email=michael%40example.com

在要求的網址中包含電子郵件地址時,請確保電子郵件地址為編碼網址。範例:michael@example.com 變更為 michael%40example.com

移除社團最後一個成員將安排刪除該社團。

透過編號從社團中移除成員:

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

透過電子郵件從社團中移除成員:

DELETE graph.facebook.com
  /{group-id}/members?email=michael%40example.com

在要求的網址中包含電子郵件地址時,請確認電子郵件地址為編碼網址。範例:michael@example.com 變為 michael%40example.com

將成員升級為社團管理員:

POST graph.facebook.com
  /{group-id}/admins/{user-id}

將管理員降級為社團成員:

DELETE graph.facebook.com
  /{group-id}/admins/{user-id}

在社團中建立新活動:

POST graph.facebook.com
  /{group-id}/events
  ?name=New+Event
  &start_time=2017-03-02T14:00:04+00:00
  &end_time=2017-03-02T15:00:04+00:00
  &description=Test+Description
  &location=Boardroom

將新相片(透過二進制)上傳至社團:

POST graph.facebook.com
  /{group-id}/photos?source={image-data}

將新相片(透過網址)上傳至社團:

POST graph.facebook.com
  /{group-id}/photos?url={image-data}

建立帶有圖像和影片附件的社團貼文:

POST graph.facebook.com
  /{group-id}/feed?attached_media=[{"media_fbid":"{photo-id}"},{"media_fbid":"{photo-id}"}]

參數

attached_media

用於相片和影片,以括號括住的 media_fbids 陣列。支援下列圖像格式:.jpeg、.bmp、.png、.gif、.tiff。您可以到這裡找到更多有關圖像格式的資訊。您可以到這裡找到支援的影片檔案。若要取得圖像的 media_fbids,請先將未發佈的相片發佈到 https://graph.facebook.com/me/photos,如這份文件所述。若要取得影片的 media_fbids(包括動畫 GIF),請先將影片發佈到 https://graph.facebook.com/me/videos?no_story=true

如果將 no_story 參數設為 true,則在用戶透過您的應用程式上傳影片時,系統會停止自動在用戶個人檔案產生限時動態。

建立含檔案附件的社團貼文:

POST graph.facebook.com
  /{group-id}/feed?files=[{file-id},{file-id}]

參數

files

用於檔案,file_ids 的陣列(請注意,未以括號括住)。目前不支援檔案版本控制。若要更新檔案,請從貼文附件中移除原始檔案並重新上傳新的檔案附件。支援的檔案格式如下:

  • 文件:.pdf、.csv、.tsv、.docx、.pptx、.xlsx
  • 圖像:.jpeg、.png
  • 影片:.mp4
  • 封存:.rar、.zip

若要取得 file_ids,請先將檔案發佈到 https://graph.facebook.com/group_file_revisions。您可以從電腦本機發佈來源檔案。

您無法將 attached_mediafiles 參數合併到單一 API 呼叫。其模擬社團撰寫工具中的行為,提供用於上傳「相片/影片」和「檔案」的單獨選項。

更新貼文權限、加入設定、目的和貼文審查設定

POST graph.facebook.com
  /{group-id}/?post_permissions=NONE&join_setting=ADMIN_ONLY&purpose=WORK_SOCIAL&post_requires_admin_approval=false

取得對置頂貼文的心情和留言

GET graph.facebook.com
  /{group-id}/pinned_posts?fields=reactions,comments

識別社團是否也是社群

GET graph.facebook.com
  /{group-id}?fields=is_community

取得社團的成員規則

GET graph.facebook.com
  /{group-id}/auto_membership_rules

回應範例(JSON):

{
  "data": [
    {
      "conditions": [
        {
          "field": "TITLE",
          "operator": "CONTAINS",
          "values": [
            "sales"
          ]
        }
      ],
      "id": RULE_ID
    }
  ],
  ...
}

刪除社團的自動成員規則

DELETE graph.facebook.com
  /RULE_ID

將成員規則套用至社團

POST graph.facebook.com
  /{group-id}/auto_membership_rules

承載範例:

{
    "conditions": [
        {
            "field": "LOCATION",
            "operator": "CONTAINS",
            "values": ["London", "San Francisco"]
        }
    ]
  }

如果操作錯誤,此 API 有可能會將數千名用戶加入社團,因此請務必小心使用,並在執行 API 呼叫之前再次檢查。

取得社團編號和官方社團近況:

GET graph.facebook.com
  /{group-id}?fields=id,is_official_group

更新官方社團近況:

POST graph.facebook.com
  /{group-id?is_official_group={FALSE | TRUE}