Graph API 版本

Messenger 個人檔案 API

您可以在專頁的 Messenger 個人檔案中設定屬性,透過這些屬性來定義下列 Messenger 平台功能的各個方面。請參閱下表 Messenger 個人檔案屬性以了解詳情。

透過 Messenger 個人檔案 API,您可以設定、更新、檢索和刪除專頁 Messenger 個人檔案內的屬性。

權限

專頁存取憑證必須擁有 pages_messaging 權限,才可與此端點互動。

應用程式處於開發模式時,只有在應用程式上擁有角色的用戶可以看到 Messenger 個人檔案設定。

要求獲取 URI

https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>

Messenger 個人檔案屬性

您的專頁 Messenger 個人檔案可包含下列屬性。請見下表,了解各項屬性的類型與目的說明。

屬性 類型 說明

get_started

物件

在用戶點按專頁 Messenger 歡迎畫面的「開始使用」按鈕時,系統以 messaging_postbacks 事件形式傳送的裝載。


詳情請參閱「開始使用」按鈕參考資料

greeting

陣列<Object>

這是以本地語言展示的打招呼訊息陣列,會顯示在專頁 Messenger 歡迎畫面。


詳情請參閱打招呼文字參考資料

ice_breakers

陣列<Object>

帶有開場白物件的陣列。


詳情請參閱開場白參考資料

persistent_menu

陣列<Object>

要加入常駐選單的呼籲字句按鈕之陣列。


詳情請參閱常駐選單參考資料

whitelisted_domains

陣列<String>

列入允許清單的網域清單。如果專頁使用 Messenger 擴充功能 SDK選框附加程式,此為必要項目。


詳情請參閱網域允許清單參考資料

account_linking_url

字串

驗證回呼網址。必須使用 HTTPS 通訊協定。


詳情請參閱帳戶連結網址參考資料

home_url

物件

在用戶開啟 Messenger 洽談附加程式後,顯示在 Messenger 網頁檢視的網址。


已在 v7.0 版及以上版本的所有操作(GETPOSTDELETE)中停用。

commands

陣列<Object>

可選擇的引數。如有提供,則此值不能為空。


詳情請參閱指令參考資料

target_audience(已停用)

物件

決定探索分頁中 Messenger 會向誰人顯示的一組條件。


詳情請參閱目標廣告受眾設定參考資料

subject_to_new_eu_privacy_rules

布林值

定義專頁是否受歐洲地區 Messenger API 更新影響的布林值標示。此屬性僅適用於 GET 要求。

檢索屬性

按名稱檢索一個或多個 Messenger 個人檔案屬性的目前值。

要求參數

下列參數包含在要求的查詢字串內:

參數說明

欄位

要檢索的 Messenger 個人檔案屬性逗號分隔清單。

範例要求

curl -X GET "https://graph.facebook.com/v21.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

範例回應

data 陣列會傳回您要求獲取的屬性之目前值:

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

設定/更新屬性

設定一個或多個 Messenger 個人檔案屬性值。只有在要求內文內設定的屬性才會被覆寫。

範例要求

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

範例回應

{
    "result": "success"
}

刪除屬性

刪除一個或多個 Messenger 個人檔案屬性。只有 fields 陣列內指定的屬性才會被刪除。

範例要求

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

範例回應

{
    "result": "success"
}

傳輸率限制

向 Messenger 個人檔案 API 執行的調用次數上限為每 10 分鐘 10 次 API 調用。此傳輸率限制將按專頁作為執行單位。