`persistent_menu` 參考資料

您可以為 BOT（機械人程式）設定常駐選單，以助用戶探索並更輕易地在整個對話期間使用您的功能。

用戶可以隨時使用常駐選單。這個選單應包含最高級別的動作指令，讓用戶可隨時執行這些動作。設定常駐選單後，就能輕易地向全新與回流用戶說明 BOT 的基本功能。如果用戶在一段時間內未曾互動然後回流，選單就會自動顯示在對話串內。此設定屬於 Messenger 個人檔案 API 參考資料。

常駐選單亦可在用戶級別設定和變更。請參閱用戶級別選單了解詳情。

必要條件

如要使用常駐選單，您必須做好以下準備：

設定開始使用按鈕。
擁有與 BOT 相關專頁的「管理員」角色。

`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` 則為必要項目。

`menu_item` 物件

屬性	類型	說明
`type`	字串	選單項目類型。支援的值為： `web_url`：指定項目為網址按鈕。 `postback`：指定項目為回傳按鈕。
`title`	字串	在選單項目上展示的標題。上限為 30 個字元。
`url`	字串	用戶點按按鈕時開啟的網址。若類型是 `web_url` 則為必要項目。
`payload`	字串	這類資料會以 `messaging_postbacks` 事件形式傳回至 Webhook。若類型是 `postback` 則為必要項目。上限為 1,000 個字元。
`webview_height_ratio`	字串	*此為選用項目。*網頁檢視的高度。有效的值包括：`compact`、`tall`、`full`。
`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 分鐘 10 次 API 調用。此傳輸率限制將按專頁作為執行單位。

請注意，對用戶級別選單的呼叫上限為每位用戶每 10 分鐘 10 次 API 呼叫。此傳輸率限制將按專頁作為執行單位。

persistent_menu 參考資料