Cloud API

Mengirim Template Promo Waktu Terbatas

Dokumen ini menjelaskan cara mengirim template promo waktu terbatas dalam pesan template.

Gunakan endpoint Nomor Telepon WhatsApp Business > Pesan untuk mengirim template template promo waktu terbatas yang disetujui dalam pesan template.

Sintaks Permintaan

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

Body Postingan

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<CUSTOMER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<TEMPLATE_LANGUAGE_CODE>"
    },
    "components": [

      /* Required if template uses header, otherwise omit */
      {
        "type": "header",
        "parameters": [
          {
            "type": "<HEADER_TYPE>",
            "<HEADER_TYPE>": {
              "id": "<HEADER_ASSET_ID>"
            }
          }
        ]
      },

      /* Body and params required if templates uses body params, otherwise omit */
      {
        "type": "body",
        "parameters": [
          <BODY_VARIABLES>
        ]
      },

      /* Required if template uses offer expiration details, otherwise omit */
      {
        "type": "limited_time_offer",
        "parameters": [
          {
            "type": "limited_time_offer",
            "limited_time_offer": {
              "expiration_time_ms": <EXPIRATION_TIME>
            }
          }
        ]
      },

      /* Copy code button optional */
      {
        "type": "button",
        "sub_type": "copy_code",
        "index": 0,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "<OFFER_CODE>"
          }
        ]
      },

      /* Required */
      {
        "type": "button",
        "sub_type": "url",
        "index": <URL_BUTTON_INDEX>,
        "parameters": [
          {
            "type": "text",
            "text": "<URL_VARIABLE>"
          }
        ]
      }
    ]
  }
}'

Properti Body

PlaceholderDeskripsiContoh Nilai

<BODY_VARIABLES>

Array objek

Wajib jika teks body template menggunakan variabel.


Nilai variabel teks body. Tentukan setiap variabel sebagai objek individu.

{"type":"text","text":"Pablo"},{"type":"text","text":"CARIBE25"}

<CUSTOMER_PHONE_NUMBER>

String

Wajib.


Nomor telepon pelanggan tujuan pengiriman pesan template.

+16505555555

<EXPIRATION_TIME>

Cap waktu UNIX

Wajib.


Kode promo waktu kedaluwarsa sebagai cap waktu UNIX dalam milidetik.

1698562800000

<HEADER_ASSET_ID>

ID aset media

Wajib.


ID aset media yang diunggah. Gunakan endpoint /PHONE_NUMBER_ID/media untuk membuat ID.

1602186516975000

<HEADER_TYPE>

String

Wajib.


Jenis header yang digunakan oleh template. Nilai dapat berupa image atau video.

image

<OFFER_CODE>

String

Wajib jika template menggunakan tombol salin kode.


Kode promo.


Maksimal 15 karakter.

CARIBE25

<TEMPLATE_LANGUAGE_CODE>

Enum

Wajib.


Kode bahasa dan locale template.

en_US

<TEMPLATE_NAME>

String

Wajib.


Nama template.

limited_time_offer_caribbean_pkg_2023

<URL_BUTTON_INDEX>

Integer

Wajib.


Indeks tombol URL. Jika template menggunakan tombol salin kode, nilainya haruslah 1.


Jika template tidak menggunakan tombol salin kode, nilainya harus 0.

1

<URL_VARIABLE>

String

Wajib jika URL menggunakan variabel.


Nilai variabel URL.


Tidak ada maksimum, tetapi nilai dihitung terhadap string URL maksimal 2.000 karakter.

n3mtql

Contoh Permintaan

Contoh permintaan untuk mengirim template promo waktu terbatas yang menggunakan:

  • header gambar
  • variabel teks body
  • detail kedaluwarsa promo
  • tombol salin kode
  • tombol URL dengan variabel
curl 'https://graph.facebook.com/v17.0/106540352242922/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "16505555555",
  "type": "template",
  "template": {
    "name": "limited_time_offer_caribbean_pkg_2023",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "id": "1602186516975000"
            }
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Pablo"
          },
          {
            "type": "text",
            "text": "CARIBE25"
          }
        ]
      },
      {
        "type": "limited_time_offer",
        "parameters": [
          {
            "type": "limited_time_offer",
            "limited_time_offer": {
              "expiration_time_ms": 1209600000
            }
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "copy_code",
        "index": 0,
        "parameters": [
          {
            "type": "coupon_code",
            "coupon_code": "CARIBE25"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "url",
        "index": 1,
        "parameters": [
          {
            "type": "text",
            "text": "n3mtql"
          }
        ]
      }
    ]
  }
}'

Contoh Tanggapan

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "16505555555",
      "wa_id": "16505555555"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY1MDUwNzY1MjAVAgARGBI5QTNDQTVCM0Q0Q0Q2RTY3RTcA"
    }
  ]
}