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 網頁檢視中。


7.0 以上版本中的所有作業(GETPOSTDELETE)都已停用。

commands

陣列<Object>

選用性引數。若提供此引數,則不得為空值。


如需詳細資訊,請參閱指令參考資料

target_audience(已停用)

物件

一組條件,可決定 Messenger 會顯示在哪些廣告受眾的探索頁籤中。


如需詳細資訊,請參閱目標廣告受眾設定參考資料

subject_to_new_eu_privacy_rules

布林值

布林值標示,可決定粉絲專頁是否受歐洲的 Messenger API 更新影響。此屬性僅適用於 GET 要求。

擷取屬性

依名稱擷取一或多個 Messenger 個人檔案屬性的目前值。

要求參數

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

參數說明

fields

要擷取的 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 分鐘呼叫 API 10 次。每個粉絲專頁都必須遵守這項速率限制。