persistent_menu 參考資料

您可以為 Bot 設定常駐功能表,協助用戶在對話進行中探索及更輕鬆存取您的功能。

常駐功能表一律供用戶使用。這個功能表應該包含用戶在任何時候都可以執行的最上層動作。常駐功能表可向首次和回歸用戶輕鬆傳達您 Bot 的基本功能。如果用戶離開一段時間再返回,對話串會自動顯示這個功能表。此設定是 Messenger 個人檔案 API 參考資料的一部分

您也可以在用戶層級設定和變更常駐功能表。詳情請參閱用戶層級功能表

需求

若要使用常駐功能表,您必須完成下列操作:

persistent_menu 格式

常駐功能表範例

{
    "persistent_menu": [
        {
            "locale": "default",
            "composer_input_disabled": false,
            "call_to_actions": [
                {
                    "type": "postback",
                    "title": "Talk to an agent",
                    "payload": "CARE_HELP"
                },
                {
                    "type": "postback",
                    "title": "Outfit suggestions",
                    "payload": "CURATION"
                },
                {
                    "type": "web_url",
                    "title": "Shop now",
                    "url": "https://www.originalcoastclothing.com/",
                    "webview_height_ratio": "full"
                }
            ]
        }
    ]
}

屬性

屬性 類型 說明

locale

字串

針對不同地區設定所定義常駐功能表的物件陣列。如果功能表的 locale 屬性符合用戶的地區設定,就會顯示該功能表。


persistent_menu 陣列中必須至少有一個物件指定 "locale": "default"。如果所有物件的 locale 屬性都未符合用戶的地區設定,就會退而使用這個功能表。


請參閱支援的地區設定清單。

composer_input_disabled

布林值

如果設定為 true,會停用 Messenger 撰寫工具欄位。這表示只能透過常駐功能表、回傳、按鈕和網頁檢視來與您的 Bot 互動。


預設為 false

disabled_surfaces

陣列

停用常駐功能表的介面名稱陣列。目前僅支援 customer_chat_plugin

call_to_actions

陣列 <menu_item>

常駐功能表的頂層功能表項目陣列。允許最多 3 個項目。


如果 "composer_input_disabled": true,則為必填。

屬性 類型 說明

type

字串

功能表項目的類型。支援的值為:

title

字串

功能表項目要顯示的標題。30 個字元限制。

url

字串

點按按鈕時要開啟的網址。如果類型是 web_url,則為必填。

payload

字串

資料將會以 messaging_postbacks 事件的形式傳回到 Webhook。如果類型是 postback,則為必填。1,000 個字元限制。

webview_height_ratio

字串

選用。網頁檢視的高度。有效值包括 compacttallfull

messenger_extensions

布林值

選用。如果項目類型為 web_url,且網頁檢視會使用 Messenger 擴充套件 SDK,則必須是 true

fallback_url

字串

選用。對於不支援 Messenger 擴充套件 SDK 的用戶端,要在網頁檢視中開啟的網址。如果未定義這個屬性,將會退而使用 url。只有在 "messenger_extensions": true 的情況下,才可指定這個屬性。

webview_share_button

字串

選用。設定為 hide 可停用網頁檢視的分享功能(針對敏感資料)。

停用常駐功能表

在某些情況下,我們會建議您停用洽談外掛程式中 Bot(機器人程式)的常駐功能表。若要這麼做,請在設定常駐功能表時,新增 "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"]

Messenger 個人檔案 API 承載範例

{
  "persistent_menu":[
    {
      "locale":"default",
      "disabled_surfaces": ["CUSTOMER_CHAT_PLUGIN"],
      "composer_input_disabled": false,      
      "call_to_actions":[
        {
          "title":"My Account",
          "type":"postback",
          "payload":"PAYBILL_PAYLOAD"
        }
      ]
    }
  ]
}

速率限制

呼叫 Messenger 個人檔案 API 時,只限每隔 10 分鐘呼叫 API 10 次。每個粉絲專頁都必須遵守這項速率限制。

請注意,呼叫用戶層級功能表時,只限每隔 10 分鐘每個用戶呼叫 API 10 次。每個粉絲專頁都必須遵守這項速率限制。