附件上傳 API 參考資料

附件上傳 API 可讓您上傳素材，以供之後透過訊息傳送，而不需要重複上傳常用的檔案。此 API 支援從網址和本機檔案系統儲存素材。

您也可以使用 Send API 來傳送含附件的訊息，並同時儲存附件供之後使用。如需詳細資訊，請參閱以下的上傳和傳送部分。

上傳附件

若要上傳附件，請傳送 POST 要求至 /Your-page-id/message_attachments 端點，並包含具有 type 和 payload 的 message.attachment。為了能夠在多則訊息中使用該素材，請將 payload.is_reusable 設為 true。

從網址上傳的要求範例

採用方便閱讀的格式。將粗體、斜體值（例如 page_access_token）更換為您的值。

curl -X POST "https://graph.facebook.com/v21.0/Your-page-id/message_attachments" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token":"Your_page_access_token",
           "message":{
             "attachment":{
               "type":"image", 
               "payload":{
                 "url":"https://your-url.com/image.jpg",
                 "is_reusable": true
               }
             }
           }
         }'

從檔案上傳的要求範例

採用方便閱讀的格式。將粗體、斜體值（例如 page_access_token）更換為您的值。

curl -X POST -H "Content-Type: application/json" -d '{
   "message": {
     "attachment": {
       "type": "image"
     }
   },
   "filedata": "@/path-to-your-file/image.jpg",
   "type": "image/png"
  }' "https://graph.facebook.com/v21.0/{PAGE_ID}/message_attachments?access_token={PAGE_ACCESS_TOKEN}"

成功後，應用程式將收到一個 JSON 物件，其 attachment_id 設定為訊息中所使用的附件編號。

{"attachment_id": "Your-attachment-ID"}

傳送包含已上傳素材的訊息

若要傳送包含已上傳素材的訊息（上傳時 message.attachment.payload.is_reusable 設為 true），請傳送 POST 要求至 /Your-page-id/messages 端點並包含 recipient.id，以及包含 type 和 payload.attachment_id 的 message.attachment 物件。

從檔案上傳的要求範例

採用方便閱讀的格式。將粗體、斜體值（例如 page_access_token）更換為您的值。

curl -X POST -H "Content-Type: application/json" -d '{
    "recipient": {
      "id": "{PSID}"
    },
    "message": {
      "attachment": {
        "type": "image",
        "payload": {
          "attachment_id": "Your-attachment-ID"
        }
      }
    }
  }' "https://graph.facebook.com/v21.0/{PAGE_ID}/messages?access_token={PAGE_ACCESS_TOKEN}"

成功後，應用程式將收到一個 JSON 物件，其 success 設為 true。

{"success": "true"}

上傳和傳送

您也可以上傳媒體並在單一 API 要求中傳送。

從網址上傳的要求範例

採用方便閱讀的格式。將粗體、斜體值（例如 page_access_token）更換為您的值。

curl -X POST -H "Content-Type: application/json" -d '{
   "recipient": {
     "id": "{PSID}"
   },
   "message": {
     "attachment": {
       "type": "image",
       "payload": {
         "url": "https://your-url.com/image.jpg"
       }
     }
   }
  }' "https://graph.facebook.com/v21.0/{PAGE_ID}/messages?access_token={PAGE_ACCESS_TOKEN}"

成功後，應用程式將收到一個 JSON 物件，其 success 設為 true。

{"success": "true"}

屬性

若是從網址上傳的附件，請在要求內文中以 JSON 物件提供以下屬性。若是從檔案上傳的附件，請以表單資料傳送屬性。

message

message.attachment

message.attachment.payload

錯誤代碼