傳送 API 參考資料

傳送 API 是主要用於傳送訊息給用戶的 API,包含文字、附件、範本、傳送者動作等等。

建立

建立並傳送訊息給您的顧客或對您的 Facebook 專頁感興趣的對象。

準備工作

您需要準備:

  • 由可以執行專頁「MESSAGE」任務的用戶提出申請的專頁存取憑證
  • pages_messaging」權限
  • 訊息收件人必須曾在過去 24 小時內向您的專頁傳送訊息,或同意在標準 24 小時訊息期間以外的時段從您的專頁接收訊息

限制

  • 訊息標籤不能用於傳送推廣內容

請注意,如果是使用 recipient.user_ref recipient.phone_number 傳送的訊息,傳送 API 不會在回應中加入 recipient_id 來識別訊息傳送對象。

要求範例

若傳送訊息給某人,請向「/PAGE-ID/messsages」端點傳送「POST」要求,並設定「messaging_type」和「recipient」參數以及訊息內容。

請使用便於閱讀的格式。

以下示例是對某人訊息的回覆,其中您的專頁只能傳送純文字訊息。

curl -i -X POST "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/messages
    ?recipient={'id':'PSID'}
    &messaging_type=RESPONSE
    &message={'text':'hello,world'}
    &access_token=PAGE-ACCESS-TOKEN

成功傳送後,您的應用程式將收到以下 JSON 回覆:

{
  "recipient_id": "PAGE-SCOPED-ID",
  "message_id": "AG5Hz2U..."
} 

參數

參數說明

message

object

您的專頁傳送的訊息類型。使用此參數時,必須設定為「text」或「attachement」。

  • attachment」物件 – 預覽網址。用於傳送包含媒體或結構化訊息的訊息。必須設定為「text」或「attachment」。

    • type」 – 附件類型。可以是「audio」、「file」、「image」、「template」或「video」。檔案大小上限為 25 MB
    • payload」– 含有範本內容檔案內容的物件
  • metadata」– 您要在「message_echo」webhook 中傳遞的一串附加資料。最多 1000 個字元

  • quick_replies」– 要在訊息中傳送的一組快速回覆
  • text」– 只有純文字的訊息。必須為 UTF-8 格式且最多 2000 個字元。

messaging_type

enum

必須項目

傳送的訊息類型

  • RESPONSE」– 這類訊息是用來回覆已收到的訊息。這包括在 24 小時標準訊息期間內所傳送的推廣和非推廣訊息。舉例來說,如果有人要求確認預約或想了解最新動態,您便可使用這個標籤來回覆。
  • UPDATE」– 這類訊息會主動傳送出去,並非用來回覆已收到的訊息。這包括在 24 小時標準訊息期間內所傳送的推廣和非推廣訊息。
  • MESSAGE_TAG」– 此為非推廣訊息,且是在 24 小時標準訊息期間過後使用訊息標籤所傳送。這類訊息必須符合標籤規範的使用案例。

notification_type

enum

用戶收到的推送通知類型

  • NO_PUSH」– 沒有通知
  • REGULAR」(預設)– 用戶收到訊息時觸發的聲音或振動
  • SILENT_PUSH」– 僅傳送螢幕通知

recipient

object

必須項目

將收到您專頁傳送的訊息的對象

  • id」– 因應您的專頁在過去 24 小時內收到的訊息而用於傳送訊息的對象的 Page-scoped ID,或是已同意在標準 24 小時訊息期間以外時段從您的專頁接收訊息的對象的 Page-scoped ID
  • user_ref」– 因應選框或顧客聊天附加程式而用於傳送訊息的對象的參考資料
  • comment_id」– 因應專頁帖子上收到的訪客回應,以秘密回覆形式傳送訊息的回應的 ID
  • post_id」– 因應專頁上的訪客帖子,以秘密回覆形式傳送訊息的專頁帖子的 ID

sender_action

enum

訊息期間中顯示的操作圖示代表著專頁針對某人傳送的訊息而執行的操作。

  • typing_on」– 在專頁準備回覆時顯示正在輸入的氣泡
  • typing_off」– 不要顯示正在輸入的氣泡
  • mark_seen」– 為專頁已經看到的訊息顯示已讀圖示

只能與「recipient」參數一起傳送。不能與「message」參數一起傳送,但必須作為單獨的要求傳送。

tag

enum

使您的專頁能夠在標準 24 小時訊息期間以外的時段傳送訊息給他人的標籤。

  • ACCOUNT_UPDATE」– 將您傳送給顧客的訊息標記為對其應用程式或帳戶的不定期更新。查看適用的使用案例。

    不適用 Instagram Messaging API。

  • CONFIRMED_EVENT_UPDATE」– 將您傳送給顧客的訊息標記為即將到來的活動的提醒,或標記為顧客已報名參加之正在進行的活動的更新資訊。查看適用的使用案例。

    不適用 Instagram Messaging API。

  • CUSTOMER_FEEDBACK」– 將您傳送給顧客的訊息標記為顧客意見問卷調查。顧客意見訊息必須在顧客傳送最後一則訊息後的 7 天內傳送。查看適用的使用案例。

    不適用 Instagram Messaging API。

  • HUMAN_AGENT」– 為 Instagram Messaging API 的必須項目。將此標籤添加到傳送給某個人的訊息時,它能允許真人服務人員回覆此人的訊息。可以在該對象傳送訊息後的 7 天內傳送訊息。真人服務人員的支援服務是針對無法在標準訊息期間內解決的問題。查看適用的使用案例。
    • 應用程式需要通過開發人員應用程式管理中心申請「Human Agent」權限。請依序前往「應用程式管理中心」 -> 「應用程式審查」 -> 「權限和功能」 -> 「真人服務人員」。之前獲得「真人服務人員」beta 使用權限的應用程式將無需重新申請使用權限。

    Human Agent」權限不適用於標準使用或開發模式。您需要先完成應用程式審查程序,然後才能使用真人服務人員標籤。在提交應用程式審查時,請提供清楚的操作說明和示範,說明您打算如何在您的體驗中運用真人服務人員標籤。

  • POST_PURCHASE_UPDATE」– 將您傳送給顧客的訊息標記為顧客最近購買的更新資訊。查看適用的使用案例。

    不適用 Instagram Messaging API。

訊息標籤使用方式

下表列出了每一種訊息標籤的訊息類型。

訊息標籤使用方式

ACCOUNT_UPDATE

適用的使用方式

  • 有關申請狀態異動的通知,例如信用卡或工作申請
  • 有關可疑活動的通知,例如欺詐警報

不適用的使用方式(非完整清單)

  • 推廣內容,包括但不限於交易、促銷、優惠券和折扣 重複出現的內容(例如,對帳單已準備好、帳單到期、新工作機會)
  • 與之前在 Messenger 中的互動無關的任何問卷調查、投票活動或評論的提示

不適用 Instagram Messaging API。

CONFIRMED_EVENT_UPDATE

適用的使用方式

  • 提醒即將到來的課程、預約或用戶安排的活動
  • 確認用戶的預約或出席已獲接受的活動或預約
  • 用戶交通或預定行程的通知,例如到達、取消、行李延誤或其他行程狀態異動

不適用的使用方式(非完整清單)

  • 推廣內容,包括但不限於交易、促銷、優惠券和折扣
  • 與用戶未報名參加的活動相關的內容(例如,購買活動門票的提醒、其他活動的交叉銷售、行程表等)
  • 與過往活動相關的訊息
  • 與之前在 Messenger 中的互動無關的任何問卷調查、投票活動或評論的提示

不適用 Instagram Messaging API。

CUSTOMER_FEEDBACK

適用的使用方式

  • 售後服務意見的問卷調查
  • 活動意見的問卷調查
  • 商品評論

不適用的使用方式(非完整清單)

  • 該標籤只能與顧客意見範本一起使用。禁止以任何其他形式使用,否則將會失敗。

不適用 Instagram Messaging API。

HUMAN_AGENT

適用的使用方式

  • 真人服務人員可協助處理無法在 24 小時標準訊息期間內解決的問題,例如在正常營業時間以外時段解決問題,或需要超過 24 小時才能解決的問題

不適用的使用方式(非完整清單)

  • 自動訊息
  • 與用戶問題無關的內容

為 Instagram Messaging API 的必須項目。

POST_PURCHASE_UPDATE

適用的使用方式

  • 交易確認,例如發票或收據
  • 出貨狀態的更新,例如產品運輸中、已發貨、已交付或延遲到貨
  • 要求用戶對自己下的訂單執行操作的狀態更新,例如信用卡被拒、商品缺貨,或其他需要用戶執行操作的訂單更新

不適用的使用方式(非完整清單)

  • 推廣內容,包括但不限於交易、推廣、優惠券和折扣
  • 交叉銷售或追加銷售產品或服務的訊息
  • 與之前在 Messenger 中的互動無關的任何問卷調查、投票活動或評論的提示

不適用 Instagram Messaging API。

讀取

您無法在此端點上執行此操作。

若要獲取有關您的專頁參與的對話的相關資訊,請前往專頁對話參考資料

更新

您無法在此端點上執行此操作。

刪除

您無法在此端點上執行此操作。

另請參閱

開發人員支援