Tài liệu tham khảo về mẫu chung

Mẫu chung cho phép bạn gửi một tin nhắn có cấu trúc bao gồm một hình ảnh, văn bản và các nút. Một mẫu chung có nhiều mẫu được mô tả trong mảng elements sẽ gửi thẻ quay vòng gồm các mục có thể cuộn theo chiều ngang, mỗi mục chứa một hình ảnh, văn bản và các nút. Để biết chi tiết triển khai đầy đủ, hãy xem bài viết Mẫu chung.

Nội dung

URI yêu cầu

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

Yêu cầu mẫu

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

Phản hồi mẫu

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

Thuộc tính

recipient

Mô tả về người nhận tin nhắn. Tất cả yêu cầu phải bao gồm một trong các id, phone_number hoặc user_ref.

Thuộc tínhLoạiMô tả

recipient.id

Chuỗi

PSID, phone_number hoặc user_ref của người nhận tin nhắn.

recipient.phone_number

Chuỗi

Tùy chọn. Số điện thoại của người nhận có định dạng +1(212)555-2368.


Bot của bạn phải được phê duyệt cho tính năng Khớp khách hàng để gửi tin nhắn theo cách này.

recipient.user_ref

Chuỗi

Tùy chọn.user_ref từ plugin hộp kiểm.

recipient.name

Đối tượng

Tùy chọn. Chỉ sử dụng nếu đặt phone_number. Chỉ định tên của người dùng theo định dạng:


{"first_name":"John", "last_name":"Doe"}

Cung cấp tên sẽ giúp tăng tỷ lệ khớp thành công.

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 của mẫu.

message.attachment.payload

Tên thuộc tính Loại Mô tả

template_type

Chuỗi

Giá trị phải là generic

elements

Mảng<element>

Mảng chứa 1 đối tượng thành phần mô tả file phương tiện trong tin nhắn. Hỗ trợ tối đa 1 thành phần.

sharable

Boolean

Không bắt buộc. Đặt thành true để bật nút chia sẻ gốc trong Messenger cho tin nhắn mẫu. Giá trị mặc định là false.

message.attachment.payload.elements

Mẫu chung hỗ trợ tối đa 10 thành phần trên mỗi tin nhắn. Ngoài title, bạn phải đặt thêm ít nhất 1 thuộc tính.

Tên thuộc tính Loại Mô tả

title

Chuỗi

Tiêu đề sẽ hiển thị trong mẫu. Giới hạn 80 ký tự.

subtitle

Chuỗi

Không bắt buộc. Tiêu đề phụ sẽ hiển thị trong mẫu. Giới hạn 80 ký tự.

image_url

Chuỗi

Không bắt buộc. URL của hình ảnh sẽ hiển thị trong mẫu.

default_action

Đối tượng

Không bắt buộc. Hành động mặc định được thực thi khi người dùng nhấn vào mẫu. Chấp nhận các thuộc tính giống như nút URL, ngoại trừ title.

buttons

Mảng<button>

Không bắt buộc. Mảng nút sẽ thêm vào mẫu. Hỗ trợ tối đa 3 nút trên mỗi thành phần.