Справка по общему шаблону

Общий шаблон позволяет отправлять структурированные сообщения с изображением, текстом и кнопками. Общий шаблон с несколькими шаблонами, описанными в массиве elements, служит для отправки кольцевой галереи с горизонтальной прокруткой, причем каждый элемент содержит изображение, текст и кнопки. Полную информацию о реализации см. в этом разделе.

URI запроса

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

Пример запроса

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment":{
      "type":"template",
      "payload":{
        "template_type":"generic",
        "elements":[
           {
            "title":"Welcome!",
            "image_url":"https://petersfancybrownhats.com/company_image.png",
            "subtitle":"We have the right hat for everyone.",
            "default_action": {
              "type": "web_url",
              "url": "https://petersfancybrownhats.com/view?item=103",
              "messenger_extensions": false,
              "webview_height_ratio": "tall",
              "fallback_url": "https://petersfancybrownhats.com/"
            },
            "buttons":[
              {
                "type":"web_url",
                "url":"https://petersfancybrownhats.com",
                "title":"View Website"
              },{
                "type":"postback",
                "title":"Start Chatting",
                "payload":"DEVELOPER_DEFINED_PAYLOAD"
              }              
            ]      
          }
        ]
      }
    }
  }
}' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

Пример ответа

{
  "recipient_id": "1254477777772919",
  "message_id": "AG5Hz2Uq7tuwNEhXfYYKj8mJEM_QPpz5jdCK48PnKAjSdjfipqxqMvK8ma6AC8fplwlqLP_5cgXIbu7I3rBN0P"
}

Свойства

`recipient`

Описание получателя сообщения. Все запросы должны включить один из идентификаторов: id, phone_number или user_ref.

Свойство	Тип	Описание
`recipient.id`	Строка	`PSID`, `phone_number` или `user_ref` получателя сообщения.
`recipient.phone_number`	Строка	*Необязательно.* Номер телефона получателя в формате +1(212)555-2368. Чтобы отправлять сообщения этим способом, бот должен получить одобрение на поиск клиентов.
`recipient.user_ref`	Строка	*Необязательно.*`user_ref` из плагина с галочкой.
`recipient.name`	Объект	*Необязательно.* Требуется, только если `phone_number` имеет значение. Указывает имя человека в формате: `{"first_name":"John", "last_name":"Doe"}` Если указать имя, вероятность успешного поиска вырастет.

`message`

Description of the message to be sent.

Property	Type	Description
`message.attachment`	Object	An object describing attachments to the message.

`message.attachment`

Property	Type	Description
`type`	String	Value must be `template`
`payload`	Object	Полезные данные (`payload`) шаблона.

`message.attachment.payload`

Имя свойства	Тип	Описание
`template_type`	Строка	Должно быть значение `generic`.
`elements`	Массив <`element`>	Массив, содержащий один объект element, описывающий медиафайл в сообщении. Максимальное число элементов — 1.
`sharable`	Логическое значение	*Необязательный параметр.* Чтобы включить нативную кнопку "Поделиться" в шаблоне сообщения в Messenger, установите значение `true`. Значение по умолчанию — `false`.

`message.attachment.payload.elements`

Общий шаблон поддерживает до 10 элементов на сообщение. Помимо title должно быть установлено по крайней мере одно свойство.

Имя свойства	Тип	Описание
`title`	Строка	Заголовок, отображаемый в шаблоне. Максимальное количество символов — 80.
`subtitle`	Строка	*Необязательный параметр.* Подзаголовок, отображаемый в шаблоне. Максимальное количество символов — 80.
`image_url`	Строка	*Необязательный параметр.* URL изображения, которое будет отображаться в шаблоне.
`default_action`	Объект	*Необязательный параметр.* Действие по умолчанию, выполняемое при нажатии на шаблон. Принимает те же свойства, что и кнопка URL, кроме `title`.
`buttons`	Массив <`button`>	*Необязательный параметр.* Массив кнопок, добавляемых в шаблон. Поддерживается до трех кнопок на элемент.