Message Templates

Message templates offer a way for you to offer a richer in-conversation experience than standard text messages by integrating buttons, images, lists, and more alongside text a single message. Templates can be use for many purposes, such as displaying product information, asking the message recipient to choose from a pre-determined set of options, and showing search results.

Available Templates

The following templates are available for sending structured messages:

Request URI

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

Example Request

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>"

Example Response

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

Properties

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

Property Type Description

template_type

String

Value indicating the template type generic, button, media, receipt, etc

...

Mixed

The rest of message.attachment.payload properties depend on the template type. See Available templates.