Pesan

/v1/messages

Gunakan node messages untuk mengirim teks, media, kontak, lokasi, dan pesan interaktif, serta template pesan kepada pelanggan Anda.

Lihat panduan berikut untuk informasi terkait jenis pesan tertentu yang dapat Anda kirimkan: Pesan Teks, Pesan Media, Pesan Kontak dan Lokasi, Pesan Interaktif, Template Pesan, Template Pesan Media, dan Template Pesan Interaktif.

Sebelum Memulai

Anda memerlukan:

• Autentikasi diri Anda dan terima token autentikasi yang memungkinkan Anda mengakses layanan. Lihat dokumentasi Login dan Autentikasi untuk mengetahui informasi selengkapnya tentang cara melakukannya.
• Untuk memverifikasi akun WhatsApp yang ingin dikirimi pesan dan mendapatkan ID pengguna WhatsApp-nya, lihat dokumentasi Kontak untuk informasi selengkapnya tentang cara melakukan ini.
• Penuhi persyaratan layanan kontrol pemotongan untuk pesan.

Batasan

• Jenis pesan berikut ini didukung: teks, template pesan, gambar, dokumen dan audio.
• Pesan teks dapat sepanjang maksimal 4.096 karakter.

Membuat

Anda mengirim pesan dengan membuat panggilan POST ke node /messages apa pun jenis pesannya. Isi badan pesan JSON berbeda untuk setiap jenis pesan (teks, gambar, dsb.).

Parameter

Berikut ini adalah parameter utama yang digunakan dalam permintaan POST /messages:

Objek Teks

Objek Media

Untuk On-Premises API, ID objek media ditampilkan saat media berhasil diunggah ke klien WhatsApp Business di tempat/referensi melalui endpoint media.

Objek Kontak

Di dalam contacts, Anda dapat melapis objek berikut: addresses, emails, name, org, phone, dan urls. Objek jamak harus dibungkus dalam array seperti yang ditunjukkan pada contoh di bawah ini.

Contoh objek contacts dengan objek jamak berlapis di dalamnya:

"contacts": [
    {
        "addresses": [
            {
                "city": "city name",
                "country": "country name",
                "country_code": "code",
                "state": "Contact's State",
                "street": "Contact's Street",
                "type": "Contact's Address Type",
                "zip": "Contact's Zip Code"
            }
        ],
        "birthday": "birthday",
        "emails": [
            {
                "email": "email",
                "type": "HOME"
            },
            {
                "email": "email",
                "type": "WORK"
            }
        ],
        "name": {
            "first_name": "first name value",
            "formatted_name": "formatted name value",
            "last_name": "last name value",
            "suffix": "suffix value"
        },
        "org": {
            "company": "company name",
            "department": "dep name",
            "title": "title"
        },
        "phones": [
            {
                "phone": "Phone number",
                "wa-id": "WA-ID value",
                "type": "MAIN"
            },
            {
                "phone": "Phone number",
                "type": "HOME"
            },
            {
                "phone": "Phone number",
                "type": "WORK"
            }
        ],
        "urls": [{
            "url": "some url",
            "type": "WORK"
        }]
    }
]

Objek Lokasi

Objek Template

Di dalam template, Anda dapat menyusun objek components dan language.

Objek Komponen

Di dalam components, Anda bisa menyusun objek parameters. Selain itu, Anda dapat mengatur type ke button.

Objek Parameter

Jenis Tombol

Di dalam objek components, Anda dapat mengatur type ke button. Ini adalah parameter tombol:

Contoh jenis button dengan sub_type quick_reply:

 {
    "type": "button",
    "sub_type": "quick_reply",
    "index": 0,
    "parameters": 
     [{
    	"type": "payload",
    	"payload": "Yes-Button-Payload"
     }]
 } 

Contoh jenis button dengan sub_type copy_code

    
 { 
    "type": "button", 
    "sub_type": "copy_code", 
    "index": 0, 
    "parameters": 
    [{ 
     "type": "coupon_code", 
     "coupon_code": "DISCOUNT20" 
    }] 
 }

Objek Hsm

Objek Interaktif

Objek Tindakan

Contoh

Pesan audio:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio",
  "audio": {
      "id": "your-media-id",
  }
}

Pesan dokumen, menggunakan filename:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "id": "your-media-id",
      "filename": "your-document-filename"
  }
}

Pesan dokumen, menggunakan link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }     
    }
}

Pesan video, menggunakan link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "video",  
  "video": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }
    }
  }
}

Pesan teks:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "text",
  "text": {
      "body": "your-message-content"
  }
}

Pesan interaktif (daftar):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive":{
    "type": "list",
    "header": {
      "type": "text",
      "text": "your-header-content-here"
    },
    "body": {
      "text": "your-text-message-content-here"
    },
    "footer": {
      "text": "your-footer-content-here"
    },
    "action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }
  }

}

Pesan interaktif (tombol balas):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": { # optional
      "type": "text" | "image" | "video" | "document",
      "text": "your text"
      # OR
      "document": {
        "id": "your-media-id",
        "filename": "some-file-name"
      }
      # OR
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name",
        },
        "filename": "some-file-name"
      },
      # OR
      "video": {
        "id": "your-media-id"
      }
      # OR
      "video": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
      # OR
      "image": {
        "id": "your-media-id"
      }
      # OR
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    }, # end header
    "body": {
      "text": "your-text-body-content"
    },
    "footer": { # optional
      "text": "your-text-footer-content"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    } # end action   
  } # end interactive

}

Pesan interaktif (Pesan Multiproduk dan Satu Produk):

{ 
  "recipient_type": "individual",
  "to" : "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "body text"
    },
    "footer": {
      "text": "footer text"
    },
    "action": {
      "
      
      _id": "catalog-ID",
      "product_retailer_id": "product-ID"
    }
  }
}

Pesan interaktif (Pesan Multiproduk):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "product_list",
    "Header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }
}

Pesan interaktif (Pesan Katalog):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "catalog_message",
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "name": "catalog_message",
      	"parameters":{ 
      	  "thumbnail_product_retailer_id": "product-SKU-in-catalog"
      	}
     },  
    }
}

Pesan interaktif (Alur):

{
  "recipient_type": "individual",
  "to": "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "flow",
    "header": {
      "type": "text",
      "text": "Flow message header"
    },
    "body": {
      "text": "Flow message body"
    },
    "footer": {
      "text": "Flow message footer"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
        "flow_id": "<FLOW_ID>",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_ID>",
          "data": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }
  }
}

Berikut ini menampilkan contoh payload dalam tanggapan. Objek meta dan kesalahan dihilangkan untuk mempersingkat.

{
  "messages": [{ 
    "id": "message-id" 
  }]    
}

Jika permintaan berhasil, Anda akan menerima tanggapan dengan ID pesan. Jika permintaan menampilkan bagian errors, periksa pesan asal dan perbaiki kesalahan sebelum mengirim ulang permintaan. Untuk informasi selengkapnya tentang kesalahan, lihat Kode Kesalahan Klien WhatsApp Business di tempat/referensi dan Kode Status HTTP.

Jika permintaan ditahan untuk penilaian kualitas, tanggapan akan berisi properti message_status dengan pesan yang menunjukkan bahwa pesan tersebut tidak dikirim segera dan akan dikirim atau dilepas setelah kualitas telah divalidasi. Properti ini hanya akan ada jika pesan ditahan.

    {
      "messages": [{ 
        "id": "message-id",
        "message_status": "Message has been held because quality assessment is pending",
      }]    
    }
    

Pemformatan dalam Pesan Teks

WhatsApp memungkinkan beberapa pemformatan dalam pesan. Untuk memformat seluruh atau sebagian dari pesan, gunakan simbol pemformatan berikut:

Kinerja

Dalam konteks ini, kinerja mewakili jumlah pesan yang dapat dikirim dalam setiap detik menggunakan klien di tempat/referensi WhatsApp Business. Kinerja maksimum yang dapat dicapai bergantung pada berbagai faktor, faktor terpenting adalah pilihan pengaturan klien Anda dan apakah pesan dikirim ke pengguna baru atau pengguna yang sudah ada — pengaturan sesi enkripsi membutuhkan waktu lebih lama saat mengirim pesan kepada pengguna baru.

Pertanyaan Umum

Pelajari selengkapnya

• Dokumentasi Login dan Autentikasi
• Dokumentasi Kontak
• Kode Kesalahan Klien referensi/on-premises WhatsApp Business
• Kode Status HTTP