İçeriğe geç
ZZenWapp Docs

API referansı

Giriş

ZenWapp External API, 53 uç nokta üzerinden mesajlaşma, kişi yönetimi, otomasyon ve webhook yönetimi sağlar.

Base URL

https://api.zenwapp.com/api/v1/whatsapp/external

Referanstaki tüm yollar bu adresin devamıdır. Örneğin /messages/send gerçekte https://api.zenwapp.com/api/v1/whatsapp/external/messages/send adresine karşılık gelir.

İstek biçimi

  • Gövdeli isteklerde Content-Type: application/json kullanın. Dosya yüklemede multipart/form-data da desteklenir.
  • Telefon numaralarını ülke kodlu verin (905551234567). Baştaki +, 0 ve boşluklar normalize edilir.
  • Tarih alanları ISO 8601 biçimindedir ve UTC olarak yorumlanır.

Yanıt yapısı

Başarılı yanıtlar success: true taşır; veri data alanında döner. Listeleme uçları ek olarak pagination nesnesi içerir.

{
  "success": true,
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 128
  }
}

Sayfalama

Kişi, şablon, zamanlanmış mesaj ve kampanya listeleri page / limit ile sayfalanır. Sohbet mesajları ise imleç tabanlıdır: before parametresine en eski mesajın zaman damgasını vererek geriye doğru ilerleyin.

Asenkron gönderim

Gönderim uçları isteği kuyruğa alır ve 202 Accepted döner. Bu, kanal tarafındaki gecikmelerin isteğinizi bloklamamasını sağlar.

sync modunu dikkatli kullanın

POST /messages/send içinde sync: true yanıtı gönderim tamamlanana kadar bekletir. Tek seferlik doğrulamalar için uygundur; toplu işlerde zaman aşımı (504) üretir. Üretimde teslimat takibini webhook ile yapın.

Uç nokta grupları

GrupUçKapsam
System2Sağlık kontrolü ve bağlı hesap bilgisi. Entegrasyonunuzu doğrulamak için ilk çağıracağınız uçlar.
Chats3Sohbet listesi, telefon numarasından sohbet eşleştirme ve sohbet mesaj geçmişi.
Messages4Metin mesajı gönderimi, kuyruk ve hız limiti durumu, içerik doğrulama.
Media8Görsel, doküman, ses, voice ve sticker gönderimi ile medya dosyalarına erişim.
Contacts6Kişi listeleme, detay, güncelleme, silme, WhatsApp numara kontrolü ve toplu senkron.
Groups & Tags4Grup ve etiket listeleme/oluşturma.
Templates6Değişken destekli mesaj şablonlarının yönetimi ve şablonla gönderim.
Scheduled5İleri tarihli mesaj planlama, listeleme, güncelleme ve iptal.
Auto Replies5Anahtar kelime, regex veya mesai saatine göre tetiklenen otomatik yanıt kuralları.
Broadcast5Çok alıcılı kampanya gönderimi, ilerleme takibi ve iptal.
Webhooks5Gerçek zamanlı olay teslimatı için webhook URL yönetimi, test ve secret rotasyonu.

Tüm uç noktalar