İçeriğe geç
ZZenWapp Docs

API referansı

Contacts

Kişi listeleme, detay, güncelleme, silme, WhatsApp numara kontrolü ve toplu senkron.

get/contacts

Kişileri listele

Sayfalanmış kişi listesi döndürür. Arama, etiket ve WhatsApp kullanıcı durumuna göre filtrelenebilir.

Gerekli yetki: chats:read

Sorgu parametreleri

pageintegerVarsayılan: 1
limitintegerVarsayılan: 50
searchstringİsim veya telefonda arama.
tagsstringVirgülle ayrılmış etiket adları.
is_whatsapp_userboolean
sort_bystringVarsayılan: last_message_at
sort_orderstringDeğerler: asc, descVarsayılan: desc

İstek örneği

curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/contacts" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt 200

{
  "success": true,
  "data": [
    {
      "phone": "905551234567",
      "name": "Ahmet Yılmaz",
      "tags": [
        "bayi"
      ],
      "is_whatsapp_user": true
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 128
  }
}

Yanıt kodları

  • 200Kişi listesi
get/contacts/{phone}

Kişi detayı

Telefon numarasına göre kişi kaydını döndürür.

Gerekli yetki: chats:read

Yol parametreleri

phonezorunlustringÜlke kodlu telefon numarası.

İstek örneği

curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt 404

{
  "error": "contact_not_found"
}

Yanıt kodları

  • 200Kişi detayı
  • 404Kişi bulunamadı
put/contacts/{phone}

Kişiyi güncelle

Kişinin adı, etiketleri, notu, özel alanları ve engel durumu güncellenir. Yalnızca gönderilen alanlar değişir.

Gerekli yetki: chats:read

Yol parametreleri

phonezorunlustringÜlke kodlu telefon numarası.

Gövde alanları

namestring
tagsstring[]
notesstring
custom_fieldsobject
is_blockedboolean

İstek örneği

curl -X PUT "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ahmet Yılmaz","tags":["bayi","istanbul"]}'

Yanıt kodları

  • 200Güncellendi
  • 404Kişi bulunamadı
delete/contacts/{phone}

Kişiyi sil

Kişi kaydını siler. Sohbet geçmişi silinmez.

Gerekli yetki: chats:read

Yol parametreleri

phonezorunlustringÜlke kodlu telefon numarası.

İstek örneği

curl -X DELETE "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt kodları

  • 200Silindi
  • 404Kişi bulunamadı
get/contacts/{phone}/check

Numara WhatsApp'ta mı?

Numaranın WhatsApp'ta kayıtlı olup olmadığını canlı olarak sorgular. Hesabın bağlı (connected) olması gerekir.

Gerekli yetki: chats:read

Yol parametreleri

phonezorunlustringÜlke kodlu telefon numarası.

İstek örneği

curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/905551234567/check" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt 200

{
  "success": true,
  "phone": "905551234567",
  "is_whatsapp_user": true
}

Yanıt kodları

  • 200Kontrol sonucu
  • 400Hesap bağlı değil
post/contacts/sync

Toplu kişi senkronu

Numara listesini toplu olarak kontrol eder ve kişi kayıtlarını oluşturur/günceller. Tek çağrıda gönderilebilecek numara sayısı sınırlıdır; aşımda `too_many_phones` döner.

Gerekli yetki: chats:read

Gövde alanları

phoneszorunlustring[]
update_existingbooleanVarsayılan: true

İstek örneği

curl -X POST "https://api.zenwapp.com/api/v1/whatsapp/external/contacts/sync" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phones":["905551234567","905339876543"],"update_existing":true}'

Yanıt kodları

  • 200Senkron sonucu
  • 400Geçersiz istek veya numara limiti aşıldı