Версия API Graph

Messenger Profile API

В профиле Messenger для Страницы можно задать свойства, от которых зависят различные аспекты перечисленных ниже функций платформы Messenger. Подробнее см. в таблице свойств профиля Messenger ниже.

Messenger Profile API позволяет настраивать, обновлять, извлекать и удалять свойства в профиле Messenger вашей Страницы.

Разрешения

Для взаимодействия с этой конечной точкой необходим маркер доступа к Странице с разрешением pages_messaging.

Если приложение находится в режиме разработки, настройки профиля Messenger будут видны только людям, у которых есть роль в этом приложении.

URI запроса

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

Свойства профиля Messenger

В профиле Messenger вашей Страницы могут содержаться следующие свойства. В таблице ниже описаны тип и назначение каждого свойства.

Свойство Тип Описание

get_started

Объект

Полезные данные, которые будут отправляться в виде события messaging_postbacks, когда кто-то нажимает кнопку "Начать" на экране приветствия Messenger на вашей Странице.


Подробнее см. в справке по кнопке "Начать".

greeting

Массив <Object>

Массив локализованных приветственных сообщений, которые будут отображаться на экране приветствия Messenger на Странице.


Подробнее см. в справке по приветствиям.

ice_breakers

Массив <Object>

Массив с объектами вводных фраз.


Подробнее см. в справке по вводным фразам.

persistent_menu

Массив <Object>

Массив кнопок призыва к действию, которые будут содержаться в постоянном меню.


Подробнее см. в справке по постоянному меню.

whitelisted_domains

Массив <String>

Список доменов, внесенных в белый список. Обязателен для Страниц, использующих SDK расширений Messenger и плагин с флажком.


Подробнее см. в справке по внесению доменов в белый список.

account_linking_url

Строка

URL обратного вызова аутентификации. Необходимо использовать протокол HTTPS.


Подробнее см. в справке по URL связывания аккаунтов.

home_url

Объект

URL, который будет открываться в веб-просмотре Messenger, когда кто-то откроет ваше плагин чата Messenger.


Начиная с версии 7.0 упразднено для всех операций (GET, POST, DELETE).

commands

Массив <Object>

Необязательный аргумент. Если он указан, то не может быть пустым.


Подробнее см. в справке по командам.

target_audience (больше не поддерживается)

Объект

Набор критериев, задающих аудиторию, которая будет видеть ваш Messenger во вкладке "Интересное".


Подробнее см. в справке по настройке целевой аудитории.

subject_to_new_eu_privacy_rules

Логическое значение

Логический флаг, определяющий, влияют ли на эту Страницу обновления Messenger API для стран Европы. Это свойство доступно только в запросе GET.

Извлечение свойств

Извлекает текущее значение одного или нескольких свойств профиля Messenger по имени.

Параметры запроса

Строка запроса содержит следующие параметры:

ПараметрОписание

fields

Разделенный запятыми список свойств профиля 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."
            }
         ]
      }
   ]
}

Настройка и обновление свойств

Задает значения одного или нескольких свойств профиля 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"
}

Удаление свойств

Удаляет одно или несколько свойств профиля 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"
}

Ограничение количества обращений

Количество обращений к API Messenger Profile ограничено десятью вызовами за каждые 10 минут (из расчета на Страницу).