WhatsApp Business 管理 API

抵用券代碼範本

抵用券代碼範本是營銷類別範本，可顯示一個複製代碼按鈕。當顧客點按此按鈕時，系統會將代碼複製到顧客的剪貼簿。

限制

  • WhatsApp 網頁版用戶端目前不支援抵用券代碼範本。
  • 代碼長度不得超過 15 個字元。
  • 按鈕文字不可自訂。
  • 範本僅限包含 1 個複製代碼按鈕。

建立抵用券代碼範本

使用 WhatsApp Business 帳戶 > 訊息範本端點來建立抵用券代碼範本。

要求語法

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

帖子內文

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    ... // Additional components, if using
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type":"COPY_CODE",
          "example": "<EXAMPLE>"
        },
        ... // Additional buttons, if using
      ]
    }
  ]
}

屬性

預留位置說明範例值

<NAME>

字串

此為必要項目。


範本名稱。


最多 512 個字元。

fall2023_promotion

<LANGUAGE>

列舉

此為必要項目。


範本的語言和地區設定代碼。

en_US

<EXAMPLE>

字串

此為必要項目。


在顧客點按按鈕時要複製的抵用券代碼。


最多 15 個字元。

25OFF

回應

成功的話，API 將傳回包含以下資料的回應：

{
   "category" : "<CATEGORY>",
   "id" : "<ID>",
   "status" : "<STATUS>"
}

回應屬性

預留位置說明範例值

<CATEGORY>

列舉

範本類別。

MARKETING

<ID>

數字字串

範本編號。

1924084211297547

<STATUS>

列舉

範本狀態。

PENDING

要求範例

curl 'https://graph.facebook.com/v21.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "coupon_code_fall2023_25off",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Our Fall Sale is on!"
    },
    {
      "type": "BODY",
      "text": "Shop now through November and use code {{1}} to get {{2}} off of all merchandise!",
      "example": {
        "body_text": [
          [
            "25OFF",
            "25%"
          ]
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubscribe"
        },
        {
          "type": "COPY_CODE",
          "example": "250FF"
        }
      ]
    }
  ]
}'

回應範例

{
  "category" : "MARKETING",
  "id" : "1924084211297547",
  "status" : "PENDING"
}

傳送抵用券範本

使用 Cloud API 以範本訊息傳送已批准的抵用券代碼範本。參見傳送抵用券代碼範本。