MessengerプロフィールAPI

ページのMessengerプロフィールで、次のMessengerプラットフォーム機能のさまざまな面を定義するプロパティを設定します。詳しくは、下のMessengerプロフィールのプロパティの表をご覧ください。

• [スタート]ボタン
• ようこそページ
• Ice Breakers
• 固定メニュー
• ドメインホワイトリスト
• アカウントのリンク
• コマンド
• 発見タブ(廃止)

MessengerプロフィールAPIを使用して、ページMessengerプロフィールのプロパティの設定、更新、取得、削除を行えます。

アクセス許可

このエンドポイントとやり取りするには、pages_messagingアクセス許可を持つページアクセストークンが必要です。

開発モードのアプリでは、Messengerプロフィール設定はそのアプリに対して権限を持つ人にしか表示されません。

リクエストURI

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

Messengerプロフィールのプロパティ

ページのMessengerプロフィールには、次のプロパティが含めることができます。各プロパティの型と用途については、以下の表の説明をご覧ください。

プロパティを取得する

1つ以上の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."
            }
         ]
      }
   ]
}

プロパティを設定する/更新する

1つ以上の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"
}

プロパティを削除する

1つ以上の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"
}