Mengirim pesan WhatsApp

Pengiriman minimal

const msg = await bird.whatsapp.send({
  to: "+15551234567",
  template: {
    slug: "bird_otp",
    components: [{ type: "body", parameters: [{ type: "text", text: "123456" }] }],
  },
});
console.log(msg.id, msg.status);

msg = client.whatsapp.send(
    to="+31612345678",
    template="bird_otp",
    language="en",
    components=[{"type": "body", "parameters": [{"type": "text", "text": "123456"}]}],
)
print(msg.id, msg.status)

code := "123456"
msg, err := client.Whatsapp.Send(context.Background(), bird.WhatsappSendParams{
	To:       "+15551234567",
	Template: "bird_otp",
	Language: "en",
	Components: []bird.WhatsAppMessageTemplateComponent{{
		Type:       "body",
		Parameters: &[]bird.WhatsAppMessageTemplateComponentParameter{{Type: "text", Text: &code}},
	}},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(msg.Id, *msg.Status)

$message = $bird->whatsapp->send(
    to: '+15551234567',
    template: 'bird_otp',
    language: 'en',
    components: [
        (new WhatsAppMessageTemplateComponent())
            ->setType('body')
            ->setParameters([
                (new WhatsAppMessageTemplateComponentParameter())->setType('text')->setText('123456'),
            ]),
    ],
);
echo $message->getId(), ' ', $message->getStatus();

bird whatsapp send \
  --components '[{"parameters":[{"text":"1234","type":"text"}],"type":"body"},{"parameters":[{"text":"1234","type":"text"}],"type":"button"}]' \
  --language en \
  --template bird_otp \
  --to +31612345678

curl -X POST "https://{region}.platform.bird.com/v1/whatsapp/messages" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+31612345678",
    "template": {
      "slug": "bird_otp",
      "language": "en",
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "1234"
            }
          ]
        },
        {
          "type": "button",
          "parameters": [
            {
              "type": "text",
              "text": "1234"
            }
          ]
        }
      ]
    }
  }'

Jendela layanan pelanggan

Menyusun payload

Penerima

Template

• slug (wajib): slug template, misalnya bird_order_confirmation. Harus cocok dengan template di katalog Anda (huruf kecil, digit, dan garis bawah).
• language: tag bahasa template, misalnya en atau pt-BR. Abaikan untuk mengirim bahasa default template; menyebutkan bahasa yang tidak dimiliki template mengembalikan 422 yang mencantumkan bahasa yang tersedia. Pesan yang diterima menampilkan bahasa yang diterapkan.
• components: nilai yang mengisi variabel template (lihat Komponen dan parameter). Abaikan untuk template tanpa variabel.

Komponen dan parameter

{
  "components": [
    { "type": "body", "parameters": [{ "type": "text", "text": "481920" }] },
    { "type": "button", "parameters": [{ "type": "text", "text": "481920" }] }
  ]
}

Kategori dan pengirim

• Template yang dikelola Bird (slug-nya diawali bird_) dikirim dari nomor yang disimpan Bird untuk kategori tersebut, jadi abaikan from. Mengisinya mengembalikan 422 WhatsAppSenderNotAllowed.
• Semua yang lain menyebutkan pengirimnya sendiri di from: service message jenis apa pun, dan template apa pun yang dibuat workspace Anda. Nomor tersebut harus dimiliki workspace Anda. Mengabaikannya mengembalikan 422 WhatsAppSenderRequired, dan nomor yang tidak dapat digunakan workspace untuk mengirim mengembalikan 422 WhatsAppSenderNotFound. Template buatan sendiri juga harus berada di WhatsApp Business Account yang sama dengan nomornya, atau pengiriman mengembalikan 422 WhatsAppSenderWABAMismatch.

Service message

• text: { "body": "..." }, hingga 4096 karakter. Tambahkan "preview_url": true untuk merender pratinjau tautan dari URL pertama di body.
• image, video, audio, sticker, document: masing-masing menerima URL https publik yang diambil WhatsApp saat pengiriman (url), jadi URL bertanda tangan harus tetap berlaku lebih lama dari pengiriman. URL http langsung ditolak. WhatsApp mengambil file itu sendiri, sehingga URL yang tidak dapat dijangkau, yang menyajikan tipe tidak didukung, atau file yang melebihi batas ukuran untuk tipenya akan diterima lalu gagal, dengan media_rejected pada last_error pesan dan alasan dari WhatsApp sendiri di description. image, video, dan document juga menerima caption opsional; document juga menerima filename opsional; audio menerima flag voice opsional untuk rendering voice note.
• location: { "latitude": ..., "longitude": ... } (keduanya wajib, derajat desimal) ditambah name dan address opsional.
• contact_cards: array berisi hingga lima kontak yang dibagikan dalam satu pesan. name setiap kartu memerlukan formatted_name ditambah setidaknya satu bagian lain (first_name, last_name, middle_name, prefix, atau suffix); phone_numbers, emails, urls, dan addresses masing-masing menerima hingga sepuluh entri, dan org serta birthday (sebagai YYYY-MM-DD) bersifat opsional. phone_number dalam format E.164 memberi kartu tersebut tombol yang membuka chat dengannya.
• interactive: teks body ditambah sesuatu untuk diketuk, dalam salah satu dari enam tipe: tombol balasan, menu daftar, tombol tautan, carousel media, atau tombol tunggal yang meminta lokasi atau nomor telepon penerima. Pesan interaktif membahas bentuk wire setiap tipe, balasan yang dihasilkan ketukan, dan batasannya.

{
  "to": "+16505551234",
  "from": "+13124495648",
  "text": { "body": "Your order shipped: https://example.com/track/A1B2C3", "preview_url": true }
}

Mengutip pesan

{
  "to": "+16505551234",
  "from": "+13124495648",
  "in_reply_to_message_id": "wam_01kya19eknftrs2s6p82asmvnh",
  "text": { "body": "Yes, that slot is still free." }
}

Tag dan metadata

• tags: hingga 20 label { "name": ..., "value": ... } terstruktur untuk dimensi kardinalitas rendah yang Anda gunakan untuk memfilter dan melaporkan (kampanye, varian eksperimen). Nama dan nilai menerima huruf ASCII, digit, garis bawah, dan tanda hubung; nama dibatasi 32 karakter dan unik dalam satu pengiriman, nilai dibatasi 64. Filter daftar pesan berdasarkan tag (?tag=campaign atau ?tag=campaign:launch-week), dan halaman Metrics memecah pengiriman berdasarkan tag.
• metadata: satu objek JSON arbitrer, hingga 2 KB saat diserialisasi, untuk konteks per pengiriman yang tidak Anda perlukan sebagai dimensi filter (ID pesanan internal, referensi sesi).

{
  "tags": [{ "name": "campaign", "value": "order-confirmations" }],
  "metadata": { "order_id": "ord_8271" }
}

Referensi field

Model async: arti 202

Mencoba lagi dengan aman

Menerima balasan

Biaya dan penagihan

Note: a service message carries no Meta share until September 30th 2026, and neither does a utility template delivered inside an open customer service window. From October 1st 2026 Meta charges for both, except inside a 72-hour free entry point window, and with 1,000 free service messages per business phone number per month: October 2026 pricing changes.

• Pada 202, cost bernilai null. Belum ada yang dihargai.
• Setelah pemrosesan, transaction_amount terisi dan amount sama dengannya. passthrough_amount tetap null.
• Setelah tanda terima delivered atau read yang berlaku, biaya Meta yang berhasil dicatat mengisi passthrough_amount, dan amount mencerminkan komponen yang tercatat.

Langkah berikutnya

• Service message: sembilan jenis konten free-form dan apa yang diterima masing-masing
• Menerima pesan WhatsApp: pesan masuk, media, dan webhook whatsapp.received
• Business-scoped user ID: menjangkau kontak yang menghubungi Anda tanpa nomor telepon
• Templates: telusuri katalog dan baca variabel template
• Mengirim ke grup WhatsApp: menjangkau grup dan membaca tanda terima per peserta
• Idempotency: percobaan ulang yang aman dengan header Idempotency-Key