Messenger 开放平台

Messenger 个人主页 API

在公共主页的 Messenger 个人主页，您可以设置各种属性，用于定义以下 Messenger 开放平台功能的各个方面。详情请参阅下文的 Messenger 个人主页属性表格。

通过 Messenger 个人主页 API，您可以设置、更新、检索和删除公共主页 Messenger 个人主页中的属性。

权限

如要与此端点互动，需要使用具有 pages_messaging 权限的公共主页访问口令。

当应用处于开发模式时，Messenger 个人主页设置将仅对拥有该应用身份的用户显示。

目录

请求 URI

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

Messenger 个人主页属性

您公共主页的 Messenger 个人主页中可能包含以下属性。请参阅下方表格中的描述，了解各个属性的类型和用途。

属性 类型 描述

get_started

对象

当用户轻触您公共主页 Messenger 欢迎页面中的“开始”按钮时，系统会将相应负载作为 messaging_postbacks 事件发送出去。


详情请参阅“开始”按钮参考文档。

greeting

Array<Object>

由在您公共主页 Messenger 欢迎页面中显示的具体语言区域的欢迎语组成的数组。


详情请参阅欢迎语参考文档。

ice_breakers

Array<Object>

带有开场白对象的数组。


详情请参阅开场白参考文档。

persistent_menu

Array<Object>

由要放入固定菜单中的行动号召按钮组成的数组。


详情请参阅固定菜单参考文档。

whitelisted_domains

Array<String>

由白名单内的网域构成的列表。如果公共主页使用 Messenger 功能插件 SDK 和复选框插件，则必须提供此属性。


详情请参阅网域白名单参考文档。

account_linking_url

字符串

身份验证回调网址。必须使用 HTTPS 协议。


详情请参阅帐户绑定网址参考文档。

home_url

对象

当用户打开您的 Messenger 聊天插件时，此网址将显示在 Messenger 网页视图中。


对于 v7.0 及更高版本中的所有操作（GET、POST、DELETE），已停用此属性。

commands

Array<Object>

可选参数。如果提供此参数，就不能为空。


详情请参阅命令参考文档。

target_audience（已停用）

对象

此组条件决定在“发现”选项卡中向哪些受众显示您的 Messenger。


详情请参阅目标受众设置参考文档。

subject_to_new_eu_privacy_rules

布尔值

此布尔值标记确定公共主页是否受到面向欧洲的 Messenger API 更新的影响。此属性仅适用于 GET 请求。

检索属性

按名称检索一个或多个 Messenger 个人主页属性的当前值。

请求参数

请求的查询字符串中将包含以下参数：

参数描述

字段

以逗号分隔的要检索的 Messenger 个人主页属性列表。

请求示例

curl -X GET "https://graph.facebook.com/v19.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/v18.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/v19.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

响应示例

{
    "result": "success"
}

流量限制

对 Messenger 个人主页 API 的调用限制在每 10 分钟最多 10 次 API 调用。此流量限制以主页为单位执行。