For the complete documentation index, see llms.txt. This page is also available as Markdown.

Instalasi & Kirim Pesan Pertama

Pasang WatZap SDK dan kirim pesan WhatsApp pertama dalam beberapa menit.

Di panduan ini Kamu akan memasang WatZap SDK, lalu mengirim pesan WhatsApp pertama ke nomor HP Kamu sendiri.

1

Siapkan API Key dan nomor WhatsApp

Kamu memerlukan:

2

Pastikan Node.js sudah terpasang

Buka terminal (Command Prompt atau PowerShell di Windows), lalu jalankan:

node -v

Kalau muncul versi v18 atau lebih baru, lanjut ke langkah berikutnya. Kalau belum ada, install versi LTS dari nodejs.org.

3

Buat project dan install SDK

mkdir coba-watzap
cd coba-watzap
npm init -y
npm install @watzapid/sdk
4

Simpan API Key di file .env

Buat file bernama .env di dalam folder coba-watzap, lalu isi:

.env
WATZAP_API_KEY=isi_dengan_api_key_kamu
# Khusus nomor Unofficial:
WATZAP_NUMBER_KEY=isi_dengan_number_key_kamu

SDK otomatis membaca API Key dari WATZAP_API_KEY, jadi API Key tidak perlu ditulis di dalam kode.

5

Tulis kode untuk mengirim pesan

Buat file kirim.mjs, lalu pilih kode sesuai jenis nomor Kamu:

kirim.mjs
import { WatZap } from '@watzapid/sdk'

const wz = new WatZap() // API Key otomatis dibaca dari WATZAP_API_KEY

const hasil = await wz.whatsapp.messages.sendText({
  to: '081234567890', // ganti dengan nomor HP Kamu
  text: 'Halo! Ini pesan pertama dari WatZap SDK 🎉',
})

console.log('Terkirim! ID pesan:', hasil.id)

Pesan teks biasa lewat WABA hanya sampai ke nomor yang mengirim chat ke nomor WABA Kamu dalam 24 jam terakhir. Untuk uji coba, kirim chat apa saja dulu dari HP Kamu ke nomor WABA. Di luar 24 jam, gunakan template. Baca juga Memahami Aturan 24 Jam WhatsApp.

kirim.mjs
import { WatZap } from '@watzapid/sdk'

const wz = new WatZap() // API Key otomatis dibaca dari WATZAP_API_KEY
const nomor = wz.unofficial.device(process.env.WATZAP_NUMBER_KEY)

const hasil = await nomor.messages.sendText({
  to: '081234567890', // ganti dengan nomor HP Kamu
  text: 'Halo! Ini pesan pertama dari WatZap SDK 🎉',
})

console.log('Terkirim!', hasil.message)
6

Jalankan

node --env-file=.env kirim.mjs

Kalau berhasil, pesan akan masuk ke WhatsApp Kamu dan terminal menampilkan tulisan Terkirim!

Opsi --env-file membutuhkan Node.js 20.6 atau lebih baru. Kalau muncul error bad option: --env-file, perbarui Node.js ke versi LTS terbaru.

Kalau Gagal

Baca pesan error yang muncul di terminal. Penyebab yang paling sering:

  • Missing API key: API Key belum terbaca. Pastikan WATZAP_API_KEY sudah diisi dan program dijalankan dengan --env-file=.env.

  • Invalid Secret Key atau Invalid API Key: API Key salah. Salin ulang dari member area.

  • Need Upgrade Package: paket Kamu belum mendukung fitur API.

  • numberKey is required.: WATZAP_NUMBER_KEY belum diisi di file .env.

Daftar lengkapnya ada di halaman Menangani Error.

Pakai require atau TypeScript?

Kalau project Kamu memakai CommonJS (require), cara import-nya seperti ini:

const { WatZap } = require('@watzapid/sdk')

Untuk TypeScript, tipe data sudah disertakan di dalam SDK, jadi tidak perlu install paket tambahan.

Pengaturan Tambahan (Opsional)

Setiap fungsi juga menerima pengaturan khusus sebagai argumen terakhir, misalnya { timeout: 10_000 } untuk satu panggilan saja.

Selanjutnya, lihat Contoh Use Case untuk kebutuhan yang lebih nyata.