Langsung ke konten
WbizTool

API Pesan

API Kirim Pesan ke Grup WhatsApp

Kirim teks, gambar, atau dokumen WhatsApp ke grup WhatsApp yang beranggotakan nomor Anda yang terhubung. Gunakan untuk pengumuman tim, update komunitas, dan notifikasi siaran.

POSThttps://wbiztool.com/api/v1/send_msg/group/

Body: JSON, field formulir, atau multipart/form-data saat mengunggah file

Pesan masuk antrean dan dikirim ke grup dari nomor WhatsApp Anda. Respons memberi Anda msg_id yang dapat digunakan untuk memeriksa statusnya.

Contoh singkat#

curl -X POST https://wbiztool.com/api/v1/send_msg/group/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "group_name": "Sales Team Mumbai",
    "msg": "Reminder: *weekly review* starts at 4 PM today."
  }'

Ganti 12345, YOUR_API_KEY, dan 678 dengan nilai Anda sendiri. Lihat Autentikasi untuk mengetahui di mana menemukannya.

Parameter request#

Autentikasi

AuthorizationheaderDisarankan

Bearer YOUR_API_KEY: kunci API Anda dari Pengaturan → Kunci API. Dengan header ini, client_id dan api_key boleh tidak dikirim di body; jika keduanya dikirim, kunci valid di header yang dipakai. Lihat Mengirim kunci di header.

client_idintegerTanpa header Authorization

API Client ID Anda dari Pengaturan → Kunci API. Opsional jika memakai header; jika Anda mengirimnya, nilainya harus Client ID workspace kunci tersebut.

api_keystringTanpa header Authorization

Kunci API Anda dari halaman yang sama, jika Anda tidak mengirimnya di header.

whatsapp_clientintegerWajib jika workspace Anda memiliki lebih dari satu nomor yang terhubung

ID nomor WhatsApp yang digunakan untuk mengirim, dari WhatsApp settings (pengaturan WhatsApp). Nomor apa pun di workspace Anda bisa digunakan, siapa pun anggota tim yang menghubungkannya. Jika tidak dikirim dan workspace Anda memiliki tepat satu nomor WhatsApp yang terhubung, nomor tersebut yang digunakan (atau satu-satunya akun Telegram, jika tidak ada nomor WhatsApp yang terhubung).

Grup dan pesan

group_namestringwajib

Nama grup WhatsApp, ditulis persis seperti yang tampil di WhatsApp. Kirim sebagai string. Angka JSON seperti 2024 mengembalikan halaman error HTML (HTTP 500). Lihat Cara grup ditemukan.

msg_typeintegeropsional

0 teks (default), 1 gambar, 2 file atau dokumen.

msgstringWajib jika msg_type bernilai 0

Teks pesan. Untuk gambar dan file, ini adalah keterangan (caption) dan boleh kosong. Format WhatsApp berfungsi: *bold*, _italic_, ~strikethrough~. message diterima sebagai alias.

Gambar dan file

img_urlstringWajib jika msg_type bernilai 1 dan tidak ada file yang diunggah

URL http atau https publik dari gambar.

file_urlstringWajib jika msg_type bernilai 2 dan tidak ada file yang diunggah

URL http atau https publik tempat file dapat diunduh secara langsung.

filefileopsional

Unggah gambar atau file sebagai ganti URL. Kirim request sebagai multipart/form-data dengan field bernama file.

file_namestringopsional

Nama file yang dilihat grup, misalnya price-list.pdf. Ekstensinya menentukan cara file dikirim, jadi sertakan ekstensi. Nama dikirim dalam huruf kecil, karakter seperti & : ? * $ ; diganti dengan _, dan dipotong menjadi 150 karakter. Jika tidak dikirim, nama diambil dari URL atau file yang diunggah.

Opsi pengiriman

expire_after_secondsintegeropsional

Tandai pesan sebagai kedaluwarsa (status 4) jika belum terkirim dalam jumlah detik ini, misalnya 3600 untuk satu jam. Proses latar belakang melakukannya paling cepat 30 detik setelah batas waktu, jadi jangan mengandalkannya untuk batas waktu yang lebih pendek dari satu menit.

webhookstringopsional

URL yang menerima POST ketika pesan terkirim atau gagal. Payload-nya sama seperti pada Kirim pesan.

idempotency_keystringopsional

Opsional, maksimal 255 karakter. Selama 24 jam, jika Anda mencoba lagi dengan nilai yang sama, Anda menerima respons pertama, bukan pesan kedua. Anda juga dapat mengirimnya sebagai header Idempotency-Key. Lihat Mencoba lagi dengan aman.

Gambar dan file mengikuti aturan yang sama seperti Kirim pesan: URL diunduh saat Anda memanggil API (hingga 100 MB). Saat pesan dikirim, gambar lebih dari 16 MB dan video lebih dari 64 MB gagal, audio WAV dan OGG tidak dapat dikirim sebagai gambar (msg_type 1), dan file (msg_type 2) tanpa ekstensi atau dengan ekstensi yang tidak didukung ditambahi .pdf, termasuk file yang diunggah. Nama file dikirim dalam huruf kecil. Lihat Mengirim gambar dan file untuk daftar lengkap ekstensi dan error.

Untuk mengunggah file, gunakan contoh multipart di Kirim pesan, dengan mengganti URL menjadi /api/v1/send_msg/group/ serta phone/country_code menjadi group_name.

Gambar dari URL
curl -X POST https://wbiztool.com/api/v1/send_msg/group/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 1,
    "group_name": "Sales Team Mumbai",
    "img_url": "https://example.com/reports/weekly-sales.png",
    "msg": "This week'\''s sales summary"
  }'

Cara grup ditemukan#

WbizTool tidak memeriksa nama grup saat Anda memanggil API. Saat pesan sedang dikirim, WbizTool mencari group_name di chat WhatsApp Anda dan hanya mengirim ke grup yang namanya persis group_name. Karena itu:

  • Nomor WhatsApp Anda yang terhubung harus menjadi anggota grup.
  • Gunakan nama grup yang persis seperti yang ditampilkan WhatsApp, termasuk emoji dan tanda baca. Spasi di awal dan akhir diabaikan, dan beberapa spasi berturut-turut dihitung sebagai satu.
  • Nama sebagian tidak lagi cocok. Sales Team tidak mengirim ke Sales Team Mumbai, meskipun grup itu adalah hasil pencarian pertama.
  • Tulis huruf besar dan kecil seperti yang ditampilkan WhatsApp. Nama yang hanya berbeda huruf besar/kecilnya, seperti sales team mumbai, hanya diterima jika tidak ada chat dengan ejaan yang persis sama dan hanya satu ejaan yang cocok.
  • Jangan beri kontak nama yang sama dengan grup. Jika ada kontak di WhatsApp Anda dengan nama itu, atau kontak dan grup memakai nama yang sama, pesan tidak dikirim. Ganti nama kontak atau grupnya.
  • Jika dua grup memiliki nama yang persis sama, pesan dikirim ke grup pertama di hasil pencarian WhatsApp. Beri setiap grup nama yang unik.
  • Jika tidak ada grup dengan nama persis itu, jika nama itu milik kontak, jika hanya admin yang dapat mengirim pesan di grup dan nomor Anda bukan admin, atau jika hanya admin komunitas yang dapat memposting, pesan gagal dengan error Group not found.
  • Jika nomor Anda sudah keluar dari grup, pesan gagal dengan error Group member blocked.

Masalah grup tidak muncul di respons API. Gunakan webhook atau Status pesan untuk mengetahui apakah pesan sudah terkirim.

Menggunakan klien resmi#

Klien Python memanggil endpoint ini untuk Anda.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.send_message_to_group(
    group_name="Sales Team Mumbai",
    msg="Reminder: weekly review starts at 4 PM today.",
    whatsapp_client=678,
)
print(result)

Error memunculkan requests.HTTPError. Baca penyebabnya dengan e.response.json()["message"].

Respons#

Request yang berhasil mengembalikan HTTP 200:

{
  "status": 1,
  "message": "Created",
  "msg_id": 9817263
}
FieldTipeDeskripsi
statusinteger1 jika pesan masuk antrean, 0 jika request gagal.
messagestringCreated jika berhasil, selain itu berisi error.
msg_idintegerID pesan dalam antrean. Simpan untuk memeriksa status nanti. Hanya ada jika berhasil.

"status": 1 berarti pesan sudah masuk antrean, belum tentu sudah sampai ke grup. Gunakan webhook atau Status pesan untuk memastikan pesan sudah terkirim.

Error#

Error mengembalikan HTTP 400 dengan status bernilai 0:

{ "status": 0, "message": "Group Name cant be null" }
PesanCara memperbaikinya
Auth Error - Please send correct API key and Client idKirim api_key yang tidak kosong.
Invalid client id.Kirim client_id sebagai angka.
Auth Error: invalid api keyPastikan kunci tersebut ada, belum dihapus, dan milik client_id ini.
Group Name cant be nullTambahkan group_name.
Msg cant be nullPesan teks (msg_type 0) memerlukan msg.
Image Url Can't be nullUntuk msg_type 1, kirim img_url atau unggah file.
File Url Can't be nullUntuk msg_type 2, kirim file_url atau unggah file.
Invalid file url, Can't download / Invalid file urlURL tidak publik, waktu habis (timeout), atau file lebih dari 100 MB.
Invalid whatsapp client <id>: this WhatsApp number was deleted or does not belong to your account…whatsapp_client tersebut sudah dihapus atau tidak ada di workspace milik API key ini. Gunakan ID nomor yang terhubung dari WhatsApp settings.
Invalid whatsapp client id.Kirim whatsapp_client. Parameter ini wajib kecuali workspace Anda memiliki tepat satu nomor yang terhubung.
Not enough creditsWorkspace memakai paket gratis dan pesannya sudah habis: paket berbayar mengirim pesan tanpa batas. Lihat Saat pesan Anda habis.
Daily limit reached: a number can send 1,000 messages in 24 hours (fair use). Send the rest tomorrow. (HTTP 429, "code": "daily_limit_reached")Nomor ini sudah menerima 1.000 pesan dalam 24 jam terakhir (penggunaan wajar). Respons tetap berisi msg_id pesan yang ditolak, yang tampil sebagai gagal. Kirim sisanya nanti atau dari nomor lain.
Demo Account can not access apisGunakan akun biasa.
Account DisabledAkun Anda dinonaktifkan. Hubungi dukungan.
Invalid JSON format: …Body JSON tidak valid, sering kali karena koma di akhir atau baris baru tanpa escape di msg. Gunakan \n untuk baris baru.

Tips#

  • Uji nama grup terlebih dahulu: kirim teks singkat ke grup dan periksa Status pesan sebelum mengotomatiskan apa pun. Jika gagal dengan Group not found, lihat Cara grup ditemukan.
  • Grup yang diganti namanya: jika seseorang mengganti nama grup di WhatsApp, perbarui juga group_name di integrasi Anda.
  • Jenis pesan: hanya 0, 1, dan 2 yang merupakan nilai valid untuk msg_type. Nilai apa pun yang bukan bilangan bulat mengembalikan halaman error HTML (HTTP 500), bukan JSON.
  • Beberapa grup sekaligus: Kirim ke banyak nomor menerima nama grup yang dicampur dengan nomor telepon dalam satu request.