İçeriğe geç
Wbiztool

Başlarken

Wbiztool API'ye başlarken

Wbiztool REST API, yazılımınızın bağlı WhatsApp numaranızdan WhatsApp mesajları göndermesini sağlar. Uygulamanızdan, CRM'inizden, web sitenizden veya otomasyon aracınızdan sipariş güncellemeleri, hatırlatmalar ve uyarılar göndermek için kullanın.

Bu sayfa her isteğin neye ihtiyaç duyduğunu anlatır. İlk mesajınızı göndermek için doğrudan Mesaj gönderme sayfasına geçin.

Temel URL#

Tüm endpoint'ler şu adresin altındadır:

https://wbiztool.com/api/v1/

Çoğu endpoint POST isteklerini kabul eder. Gövdeyi JSON (application/json) veya form alanları (application/x-www-form-urlencoded) olarak gönderebilirsiniz. Dosya yüklemek için multipart/form-data kullanın. Birkaç okuma endpoint'i GET kullanır; her endpoint'in sayfasında yöntemi belirtilir.

Başlamadan önce#

  1. Bir hesap oluşturun: wbiztool.com/signup adresinden kaydolun. Yeni hesaplarda 50 ücretsiz mesaj bulunur.
  2. Bir WhatsApp numarası bağlayın. WhatsApp ayarları sayfasını açın, bağlan'a tıklayın ve telefonunuzdaki WhatsApp ile QR kodunu tarayın.
  3. Bir API anahtarı oluşturun. Ayarlar → API anahtarları sayfasına gidin. Anahtarları yalnızca çalışma alanının sahibi oluşturabilir. Her çalışma alanında en fazla 10 anahtar olabilir.

Kimlik doğrulama#

Çoğu endpoint kimlik bilgilerinizi her isteğin gövdesinde alır. Numara doğrulama API'si bunun yerine bir Authorization: Bearer başlığı kullanır; nasıl yapılacağı kendi sayfalarında açıklanır.

client_idintegerzorunlu

API Client ID'niz; Ayarlar → API anahtarları sayfasında gösterilir.

api_keystringzorunlu

Aynı sayfadaki API anahtarlarınızdan biri. Gizli tutun: anahtara sahip olan herkes numaralarınızdan mesaj gönderebilir.

whatsapp_clientintegerÇoğu mesajlaşma endpoint'inde

Gönderimin yapılacağı WhatsApp numarasının ID'si; WhatsApp ayarları sayfasındaki WhatsApp Client ID (WhatsApp istemci ID'si) sütununda gösterilir. Her endpoint sayfası bunun gerekip gerekmediğini belirtir.

API anahtarı, isteğin hangi çalışma alanında işlem yapacağını belirler. Birden fazla çalışma alanına üyeyseniz, göndermek istediğiniz çalışma alanında oluşturulmuş bir anahtar kullanın.

Bir anahtar sızarsa, API anahtarları sayfasında silin. Silinen anahtarlar hemen çalışmayı durdurur.

İlk isteğiniz#

Bu istek, bağlı numaranızdan bir metin mesajı gönderir. ID'leri, anahtarı ve telefon numarasını kendi değerlerinizle değiştirin.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

msg_id içeren bir "status": 1 yanıtı, mesajın kuyruğa alındığı anlamına gelir. Mesaj gönderme sayfası her parametreyi açıklar ve Python, Node.js ve PHP örnekleri içerir.

Yanıtlar ve hatalar#

Her yanıt, status alanı olan bir JSON nesnesidir ("status": 200 döndüren /api/v1/status/ sağlık kontrolü hariç):

  • "status": 1 isteğin başarılı olduğu anlamına gelir.
  • "status": 0 isteğin başarısız olduğu anlamına gelir. message alanı nedenini açıklar.
{ "status": 0, "message": "Auth Error: invalid api key" }

Sık görülen kimlik doğrulama hataları:

MesajAnlamı
Auth Errorclient_id veya api_key eksik, gövde geçerli JSON veya form verisi değil ya da istek POST değil.
Auth Error - Please send correct API key and Client idapi_key eksik veya boş.
Invalid client id. veya Invalid Client Idclient_id bir tam sayı değil (veya bazı endpoint'lerde eksik). Sayı olarak gönderin, örneğin 12345.
Auth Error: invalid api keyAnahtar mevcut değil, silinmiş veya bu client_id değerine ait değil.
Demo Account can not access apisDemo hesaplar API'yi kullanamaz.
Not enough creditsPlanınızda mesaj hakkı kalmadı. Planınızı yükseltin veya bir sonraki fatura döneminizi bekleyin.

Mesaj yaşam döngüsü#

API üzerinden gönderdiğiniz mesajlar önce kuyruğa alınır, ardından WhatsApp numaranızdan gönderilir. Her mesaj şu durumlardan birine sahiptir:

DurumAdAnlamı
0Created (Oluşturuldu)Kuyrukta, gönderilmeyi bekliyor.
1Sent (Gönderildi)WhatsApp numaranızdan gönderildi.
2Failed (Başarısız)Gönderilemedi; örneğin numara WhatsApp'ta olmadığı için.
3Cancelled (İptal edildi)Gönderilmeden önce iptal edildi.
4Expired (Süresi doldu)expire_after_seconds süresi dolmadan gönderilemedi.

Kuyruktaki mesajların gönderilebilmesi için WhatsApp numaranızın bağlı kalması gerekir. Gönderim yaptığınız numaranın bağlantısı kesilirse, mesajları numara yeniden bağlanana veya süreleri dolana kadar kuyrukta bekler. Bağlantısı kesik bir numaradaki gönderilmemiş mesajlar 90 gün sonra silinir.

Bir mesajı takip etmek için yanıttaki msg_id değerini kaydedin ve ya gönderirken bir webhook URL'si iletin ya da Mesaj durumu endpoint'ini çağırın.

Resmi istemci kütüphaneleri#

Python ve Node.js sarmalayıcıları kimlik doğrulama ve dosya yüklemeyi sizin için halleder. Henüz her endpoint'i doğru şekilde desteklemiyorlar; bu yüzden bir istemci yöntemine güvenmeden önce ilgili endpoint sayfasını kontrol edin.

pip install wbiztool-client

Kodsuz bir kurulum mu tercih edersiniz? Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify ve WordPress için Uygulamalar ve entegrasyonlar sayfasına bakın.

Belgelere göz atın#