`persistent_menu` 参考文档

您可以为智能助手设置固定菜单，帮助用户在对话中发现并更轻松地获取您的功能。

固定菜单始终对用户开放。这类菜单应包含用户可随时执行的多种高级操作。有了固定菜单，就能轻松地让新老用户了解智能助手的基本功能。如果用户在离开对话一段时间后返回，该菜单将自动显示在对话中。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 编辑栏。这表示，用户只能通过固定菜单、回传、按钮和网页视图与您的智能助手互动。默认值为 `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` 事件的形式发回给您 Webhooks 的数据。如果类型是 `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` 可禁用在网页视图中进行分享（适用于敏感信息）。

禁用固定菜单

有时您可能需要在聊天插件中禁用智能助手的固定菜单。如要执行此操作，您需在设置固定菜单时添加 "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 参考文档

要求

persistent_menu 格式